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.

Important:

This procedure assumes that you are upgrading vCloud Director to a release that is compatible with the following components of your existing installation.

  • The database software you are currently using for the vCloud Director database.

  • The VMware vSphere ® release you are currently using.

  • The VMware NSX ™ release that you are currently using.

Before you begin this procedure, refer to the VMware Product Interoperability Matrixes at http://partnerweb.vmware.com/comp_guide/sim/interop_matrix.php for information about compatibility of vCloud Director with other VMware products and with third-party databases. If you plan to upgrade vSphere or NSX components as part of the vCloud Director upgrade, you must upgrade them in the order and using the procedures documented here.

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, verify that no tasks are active on the server before you begin the upgrade.

The upgrade also preserves the following artifacts, which are not stored in the vCloud Director database:

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

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

Unless you use a load balancer to distribute client requests across members of your vCloud Director server group (see Using a Load Balancer to Reduce Service Downtime), the upgrade requires sufficient vCloud Director downtime to upgrade the database and at least one server.

Upgrading a vCloud Director Server Group

  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. 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.

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

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

  5. Enable user access to vCloud Director.

  6. (Optional) Upgrade each associated NSX Manager. See Upgrade Each NSX Manager That Is Associated with an Attached vCenter Server System.

  7. (Optional) Upgrade each associated vCenter Server system and its ESXi hosts. See Upgrade vCenter Server Systems, Hosts, and NSX Edges.

Note:

After completing the upgrade, if you have the vCloud Director Web Console open in a browser, log out and clear your browser cache before logging back in to the Web Console.

Using a Load Balancer to Reduce Service Downtime

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. Upgrade vCloud Director software on each cell in 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.

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

  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. (Optional) Upgrade each associated NSX Manager. See Upgrade Each NSX Manager That Is Associated with an Attached vCenter Server System.

  7. (Optional) Upgrade each associated vCenter Server system and its ESXi hosts. See Upgrade vCenter Server Systems, Hosts, and NSX Edges.

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

  9. 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.

Displaying the Maintenance Message During an Upgrade

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