You can upgrade all cells in the server group and the shared database by running the vCloud Director installer with the --private-key-path option. If your vCloud Director cells run in vCloud Director appliances, to upgrade the vCloud Director installation, you must perform an orchestrated upgrade.

You can use the vCloud Director installer for Linux to upgrade a vCloud Director installation that consists of vCloud Director appliances or vCloud Director installations on a supported Linux OS.

vCloud Director for Linux is distributed as a digitally signed executable file with a name of the form vmware-vcloud-director-distribution-v.v.v-nnnnnn.bin, where v.v.v represents the product version and nnnnnn the build number. For example: vmware-vcloud-director-distribution-8.10.0-3698331.bin. Running this executable installs or upgrades vCloud Director.

When you run the vCloud Director installer with the --private-key-path option, you can add other command options of the upgrade utility, for example, --maintenance-cell. For information about the database upgrade utility options, see Database Upgrade Utility Reference.

Prerequisites

  • Verify that your vCloud Director database, the vSphere components, and the NSX components are compatible with the new version of vCloud Director.

    Important:

    If your existing vCloud Director installation uses an Oracle database, verify that you migrated to a PostgreSQL database from vCloud Director version 9.1. See the Workflow for Upgrading a vCloud Director Installation with an Oracle Database.

  • Verify that you have superuser credentials for the target server.

  • If you want the installer to verify the digital signature of the installation file, download and install the VMware public key on the target server. If you already verified the digital signature of the installation file, you do not need to verify it again during installation. See Download and Install the VMware Public Key.

  • Verify that you have a valid license key to use the version of the vCloud Director software to which you are upgrading.

  • Verify that all cells permit SSH connections from the superuser without a password. To perform a verification, you can run the following Linux command:

    sudo -u vcloud ssh -i private-key-path root@cell-ip

    This example sets your identity to vcloud, then makes an SSH connection to the cell at cell-ip as root but does not supply the root password. If the private key in private-key-path on the local cell is readable by user vcloud.vcloud and the corresponding public key is present in the authorized-keys file for the root user at cell-ip the command succeeds.

    Note:

    The vcloud user, vcloud group, and vcloud.vcloud account are created by the vCloud Director installer for use as an identity with which vCloud Director processes run. The vcloud user has no password.

  • Verify that you all ESXi hosts are enabled. Starting with vCloud Director 9.5, disabled ESXi hosts are unsupported.

  • Verify that all servers in the server group can access the shared transfer server storage. See Preparing the Transfer Server Storage.

  • If your vCloud Director installation uses an LDAPS server, to avoid LDAP login failures after the upgrade, verify that you have a properly constructed certificate for Java 8 Update 181. For information, see the Java 8 Release Changes at https://www.java.com.

  • Shut down the vCloud Director services on each cell in the server group. You can use the cell subcommand of the cell management tool

    [root@cell1 /opt/vmware/vcloud-director/bin]#./cell-management-tool -u administrator cell --shutdown

    For more information about managing a cell, see the cell management reference in the vCloud Director Administrator's Guide.

Procedure

  1. Log in to the target server as root.
  2. Download the installation file to the target server.

    If you purchased the software on media, copy the installation file to a location that is accessible to the target server.

  3. Verify that the checksum of the download matches the checksum posted on the download page.

    Values for MD5 and SHA1 checksums are posted on the download page. Use the appropriate tool to verify that the checksum of the downloaded installation file matches the checksum shown on the download page. A Linux command of the following form displays the checksum for installation-file.

    [root@cell1 /tmp]# md5sum installation-file

    The command returns the installation file checksum that must match the MD5 checksum from the download page.

  4. Ensure that the installation file is executable.

    The installation file requires execute permission. To be sure that it has this permission, open a console, shell, or terminal window and run the following Linux command, where installation-file is the full pathname to the vCloud Director installation file.

    [root@cell1 /tmp]# chmod u+x installation-file
  5. In a console, shell, or terminal window, run the installation file with the --private-key-path option and the pathname to the private key of the target cell.

    You can add other command options of the database upgrade utility.

    ./installation-file --private-key-path /vcloud/.ssh/id_rsa
    
    Note:

    You cannot run the installation file from a directory whose pathname includes any embedded space characters.

    The installer detects an earlier version of vCloud Director and prompts you to confirm the upgrade.

    If the installer detects a version of vCloud Director that is equal to or later than the version in the installation file, it displays an error message and exits.

  6. Enter y and press Enter to confirm the upgrade.

Results

The installer initiates the following multi-cell upgrade workflow.

  1. Verifies that the current cell host meets all requirements.

  2. Unpacks the vCloud Director RPM package.

  3. Upgrades vCloud Director software on the current cell.

  4. Upgrades the vCloud Director database.

  5. Upgrades vCloud Director software on each of the remaining cells, then restarts vCloud Director services on the cell.

  6. Restarts vCloud Director services on the current cell.

What to do next

Start the vCloud Director services on all cells in the server group.

You can now Upgrade Each NSX Manager That Is Associated with an Attached vCenter Server System, then Upgrade vCenter Server Systems, ESXi Hosts, and NSX Edges.