Deployment Procedure

  • 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.
  • If the harbor password has changed then you must redploy
    VMware Telco Cloud Service Assurance
    for the
    VMware Telco Cloud Service Assurance
    applications to run without failing. For more information, see Procedure to Redeploy If The Harbor Credentials are Changed.
  1. Log in to the deployment host.
  2. Download the
    tar.gz
    file of the deployment container from My Downloads onto the deployment host under the home directory. The package is named as
    VMware-Deployment-Container--.tar.gz
    . For example,
    VMware-DeploymentContainer-2.4.1-167.tar.gz
    .
    To verify the downloaded package, run the following command on your deployment host.
    $ sha256sum VMware-Deployment-Container-<VERSION>-<BUILD_ID>.tar.gz
    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.
    # On deployment host $ docker load -i <dir/on/deployment host>/VMware-Deployment-Container-2.4.1-167.tar.gz Verify the deployment container image # On deployment host $ docker man images
  3. Download the K8s Installer from VMware Customer Connect onto the deployment host under the home directory. Typically this package is named as
    VMware-K8s-Installer-<VERSION>-<BUILD_ID>.tar.gz
    . For example,
    VMware-K8s-Installer/VMware-K8s-Installer-2.1.0-509.tar.gz
    .
    To verify the downloaded package, run the following command on your deployment host.
    $ sha256sum VMware-K8s-Installer-<VERSION>-<BUILD_ID>.tar.gz
    This command displays the SHA256 fingerprint of the file. Compare this string with the SHA256 fingerprint provided next to the file in the VMware Customer Connect download site and ensure that they match.
    Always consistently extract the K8s Installer within the
    /root
    directory.
  4. Extract the K8s Installer as follows. This creates a folder called
    k8s-installer
    under the home directory.
    $tar -xzvf VMware-K8s-Installer-<VERSION>-<BUILD_ID>.tar.gz
    Always consistently extract the K8s Installer within the
    /root
    directory.
  5. Navigate to the k8s-installer directory and verify that there are 2 directories named
    scripts
    and
    cluster
    .
    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
    .
  6. Launch the Deployment Container as follows:
    docker run \ --rm \ -v $HOME:/root \ -v $HOME/.ssh:/root/.ssh \ -v $HOME/.kube:/root/.kube \ -v /var/run/docker.sock:/var/run/docker.sock \ -v $(which docker):/usr/local/bin/docker:ro \ -v $HOME/.docker:/root/.docker:ro \ -v /etc/docker:/etc/docker:rw \ -v /opt:/opt \ --network host \ -it projects.registry.broadcom.com/tcx/deployment:2.4.1-167 \ bash
  7. Update the deployment parameters by editing
    /root/k8s-installer/scripts/ansible/vars.yml
    file inside the Deployment Container.
    1. 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 the VMs ansible_become_password: <your-password> # SSH password for the VMs
      Update the parameter
      admin_public_keys_path
      with 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 the
      control_plane_ips
      and
      worker_node_ips
      as specified in the following format.
      For Demo footprint, refer the System Requirements for Demo Footprint section to get the number of Control Nodes 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> worker_node_ips: # The list of worker nodes IP addresses of your VMs.This should be a YAML list. - <IP3> - <IP4>
    2. 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>
    3. For Harbor Container Registry, uncomment and update the
      harbor_registry_ip
      parameter with the selected static IP address.
      ### 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>
    4. Set the following parameter to a location that has sufficient storage space for storing all application data.
      Ensure that in the below example, the
      /mnt
      file system must have 600 GB of storage space and must have 744 permission.
      For example:
      storage_dir: /mnt
    5. For local PV, set the storage parameters to
      false
      .
      ### Storage related parameters ### use_external_storage: false install_vsphere_csi: false
    6. For local PV, comment the following VMware vCenter parameters if it is enabled.
      ### vCenter parameters for using vSAN storage ### # vcenter_ip: <your-vCenter-IP> # vcenter_name: <your-vCenter-name> # vcenter_username: <your-vCenter-username> # vcenter_password: <your-vCenter-password> ## List of data centers that are part of your vSAN cluster # vcenter_data_centers: # - <your-datacenter> # vcenter_insecure: true # True, if using self signed certificates ## 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: <your-datastore-url>
    Here is the sample snippet of the
    vars.yaml
    file:
    cluster_name: vmbased-localpvtest ansible_user: root ansible_become_password: dangerous admin_public_keys_path: /root/.ssh/id_rsa.pub control_plane_ips:   - 10.214.174.195 worker_node_ips:   - 10.214.174.206   - 10.214.174.184   - 10.214.174.52   - 10.214.174.217   - 10.214.174.129   - 10.214.174.215 ## 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 ### 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.214.174.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: # install_vsphere_csi: ### vCenter parameters for using external storage (VMFS or vSAN datastores) ### # vcenter_ip: # vcenter_name: # vcenter_username: # vcenter_password: ## List of data centers that are part of your cluster # vcenter_data_centers: # vcenter_insecure: ## 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:
  8. 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])
    cd /root/k8s-installer/ export ANSIBLE_CONFIG=/root/k8s-installer/scripts/ansible/ansible.cfg ansible-playbook scripts/ansible/prepare.yml -e @scripts/ansible/vars.yml --become
    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.
  9. Execute the Kubernetes cluster installation command inside the Deployment Container.
    cd /root/k8s-installer/ ansible-playbook -i inventory/<your-cluster-name>/hosts.yml scripts/ansible/deploy_k8s.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 export
      KUBECONFIG=/root/.kube/<your-cluster-name>
      and proceed with the following steps to ensure if the deployment is successful.
  10. Ensure that the Kubernetes installation is successful and the following successful message is displayed on the console
    k8s Cluster Deployment successful
    .
    kubectl get nodes
    Ensure that all the nodes are in ready state before starting the VMware Telco Cloud Service Assurance deployment.
  11. Verify the Harbor pods are up and running.
    kubectl get pods | grep harbor
  12. Once the Kubernetes deployment is complete, the next step is to deploy VMware Telco Cloud Service Assurance, refer the section Start the VMware Telco Cloud Service Assurance deployment.
    • If the Kubernetes deployment fails, while waiting for the “
      nodelocaldns
      ” PODs to come up then Kubernetes installation script must 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 the
      VMware Telco Cloud Service Assurance
      Troubleshooting Guide
      to manually bring up the HTTP Server.