You can run the vCloud Director installer with options that enable it to upgrade all cells in a server group.

About this task

vCloud Director software is distributed as a digitally signed Linux 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.

The installer can automate the upgrade of a multi-cell server group. To use this feature, all cells in the server group must be configured to permit ssh connections from the superuser without a password. All cells must also share transfer server storage, as described in Summary of Network Configuration Requirements for vCloud Director.

Prerequisites

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

  • To have the installer 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.

  • All cells must be configured to permit ssh connections from the superuser without a password. You can use a Linux command line like the one shown here to verify this. 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.

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

    If the private key in private-key-path on the local cell is readable by user vcloud.vcloud and the corresponding public key has been added to 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.

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 one 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 one shown on the download page. A Linux command of the following form displays the checksum for installation-file.

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

    Compare the checksum-value produced by this command with the MD5 checksum copied 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 target cell's private key.

    When you run the installation file with the --private-key-path option, it accepts any of the other upgrade utility options listed in Upgrade the vCloud Director Database

    Note:

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

    If the installer detects a version of vCloud Director installed on this server that is equal to or later than the version in the installation file, it displays an error message and exits. Otherwise, it prompts you to confirm that you are ready to proceed to upgrade this server.

    ./installation-file --private-key-path /vcloud/.ssh/id_rsa
    Checking free disk space...done
    Checking for a supported Linux distribution...
    done
    Checking for necessary RPM prerequisites...done
    Extracting VMware vCloud Director. Please wait...
    done
    Verifying RPM signatures...done
    
    An older version of VMware vCloud Director has been detected and will be
    upgraded to n.nn.n.
    
    If you choose to proceed, the installer will stop the vmware-vcd service,
    back up any configuration files from the previous release and migrate the
    product configuration as necessary.
    
    Are you sure you want to continue with the upgrade? (y/n)?
  6. Respond to the upgrade prompt.

    Option

    Action

    Continue the upgrade.

    Type y.

    Exit to the shell without making any changes in the current installation.

    Type n.

    After you confirm that you are ready to upgrade the server, the installer initiates the multi-cell upgrade workflow.

    1. It verifies that the current cell host meets all requirements.

    2. It unpacks the vCloud Director RPM package.

    3. It upgrades vCloud Director software on the current cell.

    4. If you specified a --maintenance-cell, it puts that cell into maintenance mode.

    5. It quiesces activity on all other cells in the server group.

    6. It upgrades the vCloud Director database.

    7. It upgrades vCloud Director software on each of the remaining cells excluding the maintenance cell if you specified on, then re-starts vCloud Director services on the cell.

    8. If you specified a --maintenance-cell, it upgrades vCloud Director software on the maintenance cell and then re-starts vCloud Director services on the cell.

    9. It re-starts vCloud Director services on the current cell.