Preparing for the upgrade using the CLI

General prerequisites

Before you upgrade to 2022.2, please make sure:

  • you are running Axual version 2022.1. Use axual.sh status to check the current version.

  • you are performing the deployment with Axual CLI 2022.2

Below you will find specific prerequisites for services that are upgraded or introduced in release 2022.2.

Preparing for upgrade of Keycloak

Backup Keycloak’s Database

The backup restoration procedure depends on the tooling. For more detailed backup/restore information, check MariaDB and also MySQL references according to your setup.

  1. Backup Keycloak’s data and structure. This will be needed in case of a rollback.

Unset overridden versions

For every component upgrade step, make sure you have not overridden the version of the component, which you might have done as a result or a security update or patch release upgrade. Find below a list of all the platform components and the files where the versions are specified. Make sure all versions are commented out so that Axual CLI upgrade can take care of starting the correct version for the 2022.2 release.

Table 1. Component version file names
Component File names Configuration variable

Broker

platform-config/clusters/{cluster-name}/broker.sh

BROKER_VERSION

Cluster API

platform-config/clusters/{cluster-name}/cluster-api.sh

CLUSTERAPI_VERSION

Cluster Browse

platform-config/clusters/{cluster-name}/cluster-browse.sh

CLUSTER_BROWSE_VERSION

Schema Registry (master & slave)

platform-config/tenants/{tenant-name}/instances/{instance-name}/schemaregistry.sh

SCHEMAREGISTRY_VERSION

Discovery API

platform-config/tenants/{tenant-name}/instances/{instance-name}/discovery-api.sh

DISCOVERYAPI_VERSION

Instance API

platform-config/tenants/{tenant-name}/instances/{instance-name}/instance-api.sh

INSTANCEAPI_VERSION

Keycloak IAM

platform-config/clusters/{cluster-name}keycloak.sh

KEYCLOAK_VERSION

Management API

platform-config/clusters/{cluster-name}/mgmt-api.sh

MGMT_API_VERSION

Management UI

platform-config/clusters/{cluster-name}/mgmt-ui.sh

MGMT_UI_VERSION

Operation Manager

platform-config/clusters/{cluster-name}/operation-manager.sh

OPERATION_MANAGER_VERSION

REST Proxy

platform-config/tenants/{tenant-name}/instances/{instance-name}/rest-proxy.sh

RESTPROXY_VERSION

Stream Browse

platform-config/clusters/{cluster-name}/stream-browse.sh

STREAM_BROWSE_VERSION

Axual Connect

platform-config/tenants/{tenant-name}/instances/{instance-name}/connect.sh

CONNECT_VERSION

Next step: Performing the upgrade using the CLI

This concludes the preparation for the 2022.2 upgrade. You may now continue Performing the Upgrade.