After you upgrade a cell in your vCloud Director server group, you must upgrade the group's vCloud Director database before you restart vCloud Director services on the cell.

About this task

Information about all running and recently completed tasks is stored in the vCloud Director database. Because a database upgrade invalidates this task information, the database upgrade utility quiesces the cell to ensure that no tasks are running when upgrade process begins.

All cells in a vCloud Director server group share the same database, so regardless of how many cells you are upgrading, you need to upgrade the database only once. After the database is upgraded, vCloud Director cells cannot connect to it until they, too, are upgraded.

Table 1. Database Upgrade Utility Options and Arguments

Option

Argument

Description

--backup-completed

None

Specifies that you have completed a backup of the vCloud Director. When you include this option, the upgrade utility does not prompt you to back up the database.

--ceip-user

The username for the CEIP service account.

Upgrade will fail if a user with this username already exists in the System organization. Default: phone-home-system-account.

--enable-ceip

Choose one:

  • true

  • false

Specifies whether this installation participates in the VMware Customer Experience Improvement Program (CEIP). Defaults to true if not provided and not set to false in the current configuration. VMware's Customer Experience Improvement Program ("CEIP") provides Additional information regarding the data collected through CEIP and the purposes for which it is used by VMware is set forth in the Trust & Assurance Center at http://www.vmware.com/trustvmware/ceip.html. You may use the cell management tool to join or leave VMware's CEIP for this product at any time. See "Cell Management Tool Reference" in vCloud Director Administrator's Guide.

--installer-path

Full pathname to the vCloud Director installation file. The installation file and the directory in which it is stored must be readable by the user vcloud.vcloud.

This product participates in VMware’s Customer Experience Improvement Program (“CEIP”). Details regarding the data collected through CEIP and the purposes for which it is used by VMware are set forth in the Trust & Assurance Center at http://www.vmware.com/trustvmware/ceip.html. You can use the cell management tool to join or leave VMware's CEIP for this product at any time. See the "Cell Management Tool Reference" in the vCloud Director Administrator's Guide.

Requires --private-key-path option.

--maintenance-cell

IP address

The IP address of a cell for the upgrade utility to run in maintenance mode during the upgrade. This cell enters maintenance mode before the other cells are shut down and stays in maintenance mode while the other cells are upgraded. After the other cells are upgraded and at least one of them has re-started, this cell is shut down and upgraded. Requires --private-key-path option.

--multisite-user

The username for the Multi-Site system account.

This account is used by the vCloud Director Multi-Site feature. Upgrade will fail if a user with this username already exists in the System organization. Default: multisite-system-account.

--private-key-path

pathname

The full pathname to the cell's private key. When you use this option, all cells in the server group will be gracefully shut down, upgraded, and re-started after the database has been upgraded. See Upgrade vCloud Director Software on All Members of a Server Group for more information about this upgrade workflow.

--unattended-upgrade

None

Specifies unattended upgrade

If you use the --private-key-path option, 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.

Prerequisites

Important:

The update utility prompts you to back up your existing database before you upgrade it. Use the procedures that your database software vendor recommends.

Procedure

  1. Open a console, shell, or terminal window, and type the following command to run the database upgrade utility.
    /opt/vmware/vcloud-director/bin/upgrade
    Important:

    If the database upgrade utility detects that an incompatible version of vShield Manager or NSX Manager is registered to this installation of vCloud Director, it displays a warning message and cancels the upgrade.

    One or more vShield Manager servers registered to this vCloud 
    Director installation are not supported by the version of vCloud Director
    you are upgrading to. Upgrade canceled, please follow the procedures in
    the vShield Manager Upgrade Guide to upgrade those unsupported vShield 
    Manager servers.
  2. Respond to the database upgrade prompts.
    1. Confirm that you want to continue with the database upgrade.
      Welcome to the vCloud Director upgrade utility
      
      Verify that you have a valid license key to use the version of 
      the vCloud Director software to which you are upgrading.
      
      This utility will apply several updates to the database. Please
      ensure you have created a backup of your database prior to continuing.
      
      Do you wish to upgrade the product now? [Y/N]:

      Take one of the following actions:

      Option

      Action

      Continue the upgrade.

      Type y.

      Exit to the shell without making any changes in the current vCloud Director database.

      Type n.

    2. Confirm that you have backed up the vCloud Director database.

      Unless you ran upgrade with the --backup-completed option, it prompts you to confirm that you have backed up the database.

      The next step in the upgrade process will change the vCloud Director database schema.
      Backup your database now using the tools provided by your database vendor.
      Enter [Y] after the backup is complete.

      Take one of the following actions:

      Option

      Action

      Back up the vCloud Director database now.

      Backup the database, then type y.

      Continue the upgrade process without backing up the vCloud Director database.

      Type n.

    3. (Optional) : Wait for cells to become inactive, if necessary.

      If the database upgrade tool detects that any cells are still active, it prompts you to continue with the upgrade or exit.

      Found active cell. Name: "cell-01", IP Address: 10.150.151.190, Identifier: a2eb...
      Do you wish to upgrade the database while cells are still active? [Y/N]

      If you see this prompt, type n to exit to the shell, then wait five minutes and begin this process again at 1.

    After you have responded to all prompts, the database upgrade tool runs and displays progress messages.

    Executing upgrade task: Start UpdateStatementManager
    ...[3]
    Successfully ran upgrade task
    Executing upgrade task: ...
    .......... Successfully ran upgrade task
    ...
    Executing upgrade task: Stop UpdateStatementManager
    ...[3]
    ...
    Successfully ran upgrade task

Results

After the database is upgraded, the upgrade utility offers to start vCloud Director services on this host.

Would you like to start the vCloud Director service now? If you choose not
to start it now, you can manually start it at any time using this command:
    service vmware-vcd start
Start it now? [y/n]:y
Starting the vCloud Director service (this may take a moment).
Starting vmware-vcd-watchdog:                              [  OK  ]
Starting vmware-vcd-cell                                   [  OK  ]