Upgrade

This section describes how to upgrade Everyware Cloud.

🚧
Read and understand these instructions before upgrading. Carefully review the planning and upgrading instructions.

Planning the upgrade

The upgrade process for Everyware Cloud provides minimal downtime.

There are a few factors to consider when planning an upgrade.

To reduce risks Eurotech recommends a continual upgrade strategy to provide access to product improvements and new features and reduce version impacts
A big gap between the current version and the target version could potentially make the upgrade more dangerous and risky

Upgrades from Everyware Cloud 5.0 or 5.1 require an interim upgrade to 5.2.
When upgrading to a minor version, first upgrade to the latest patch release on your current version.

Backup

Eurotech recommends backing up your data prior to any version upgrade. This includes both the databases and custom configurations. A backup provides the ability to revert and restore all the data used in the previous version if necessary.

Upgrade order

Eurotech recommends the following upgrade order:

Events broker
Messaging service
Admin Console
RESTful API
VPN

Upgrade for patch releases

General recommendations

Be sure to read the Everyware Cloud release notes and the planning the upgrade section.

Preparing to upgrade

Before upgrading to a patch release be sure to follow these steps:

backup the databases
backup your existing configuration exporting all project configurations

Upgrade steps

Patch releases of Everyware Cloud usually do no introduce configuration or database changes. If any change is requires it will be describes pointing to the Everyware Cloud version that requires it.

The process to upgrade Everyware Cloud is the following:

push the new version images to the local registry. This step is the same as the one described in Installation
update the deployments with the new Docker images by editing the various deployment configurations selecting the new image to use

Upgrade from 5.2 to 5.3

General recommendations

Be sure to read the Everyware Cloud release notes and the planning the upgrade section.

It's recommended to upgrade to the latest version of the 5.2.x release before moving to 5.3.

Preparing to upgrade

Before upgrading to a patch release be sure to follow these steps:

backup the databases
backup your existing configuration exporting all project configurations

Upgrade steps

This upgrades requires schema updates in the database used by Everyware Cloud.

The process to upgrade Everyware Cloud is the following:

push the new version images to the local registry. This step is the same as the one described in Installation
stop the various services. This can be achieved scaling down the deployments to 0. Official documentation could be found here
enable schema update changing the config map containing Everyware Cloud deployments configuration to true
update the deployments with the new Docker images by editing the various deployment configurations selecting the new image to use
start the services scaling up the deployments to 1 and then, once the service is available again, to the original number of pods. Follow the order described in the planning section. Official documentation could be found here
enable schema update changing the config map containing Everyware Cloud deployments configuration to false

Rollback an upgrade

In case of problems with the upgraded version it's possible to revert to a previous version.

The steps for the rollback are the following:

stop all the services scaling down the deployments to 0. Official documentation could be found here
restore the databases to the backed-up version
revert the deployment configuration to the previous version. OpenShift official documentation could be found here
start the services scaling up the deployments to 1 and then, once the service is available again, to the original number of pods. Follow the order described in the planning section. Official documentation could be found here