Verify your environment¶
Before you perform the environment verifications necessary to ensure a smooth
upgrade, Mirantis recommends that you run
docker container run --rm -it \ --name ucp \ -v /var/run/docker.sock:/var/run/docker.sock \ mirantis/ucp \ upgrade checks [command options]
This process confirms:
Sufficient memory and disk space
Supported OS version is in use
Existing backup availability
To perform system verifications:
Verify time synchronization across all nodes and assess time daemon logs for any large time drifting.
PROD=4vCPU/16GBsystem requirements are met for MKE managers and MSR replicas.
Verify that your port configurations meet all MKE, MSR, and MCR port requirements.
Verify that your cluster nodes meet the minimum requirements.
Verify that you meet all minimum hardware and software requirements.
Azure installations have additional prerequisites. Refer to Install MKE on Azure for more information.
To perform storage verifications:
Verify that no more than 70% of
/var/storage is used. If more than 70% is used, allocate enough storage to meet this requirement. Refer to MKE hardware requirements for the minimum and recommended storage requirements.
Verify whether any node local file systems have disk storage issues, including MSR back-end storage, for example, NFS.
Verify that you are using Overlay2 storage drivers, as they are more stable. If you are not, you should transition to Overlay2 at this time. Transitioning from device mapper to Overlay2 is a destructive rebuild.
To perform operating system verifications:
Patch all relevant packages to the most recent cluster node operating system version, including the kernel.
Perform rolling restart of each node to confirm in-memory settings are the same as startup scripts.
After performing rolling restarts, run
check-config.shon each cluster node checking for kernel compatibility issues.
To perform procedural verifications:
Perform Swarm, MKE, and MSR backups.
Gather Compose, service, and stack files.
Generate an MKE support bundle for this specific point in time.
Preinstall MKE, MSR, and MCR images. If your cluster does not have an Internet connection, Mirantis provides tarballs containing all the required container images. If your cluster does have an Internet connection, pull the required container images onto your nodes:
$ docker run --rm -v /var/run/docker.sock:/var/run/docker.sock \ mirantis/ucp:3.4.15 images \ --list | xargs -L 1 docker pull
Load troubleshooting packages, for example, netshoot.
To upgrade MCR:
The MKE upgrade requires MCR 20.10.0 or later to be running on every cluster node. If it is not, perform the following steps first on manager and then on worker nodes:
Log in to the node using SSH.
Upgrade MCR to version 20.10.0 or later.
Using the MKE web UI, verify that the node is in a healthy state:
Log in to the MKE web UI.
Navigate to Shared Resources > Nodes.
Verify that the node is healthy and a part of the cluster.
Mirantis recommends upgrading in the following order: MCR, MKE, MSR. This topic is limited to the upgrade instructions for MKE.
To perform cluster verifications:
Verify that your cluster is in a healthy state, as it will be easier to troubleshoot should a problem occur.
Create a backup of your cluster, thus allowing you to recover should something go wrong during the upgrade process.
You cannot use the backup archive during the upgrade process, as it is version specific. For example, if you create a backup archive for an MKE 3.4.2 cluster, you cannot use the archive file after you upgrade to MKE 3.4.4.