One Step Deployment Procedure for Kubernetes Cluster Deployment
This topic provides instructions about one step deployment procedure for Kubernetes Cluster Deployment with VMware vSAN or Block Storage enabled.
- If the deployment host does not have Internet connectivity to download the required files from My Downloads, follow the steps described in the DarkSite Deployment section to get the files onto the deployment host. Then proceed with the remaining steps in this section (from Steps 5 to Step 14).
- If the harbor password has changed then you must redeployVMware Telco Cloud Service Assurancefor theVMware Telco Cloud Service Assuranceapplications to run without failing. For more information, see Chapter 14 Procedure to Redeploy If The Harbor Credentials are Changed..
- Log in to the deployment host.
- Ensure that podman-docker are installed on the Deployer Host.Ignore the following message and warnings while executing the docker command.Emulate Docker CLI using podman. Create /etc/containers/nodocker to quiet msg.
- Download thetar.gzfile of the deployment container from My Downloads onto the deployment host under the home directory. The package is named asVMware-Deployment-Container-<VERSION>-<TAG>.tar.gz. For example,VMware-Deployment-Container-2.4.2-497.tar.gz.To verify the downloaded package, run the following command on your deployment host.
This command displays the SHA256 fingerprint of the file. Compare this string with the SHA256 fingerprint provided next to the file in the My Downloads site and ensure that they match.$ sha256sum VMware-Deployment-Container-<VERSION>-<BUILD_ID>.tar.gz - Steps to loadtar.gzto container.# On deployment host $ docker load -i <dir/on/deployment host>/VMware-Deployment-Container-2.4.2-497.tar.gz Verify the deployment container image # On deployment host $ docker images
- Download the K8s Installer from My Downloads onto the deployment host under the home directory. Typically this package is named asVMware-K8s-Installer-<VERSION>-<BUILD_ID>.tar.gz. For example,VMware-K8s-Installer-2.3.3-5.tar.gz.To verify the downloaded package, run the following command on your deployment host.
This command displays the SHA256 fingerprint of the file. Compare this string with the SHA256 fingerprint provided next to the file in the My Downloads site and ensure that they match.$ sha256sum VMware-K8s-Installer-<VERSION>-<BUILD_ID>.tar.gz - Extract the K8s Installer as follows. This creates a folder calledk8s-installerunder the home directory.$tar -xzvf VMware-K8s-Installer-<VERSION>-<BUILD_ID>.tar.gzAlways consistently extract the K8s Installer within the/rootdirectory.
- Navigate to the k8s-installer directory and verify that there are 2 directories namedscriptsandcluster.By default, the Kubernetes install logs are stored under$HOME/k8s-installer/ansible.log. If you want to change the log location, then update the log_path variable in the file$HOME/k8s-installer/scripts/ansible/ansible.cfg.
- ExportDOCKER_HOMEand launch the deployment container as follows:export DOCKER_HOME=$(docker run --rm localhost/deployment:2.4.2-497 sh -c 'echo $HOME')docker run \ --rm \ -v $HOME:$DOCKER_HOME \ -v $HOME/.ssh:$DOCKER_HOME/.ssh \ -v /var/run/podman/podman.sock:/var/run/podman.sock \ -v $(which podman):/usr/local/bin/podman:ro \ -v /etc/docker:/etc/docker:rw \ -v /opt:/opt \ --network host \ -it localhost/deployment:2.4.2-497 \ bash
- Update the deployment parameters by editing the/root/k8s-installer/scripts/ansible/vars.ymlfile inside the Deployment Container.
- Configure the general parameters.Set the values according to your environment.cluster_name: <your-cluster-name> # Unique name for your cluster ansible_user: <your-SSH-username> # SSH username for ClusterNode VMs ansible_become_password: <your-password> # SSH password for ClusterNode VMsUpdate theadmin_public_keys_pathwith the path of public key generated during SSH key generation.admin_public_keys_path: /root/.ssh/id_rsa.pub # Path to the SSH public key. This will be a .pub file under $HOME/.ssh/Update thecontrol_plane_ipsandworker_node_ipsas specified in the following format.For Production footprint, refer the VMware Telco Cloud Service Assurance Sizing Sheet to get the number of ControlNode and Worker Node VMs.control_plane_ips: # The list of control plane IP addresses of your VMs.This should be a YAML list. - <IP1> - <IP2> - <IP3> worker_node_ips: # The list of worker nodes IP addresses of your VMs.This should be a YAML list. - <IP4> - <IPn>
- Update the Deployment Host IP and the YUM server details.## Deployment host IP address ## Make sure firewall is disabled in deployment host # The IP address of your deployment host deployment_host_ip: <your-deployment-host-ip> ## default value is http. Use https for secure communication. yum_protocol: http # The IP address/hostname of your yum/package repositoy yum_server: <your-yum-server-ip>
- Keepalived vipis used for internal container registry HA. You must set it to an available virtual IP if a defaultKeepalived vipis not available.keepalived_vip: "192.168.1.101"If the default IP given in thevars.yamlfile is not available, you must use the available IP in 192.168.*.* subnet range.
- For Harbor Container Registry, uncomment and update theharbor_registry_ipparameter with the selected static IP address. The free Static IP must be in the same subnet as that of the managment IP's of the Cluster Nodes.### Harbor parameters ### ## The static IP address to be used for Harbor Container Registry ## This IP address must be in the same subnet as the VM IPs. harbor_registry_ip: <static-IPAddress>
- Set the following parameter to a location that has sufficient storage space for storing all application data. Ensure that in the below example/mntfile system must be having 200 GB of storage space, and must have 744 permission.storage_dir: /mnt
- For storage related parameters, uncomment and set the following parameters totrue.### Storage related parameters ### use_external_storage: true install_vsphere_csi: true
- If using VMware vSAN or Block Storage, uncomment and update the following VMware vCenter parameters.
- If you do not want to provide the VMware vCenter password in the plain text format, you can comment the#vcenter_password: <your-vCenter-password>. During the Kubernetes cluster creation, vCenter password will be prompted.
### vCenter parameters for using vSAN storage or Block Storage ### vcenter_ip: <your-vCenter-IP> vcenter_name: <your-vCenter-name> vcenter_username: <your-vCenter-username> # for a complex password i.e. passwords that allow special characters like '{' or '%', please define the password as "vcenter_password: !unsafe '<password>'" to avoid any templating error during execution # for further details, please refer: https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_advanced_syntax.html # vcenter_password:# ## List of data centers that are part of your vSAN cluster vcenter_data_centers: - <DataCenter> vcenter_insecure: true # True, if using self signed certificates ## The datastore URL. To locate, go to your vCenter -> datastores -> your vSAN datastore or Block Storage -> Summary -> URL datastore_url: <your-datastore-url>Ensure that the storage size of the VMware vSAN datastore or Block Storage is as per the VMware Telco Cloud Service Assurance Sizing Sheet guidelines for Production deployment.
Here is the sample snippet of thevars.yamlfile:cluster_name: vmbased-oracle-prod-vsan ansible_user: root ansible_become_password: dangerous admin_public_keys_path: /root/.ssh/id_rsa.pub control_plane_ips: - 10.220.143.240 - 10.220.143.248 - 10.220.143.221 worker_node_ips: - 10.220.143.163 - 10.220.143.245 - 10.220.143.182 - 10.220.143.113 - 10.220.143.37 - 10.220.143.203 - 10.220.143.108 - 10.220.143.132 - 10.220.143.56 ## Deployment host IP address ## Make sure firewall is disabled in deployment host deployment_host_ip: 10.1.1.1 ## default value is http. Use https for secure communication. yum_protocol: http ## IP address/hostname of yum/package repo yum_server: 10.198.x.x keepalived_vip: "192.168.1.101" ### Harbor parameters ### ## (Optional) The IP address to be used for the Harbor container registry, if static IPs are available. ## This IP address must be in the same subnet as the VM IPs. harbor_registry_ip: 10.220.143.x ## When using local storage (Direct Attached Storage), set this to a location that has sufficient storage space for storing all application data storage_dir: /mnt ### Storage related parameters ### use_external_storage: "true" install_vsphere_csi: "true" ### vCenter parameters for using external storage (VMFS or vSAN datastores or Block Storage) ### vcenter_ip: 10.x.x.x vcenter_name: vcenter01.vmware.com vcenter_username: [email protected] vcenter_password: xxxxxxxxx ## List of data centers that are part of your cluster vcenter_data_centers: - DataCenter vcenter_insecure: "true" ## The datastore URL. To locate, go to your vCenter -> datastores -> your datastore -> Summary -> URL ## Note: All VMs must be on the same datastore! datastore_url: ds:///vmfs/volumes/vsan:527e4e6193eacd65-602e106ffe383d68/- vcenter_ip: IP address or the FQDN of the vCenter.
- vcenter_name: Name of the vCenter as shown in the vSphere Console (after logging in to the vCenter using vSphere Console).
- Execute the prepare command inside the Deployment Container.If you have used Non-Empty Passphrase for SSH Key generation (required for passwordless SSH communication), then you must execute the following commands inside the Deployment Container, before running the Ansible script.[root@wdc-10-214-147-149 ~]# eval "$(ssh-agent -s)" Agent pid 3112829 [root@wdc-10-214-147-149 ~]# ssh-add ~/.ssh/id_rsa Enter passphrase for /root/.ssh/id_rsa: <==Enter the NON-EMPTY Passphrase that is being provided during the NON-EMPTY ssh-key Generation process Identity added: /root/.ssh/id_rsa ([email protected])root [ ~ ]# cd /root/k8s-installer/ root [ ~/k8s-installer ]# export ANSIBLE_CONFIG=/root/k8s-installer/scripts/ansible/ansible.cfg LANG=en_US.UTF-8 root [ ~/k8s-installer ]# ansible-playbook scripts/ansible/prepare.yml -e @scripts/ansible/vars.yml --becomeThere will be some fatal messages which will be displayed on the console and ignored by the Ansible script during execution. These messages does not have any functional impact and can be safely ignored.
- Execute the Kubernetes Cluster installation command inside the Deployment Container.
- If the VMware vCenter password is commented in thevars.yamlfile, then you will be prompted to provide the vCenter password when the following Ansible Script is executed.root [ ~ ]# cd /root/k8s-installer/ root [ ~/k8s-installer ]# ansible-playbook -i inventory/<your-cluster-name>/hosts.yml scripts/ansible/deploy_caas.yml -u <your-SSH-username> --become -e @scripts/ansible/internal_vars.yml -e @scripts/ansible/vars.yml
- There will be some fatal messages which will be displayed on the console and ignored by the Ansible script during execution. These messages does not have any functional impact and can be safely ignored.
- After the Kubernetes cluster installation completes, kubeconfig file is generated under/root/.kube/<your-cluster-name>. Export the kubeconfig file using exportKUBECONFIG=/root/.kube/<your-cluster-name>and proceed with the following steps to ensure if the deployment is successful.
- Ensure that the Kubernetes installation is successful and the following successful message is displayed on the consoleCaaS deployment is successful.kubectl get nodesEnsure that all the nodes are in ready state before starting the VMware Telco Cloud Service Assurance deployment.
- Verify the Harbor pods are up and running.kubectl get pods -A | grep harbor
- If the Kubernetes deployment fails, while waiting for thenodelocaldnsPODs to come up then Kubernetes installation script should be re-run. The Kubernetes deployment will resume from that point.
- If the Kubernetes Deployment fails because the Python HTTP Server is getting killed every time, then refer to Python HTTP server running on the Deployment Host is stopped in theto manually bring up the HTTP Server.VMware Telco Cloud Service AssuranceTroubleshooting Guide
- If you have changed your VMware vCenter credentials then you have to run the following scripts to update it in the deployment container of the deployer host
- Execute the prepare command inside the deployment containeransible-playbook scripts/ansible/prepare.yml -e @scripts/ansible/vars.yml --become
- Execute post install command to update the credentials inside the deployment containeransible-playbook -i inventory/vmbasedlongevity4/hosts.yml scripts/ansible/post_install.yml -u root --become -e @scripts/ansible/internal_vars.yml -e @scripts/ansible/vars.yml --tags vsphere-csi
- After the Kubernetes deployment is complete, the next step is to create a new user in Harbor. For more information, see the Create a New User in Harbor section.
- After creating a new user in Harbor, the next step is to deployVMware Telco Cloud Service Assurance. For more information, see the Deployment for Production Footprint with vSAN or Block Storage section.