upgrade

The upgrade command upgrades an MKE cluster.

Prior to performing an upgrade, Mirantis recommends that you perform a backup of your MKE cluster using the backup command.

After upgrading MKE, log in to the MKE web UI and confirm that each node is healthy and that all nodes have been upgraded successfully.


To use the upgrade command:

docker container run --rm -it \
  --name ucp \
  -v /var/run/docker.sock:/var/run/docker.sock \
  mirantis/ucp:3.x.y \
  upgrade <command-options>

Options

Option

Description

--debug, -D

Enables debug mode.

--jsonlog

Produces JSON-formatted output for easier parsing.

--interactive, -i

Runs in interactive mode and prompts for configuration values.

--admin-password <value>

Sets the MKE administrator password.

--admin-username <value>

Sets the MKE administrator user name.

--force-minimums

Forces the install or upgrade to occur even if the system does not meet the minimum requirements.

--host-address <value>

Overrides the previously configured host address with the specified IP address or network interface.

--id <value>

Sets the ID of the MKE instance to upgrade.

--manual-worker-upgrade

Sets whether to manually upgrade worker nodes.

Default: false.

--pull <value>

Pulls MKE images.

Valid values: always, missing, and never.

--registry-password <value>

Sets the password to use when pulling images.

--registry-username <value>

Sets the user name to use when pulling images.

--force-recent-backup

Forces the upgrade to occur even if the system does not have a recent backup.

Default: false.

checks (subcommand)

The checks subcommand runs the pre-upgrade review on your cluster.


To use the checks subcommand:

docker container run --rm -it \
  --name ucp \
  -v /var/run/docker.sock:/var/run/docker.sock \
  mirantis/ucp \
  upgrade checks <command-options>

Options

Option

Description

--debug, -D

Enables debug mode.

--jsonlog

Produces JSON-formatted output for easier parsing.

--interactive, -i

Runs in interactive mode and prompts for configuration values.

--admin-password <value>

Sets the MKE administrator password.

--admin-username <value>

Sets the MKE administrator user name.

--id <value>

Sets the ID of the MKE instance to upgrade.

--pull <value>

Pulls MKE images.

Valid values: always, missing, and never.

--registry-password <value>

Sets the password to use when pulling images.

--registry-username <value>

Sets the user name to use when pulling images.