Upgrade to UCP 2.2

This page guides you in upgrading Docker Universal Control Plane (UCP) to
version 2.2.

Before upgrading to a new version of UCP, check the
release notes for this version for information
about new features, breaking changes, and other relevant information about
upgrading to a particular version.

Plan the upgrade

As part of the upgrade process, you upgrade the Docker Engine instance installed
in each node of the swarm to version 17.06 Enterprise Edition. Plan for the
upgrade to take place outside of business hours, to ensure there’s minimal
impact to your users.

Also, don’t make changes to UCP configurations while you’re upgrading it.
This can lead to misconfigurations that are difficult to troubleshoot.

Back up your swarm

Before starting an upgrade, make sure that your swarm is healthy. If a problem
occurs, this makes it easier to find and troubleshoot it.

Create a backup of your swarm.
This allows you to recover if something goes wrong during the upgrade process.

Upgrading and backup archives

The backup archive is version-specific, so you can’t use it during the
upgrade process. For example, if you create a backup archive for a UCP 2.1
swarm, you can’t use the archive file after you upgrade to UCP 2.2.

Upgrade Docker Engine

For each node that is part of your swarm, upgrade the Docker Engine
installed on that node to Docker Engine version 17.06 or higher. Be sure
to install the Docker Enterprise Edition.

Starting with the manager nodes, and then worker nodes:

Log into the node using ssh.

Upgrade the Docker Engine to version 17.06 or higher.

Make sure the node is healthy.

In your browser, navigate to the Nodes page in the UCP web UI,
and check that the node is healthy and is part of the swarm.

Upgrade UCP

Use the UI to perform an upgrade

When an upgrade is available for a UCP installation, a banner appears.

Clicking this message takes an admin user directly to the upgrade process.
It can be found under the Cluster Configuration tab of the Admin
Settings section.

Select a version to upgrade to using the Available UCP Versions dropdown,
then click to upgrade.

Before the upgrade happens, a confirmation dialog along with important
information regarding swarm and UI availability is displayed.

During the upgrade, the UI is unavailable, so wait until the upgrade is complete
before trying to use the UI. When the upgrade completes, a notification alerts
you that a newer version of the UI is available, and you can see the new UI
after you refresh your browser.

Use the CLI to perform an upgrade

To upgrade from the CLI, log into a UCP manager node using ssh, and run: