To upgrade vCloud Director to a new version, install the new version on each server in the vCloud Director server group, upgrade the vCloud Director database, and restart vCloud Director services. You must also upgrade the vSphere components that support vCloud Director, including each vShield Manager or NSX Manager that is associated with each vCenter Server system included in the vCloud Director server group.

After you upgrade a vCloud Director server, you must also upgrade its vCloud Director database. The database stores information about the runtime state of the server, including the state of all vCloud Director tasks it is running. To ensure that no invalid task information remains in the database after an upgrade, you must ensure that no tasks are active on the server before you begin the upgrade.

Important

The upgrade process requires you to upgrade vCloud Director, each associated vCenter Server system and its associated vShield Manager or NSX Manager, and all hosts. You must prevent users from accessing vCloud Director until the upgrade of the associated vShield Manager or NSX Manager is complete.

The upgrade preserves the following artifacts:

Local and global properties files are copied to the new installation.

Microsoft sysprep files used for guest customization are copied to the new installation.

If you use a load balancer to distribute client requests across members of your vCloud Director server group, you can upgrade a subset of the server group while keeping existing services available on the others. If you do not have a load balancer, the upgrade requires sufficient vCloud Director downtime to upgrade the database and at least one server. You might also have to upgrade registered vCenter Server systems if they are not running a compatible version of vCenter software. Upgrading vCenter Server systems and ESXi hosts can incur additional vCloud Director downtime, because virtual machines are inaccessible while their hosts or vCenter Server systems are being upgraded.

Beginning with this release, SSL certificates used by vCloud Director must include both an X.500 distinguished name and an X.509 Subject Alternative Name extension. Previous releases did not verify the Subject Alternative Name during the SSL handshake. Unless your existing certificates include the X.509 Subject Alternative Name extension, the SSL handshake will fail in this release, and clients will not be able to connect with vCloud Director.

SSL certificates that include an X.509 Subject Alternative Name extension are compatible with all previous releases of vCloud Director. It is a good practice to create and install the new certificates on your existing vCloud Director release before proceeding with he upgrade. Doing so allows you verify that SSL connection can be completed using the new certificates before you begin the upgrade process.

Create SSL Certificates provides detailed information about creating and importing signed and self-signed certificates. Generating Self-Signed SSL Certificates and Replacing SSL Certificates explain how to use the cell-management-tool to create new certificates and replace existing ones.

1

Disable user access to vCloud Director. You can also display a maintenance message while the upgrade is underway. See Displaying the Maintenance Message During an Upgrade.

2

Use the cell management tool to quiesce all cells in the server group and shut down vCloud Director services on each server. See Use the Cell Management Tool to Quiesce and Shut Down a Server.

3

Upgrade vCloud Director software on all members of the server group. See Upgrade vCloud Director Software on Any Member of a Server Group. You can upgrade the servers individually or in parallel, but you must not restart vCloud Director services on any upgraded member of the group before you upgrade the vCloud Director database.

4

Upgrade the vCloud Director database. See Upgrade the vCloud Director Database.

5

Restart vCloud Director on the upgraded servers. See Start or Stop vCloud Director Services.

6

Upgrade each associated vShield Manager or NSX Manager. All vShield Manager or NSX Manager installations registered to this server group must be upgraded to a version of vShield Manager or NSX Manager software that is compatible with the version of vCloud Director installed by the upgrade. If the upgrade program detects an incompatible version of vShield Manager or NSX Manager, upgrading is not allowed. You must upgrade to the latest version of vShield Manager or NSX Manager as described in Supported Platforms to use networking features introduced in this release of vCloud Director. See Upgrade the Existing vShield Manager or NSX Manager That Is Associated with an Attached vCenter Server System.

7

Enable user access to vCloud Director.

8

Upgrade each associated vCenter Server system and hosts. See Upgrade vCenter Server Systems, Hosts, and vShield Edge Appliances. All vCenter Server systems registered to this server group must be upgraded to a version of vCenter Server software that is compatible with the version of vCloud Director installed by the upgrade. Incompatible vCenter Server systems become inaccessible from vCloud Director after the upgrade is complete. See Supported Platforms.

If you are using a load balancer or other tool that can force requests to go to specific servers, you can upgrade a subset of the server group while keeping existing services available on the remaining subset. This approach reduces vCloud Director service downtime to the length of time required to upgrade the vCloud Director database. Users might experience some degradation of performance during the upgrade, but in-progress tasks continue to run as long as any subset of the server group is operational. Console sessions might be interrupted, but you can restart them.

1

Use the load balancer to redirect vCloud Director requests to a subset of the servers in the group. Follow the procedures recommended by your load balancer.

2

Use the cell management tool to quiesce the cells that are no longer handling requests and shut down vCloud Director services on those servers.

Note

Console sessions routed through a server's console proxy are interrupted when the server shuts down. Clients can refresh the console window to recover.

See Use the Cell Management Tool to Quiesce and Shut Down a Server.

3

Upgrade vCloud Director software on the members of the server group on which you have stopped vCloud Director, but do not restart those services. See Upgrade vCloud Director Software on Any Member of a Server Group.

4

Use the cell management tool to quiesce the cells that you have not yet upgraded and shut down vCloud Director services on those servers.

5

Upgrade the vCloud Director database. See Upgrade the vCloud Director Database.

6

Restart vCloud Director on the upgraded servers. See Start or Stop vCloud Director Services.

7

Upgrade each associated vShield Manager or NSX Manager. See Upgrade the Existing vShield Manager or NSX Manager That Is Associated with an Attached vCenter Server System.

8

Upgrade each associated vCenter Server system and hosts. See Upgrade vCenter Server Systems, Hosts, and vShield Edge Appliances.

9

Use the load balancer to redirect vCloud Director requests to the upgraded servers.

10

Upgrade vCloud Director software on the remaining servers in the group, and restart vCloud Director on those servers as the upgrades complete. See Upgrade vCloud Director Software on Any Member of a Server Group.

If you anticipate a lengthy upgrade process and want to have the system display a maintenance message while the upgrade is underway, verify that at least one cell remains accessible while the others are being upgraded. Run the /opt/vmware/vcloud-director/bin/vmware-vcd-cell command on that cell to turn on the cell maintenance message.

[root@cell1 /opt/vmware/vcloud-director/bin]# ./vmware-vcd-cell maintenance

When you are ready to return an upgraded cell to service, run the following command on the cell to turn off the maintenance message.

[root@cell1 /opt/vmware/vcloud-director/bin]# service vmware-vcd restart