VMware vSphere Upgrade


See Upgrade Approach for details on permissions and prerequisites.

Trial User Installation Procedure and Settings

In some cases, you may merely want to try out the installation to check if it works. In these cases, try the installation with the following settings, regardless of your environment:

  1. Upload the tenant image manually to the root folder and prefix the file with CCS (all upper case) before you begin the installation.

  2. Do not convert the tenant image to be a template.

  3. If you are new to Cloud Center Suite, installing CloudCenter Suite for the first time in a VMware environment or if you not sure of your vSphere capacity, then select the following settings in the Placement properties page as follows to ensure a successful installation:

    Placement Properties FieldSettings and Description
    VM TemplateSelect the image uploaded in as mentioned in Step 1 above.
    Resource PoolCreate a new resource pool in your VMware environment and select this new resource pool.
    CIDR Network

    Placement properties has 2 types of networks: vSphere Network and Kubernetes POD CIDR.

    The values for both these networks must be different.

    If you select the same network for both settings, the installation will not succeed as the IP that is being assigned will be the same for both networks and thus cause a conflict.

    Master VIPMake sure it is available and not allocated to any other environment before entering the information in this field.
    Static IPMake sure all values are correct and the range is wide enough and available. The number of primary servers, workers, and load balancers must be included in this count.
    Number of worker nodes

    Reduce the Worker count to 2 (even if this field defaults to 5) for an environment that uses 8 CPU 32 GB memory. At a later point ( after your installation/registration is complete), you can increase this count by using the scale up procedure.

    DatastoreThe updated tenant image and the destination CCS_ image folder MUST have the same Datastore value – to verify this, note the datastore value when you upload the image and then use the same value to enter in this field.

The following Advanced sections are intended for users who would like to perform the installation using their environment-specific VMware settings.

Advanced Prerequisites

If you are using a proxy requirement, be sure to verify that the proxy does not have a username or password restriction.

If you have credentials in place, you will see a field validation error below each Proxy field.

If your proxy connection requires a username and password, request your infrastructure team to allow the following URLs to ensure that these URLs are allowed to be connect without explicitly entering credentials:

Advanced VMware Nuances

Verify the following VMware nuances:

  • Ensure to use Version 6.0 and higher.

  • Verify that you have sufficient shared storage between hosts.

  • You must have privileges to launch a VM and access the selected DC/Datastore.

  • The datastore clusters are not supported

  • The vSphere datastore must reside outside the datastore cluster.

  • If vSphere is slow:

    • Upload the VM template manually – in the same datastore where you are going to install CloudCenter Suite.

    • Initially select fewer number of workers than suggested – for example, if 5 workers are recommended, just enter 2 instead of 5. This helps prevent a timeout issue when the workers are being created.

    • After the installation completes, login to CloudCenter Suite as the root tenant (admin) user, click on the Cloud Management icon, and scale up the worker node.

    • Static IP Consideration – Verify that you have sufficient IPs available in the Static IP range provided during installation for scale up.

  • If vSphere has more than one datacenter, be sure to:

    • Create and select one resource pool, do not leave this resource pool selection blank.

    • Upload the tenant image manually to vSphere, under root folder as provided in the following procedure.

      • Download the tenant image tar.gz file from software.cisco.com.

      • Extract the tenant image. The extracted folder contains the tenant image, rename it by including a CCS prefix. For example: ccp-tenant-image-1.13.5-ubuntu18-4.1.1.ova, rename it to CCS-tenant-image-1.13.5-ubuntu18-4.1.1.ova

      • Next, upload this renamed image to your root folder, make sure to select the same data store where you will be installing CloudCenter Suite.

      • The image will be displayed in the VM Template dropdown of the Placement Properties page.

      • Be sure to verify that the image is not converted to the template after uploading to vSphere.

  • If vSphere has only one datacenter, then it is not mandatory to select a resource pool.

  • Your datacenter must exist at the root level.

    Be aware that CloudCenter Suite does not support folders at the root level.

  • Network Time Protocol (NTP) must be configured – this is important as the CloudCenter Suite installation can fail, if NTP is not configured or if it is wrongly configured.

    If you setup CloudCenter Suite in offline mode, you must provide valid NTP server details before you save your configuration.

  • For CloudCenter Suite to use a particular user account in VMware, that account must have the permissions identified in the following table.

    vCenter ObjectRequired PermissionReason
    NetworkAssign NetworkIf the default network in a template/snapshot must be changed

    Allocate space

    For persistent disk operation

    Browse datastore
    Low level file operations
    Remove file
    FolderCreate folder

    For user folder creation

    Create this folder under the root folder and be sure to select this path at installation time.


    Apply recommendation

    For datastore cluster support
    Assign VM to resource poolFor resource pool selection

    Create task

    For VM operation

    Update task
    Virtual MachineAll permissions

    Add the following roles and permissions so the tenant image can be uploaded to vSphere under Datacenter during the installation for the given user:

    • Create a role by providing below privileges to this role.

    • Datastore.Allocate space

    • Datastore.Browse datastore

    • Datastore.Low level file operations

    • Datastore.Remove file

    • Folder. Create folder

    • Global.Manage Custom Attributes

    • Global.Set custom attribute

    • Network.Assign network

    • Resource.Apply recommendation

    • Resource.Apply vApp to resource pool

    • Resource.Apply virtual machine to resource pool

    • Storage views. View

    • Tasks.Create task

    • Tasks.Update task

    • Virtual machine (Check all the permissions under this Privilege).

    • vApp.Import

    • vApp.Power off

    • vApp.Power on

    • vApp.Suspend

    • vApp.vApp application configuration

    • vApp.vApp instance configuration

    • vApp.vApp managedBy configuration

    • vApp.vApp resource configuration

    Global RoleSet Custom AttributesTo add custom attributes on virtual machines
    Manage Custom Attributes

Module Details

Additionally, refer to your module documentation for module-specific dependencies identified in the following table.

Workload ManagerCloud Overview
Action OrchestratorAdd Cloud Account
Cost OptimizerCloud Overview

Installation Process

To install the CloudCenter Suite on a new vSphere cluster, perform the following procedure. 

  1. Verify that you have prepared your environment as listed in the VMware Nuances section above.

  2. Navigate to the Suite Installer Dashboard.

  3. Click Upgrade in the New Kubernetes Cluster tile to create a new Kubernetes cluster and install the Suite Admin on it.

  4. Click the VMware vSphere tile.

  5. Enter your Suite Admin credentials and click Connect.

    vSphere DetailsDescription

    Suite Admin Endpoint for the Cluster to be Upgraded

    The DNS address or IP address of the vCenter server where you launch the Suite Admin.
    Email Address (Username) of the Suite AdminThe email address of Suite Admin (the Initial Administrator) who setup the Suite Admin.
    Password for the Suite AdminThe password for the Suite Admin (the Initial Administrator) who setup the Suite Admin.
    Tenant ID for the Suite Admin
    The Tenant ID for the Suite Admin (the Initial Administrator) who setup the Suite Admin.
    Is This an Amazon EKS ClusterToggle the switch (default is No). If it is, provide the Access Key and Secret Key details.

    The CloudCenter Suite validates the vSphere credentials to ensure that the cluster is available to this user.

  6. Once the connection is validated, click Next.

    Once Connected, you see the cloud type and other information on the left side off the screen

  7. Enter the information in the Upgrade settings fields.

    Upgrade Settings FieldDescription
    Current Kubernetes VersionThe current version for your Kubernetes setup is pre-populated in this field.
    New Kubernetes Version

    If an upgrade is available, it is listed in this dropdown list. Select the Desired K8s version for the upgrade.

    VM Template

    Different images will be used for the installer and the cluster launched by the installer as visible in the following screenshot.

    The installer includes a default Kubernetes cluster image (called, CCS-version-Base-Image). The VM Template contains a list of tenant images with a CCS-version-Base-Image name format. If you want to upgrade to a version other than the default version provided by the installer, then upload that CCS-version-Base-Image under the root folder, so that it will display in this dropdown list.

    The CCS-version-Base-Image  image included in the installer is selected if you do not override the setting.

    To override the CCS-version-Base-Image image used by the Suite installer, be sure to add the applicable image in the vSphere console and selected the applicable OVA from the dropdown list in this field.

    If you use the OVA installer to launch the cluster in an OpenStack environment, be sure to override this field and select the applicable QCOW2 CS-version-Base-Image.

    If you install the CloudCenter Suite using any image other than CCS-version-Base-Image, the installation will fail.

    IP Allocation Mode

    This switch allows you to select the mode. Currently, only DHCP is supported.

    • DHCP: This strategy allows the IP to be allocated by the DHCP server to the instance on server boot up.

      • Master VIP: The IP address for the Take Me to Suite Admin link – Users can determine the IP address that should have the primary role for the Take Me to Suite Admin link.

        This should be a unique IP and should not be assigned to any other resource. 

    • Static IP: This strategy allows the customer to provide the IP address. As this IP address may or may not be available to the server (based on the availability), you must perform adequate checks to ensure IP availability before using this strategy.

      • Static IP Pool Start IP: The first IP address of the static IP range. If you need to scale up nodes after setting up the Suite Admin, then you must ensure a wider range.
      • Static IP Pool End IPThe last IP address for the static IP range.
      • Subnet Mask: The netmask corresponding the the specified IP range.
      • DNS Server List: The comma separated list of DNS server IP addresses.
      • Gateway List: The comma separated list of Gateway server IP addresses.
  8. Click Upgrade to upgrade the Kubernetes cluster as well as the primary and worker nodes once the upgrade is complete. A progress bar with relevant status messages is displayed as visible in the following screenshot.

  9. At this point, you can:

    1. Download the latest logs to track the upgrade process.

    2. Wait for cluster to finish upgrading.

  10. Once successful, you see the success message as visible in the following screenshot.

  11. You have the following options at this point:

    1. Click Take Me To Suite Admin to launch and set up the Suite Admin.

    2. Click Install or Upgrade Another Cluster to start another installation and go back to the homepage (Installer Dashboard).

    3. Download KubeConfig file to connect to the launched cluster using the kubectl tool.

    4. After the installation is complete, use the following command to SSH into the workers/primary servers as cloud-user and use the private SSH key or the public key (provided when you configured the Placement Properties details above).

      #Sample command to SSH into a worker/primary server
      • ssh -I <private key> cloud-user@<primary server/worker IP>
  12. Be sure to switch off the installer VM. You can reuse this VM for any other purpose, for example, as an Offline Repository.

You have now upgraded the cluster on the VMware cloud. Verify your Suite Admin and tenant data.

  • No labels
Terms & Conditions Privacy Statement Cookies Trademarks