Performing the upgrade using the CLI

Typical upgrade steps

A lot of the upgrade steps can be performed without impact on your users. Basically, the deployment or upgrade of components is split in two actions:

Configuration changes, such as added or changed configuration parameters, including the new component’s version
Deployment of the upgraded component, by (re)starting

The configuration changes can be done in advance most of the time, limiting downtime for your end users.

In the following upgrade steps, platform-config refers to the location where your platform configuration is stored for that particular environment.

Verifying every step of the way

When performing the upgrade, we strongly advise verifying whether things are working every step of the way. It is pointless to continue the upgrade if halfway 1 of the services fail to start. In general, we can give you the following tips that apply to every service when performing (re)starts after an upgrade:

Check whether the new docker image version has been pulled successfully
Check whether the container actually starts and is at least up for > 30 seconds, and not in "Restarting" mode

There are also verification steps that depend on the service which is being upgraded. Those steps can be found in the upgrade docs itself.

Step 1 - Upgrade Broker to 6.6.0

In the below steps, we are going to set up Broker to use the 6.6.0 version.

Step 1a - Configuring Broker

No additional configuration needs to be passed for running Broker 6.6.0 version.

Step 1b - Restarting Broker

When restarting the brokers, please use a rolling restart approach

Run the following command for each cluster on the machines where Broker is running:
```
axual.sh restart cluster broker
```
Confirm that the Broker restarts successfully by looking at the command output. It should end with:
```
Starting broker: Done
```
Verification after Broker restart - Don’t continue before all the following criteria met:
1. Verifying every step of the way
2. Check the docker logs of the Broker and make sure there are no errors.
  docker logs -f broker
3. Check that the UnderReplicatedPartition count is 0
Proceed to the next Broker

Step 2 - Upgrade Instance Manager to 3.7.3

In the below steps, we are going to set up Instance Manager to use the 3.7.3 version.

Step 2a - Configuring Instance Manager

No additional configuration needs to be passed for running Instance Manager 3.7.3 version

Step 2b - Restarting Instance Manager

Run the following command on the machine that should run Instance Manager:
```
axual.sh restart instance <instance-name> instance-api
```
Confirm that the service restarts successfully by looking at the command output. It should end with:
```
Starting [Instance Name]-instance-api: Done
```
Verification after Instance Manager restart - Don’t continue before all the following criteria met:
1. Verifying every step of the way
2. Check the docker logs and make sure there is no error and service is up.
  docker logs -f <instance-name>-instance-api

Step 3 - Upgrade Platform Manager to 6.20.3

In the below steps, we are going to set up Platform Manager to use the 6.20.3 version.

Step 3a - Configuring Platform Manager

No additional configuration needs to be passed for running Platform Manager 6.20.3 version

Step 3b - Restarting Platform Manager

Run the following command on the machine that should run Platform Manager:
```
axual.sh restart mgmt mgmt-api
```
Confirm that the service restarts successfully by looking at the command output. It should end with:
```
Starting mgmt-api: Done
```
Verification after Platform Manager restart - Don’t continue before all the following criteria met:
1. Verifying every step of the way
2. Check the docker logs and make sure there is no error and service is up.
  docker logs -f mgmt-api

Step 4 - Upgrade Operation Manager to 1.5.2

In the below steps, we are going to set up Operation Manager to use the 1.5.2 version.

Step 4a - Configuring Operation Manager

No additional configuration needs to be passed for running Operation Manager 1.5.2 version

Step 4b - Restarting Operation Manager

Run the following command on the machine that should run Operation Manager:
```
axual.sh restart mgmt operation-manager
```
Confirm that the service restarts successfully by looking at the command output. It should end with:
```
Starting operation-manager: Done
```
Verification after Operation Manager restart - Don’t continue before all the following criteria met:
1. Verifying every step of the way
2. Check the docker logs and make sure there is no error and service is up.
  docker logs -f operation-manager

Step 5 - Upgrade Cluster Browse to 1.6.3

In the below steps, we are going to set up Cluster Browse to use the 1.6.3 version.

Step 5a - Configuring Cluster Browse

No additional configuration needs to be passed for running Cluster Browse 1.6.3 version.

Step 5b - Restarting Cluster Browse

Run the following command for each cluster where Cluster Browse is running:
```
axual.sh restart cluster cluster-browse
```
Confirm that the service restarts successfully by looking at the command output. It should end with:
```
Starting cluster-browse: Done
```
Verification after Cluster Browse restart - Don’t continue before all the following criteria met:
1. Verifying every step of the way
2. Check the docker logs and make sure there is no error and service is up.
  docker logs -f cluster-browse

Step 6 - Upgrade Stream Browse to 1.5.2

In the below steps, we are going to set up Stream Browse to use the 1.5.2 version.

Step 6a - Configuring Stream Browse

No additional configuration needs to be passed for running Stream Browse 1.5.2 version.

Step 6b - Restarting Stream Browse

Run the following command on the machine that should run Stream Browse:
```
axual.sh restart mgmt stream-browse
```
Confirm that the service restarts successfully by looking at the command output. It should end with:
```
Starting stream-browse: Done
```
Verification after Stream Browse restart - Don’t continue before all the following criteria met:
1. Verifying every step of the way
2. Check the docker logs and make sure there is no error and service is up.
  docker logs -f stream-browse

That’s it

No other steps are required to upgrade or configure the platform components. You can read through the release blog to find out what has changed since the last release and forward it to your colleagues.