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 to version

Upgrade steps

Patch releases of Everyware Cloud try to make the impact of the upgrade from the previous patch as low as possible. If any change is required by the upgrade, it will be described in the upgrade notes section below.

The process to upgrade Everyware Cloud is the following:

If the upgrade require a database schema update (see per-version upgrade notes in sections below)
- Set the database schema update property to true in the ec-configs values override file
Change the version of the container images in the ec-configs values override file.
Upgrade the standard EC components using Helm:

# Deploy the Events Broker
helm upgrade -n everyware-cloud -f ec-events-broker.yaml ec-events-broker charts/02-components/ec-events-broker

# Deploy the Message Broker
helm upgrade -n everyware-cloud -f ec-broker.yaml ec-broker charts/02-components/ec-broker

# Deploy the Web Console
helm upgrade -n everyware-cloud -f ec-console.yaml ec-console charts/02-components/ec-console

# Deploy the RESTful API
helm upgrade -n everyware-cloud -f ec-api.yaml ec-api/charts/02-components/ec-api

# Deploy the Job Engine
helm upgrade -n everyware-cloud -f ec-job-engine.yaml ec-job-engine charts/02-components/ec-job-engine

repeat the same upgrade operation for the optional components ec-vpn and ec-monitoring if installed.

# Upgrade the VPN Service if installed
helm upgrade -n everyware-cloud -f ec-vpn.yaml ec-vpn charts/02-components/ec-vpn

# Upgrade the Monitoring Service if installed
helm upgrade -n everyware-cloud -f ec-monitoring.yaml ec-vpn charts/02-components/ec-monitoring

If the database schema update property was set to true to execute the database schema update:
- Set the database schema update property back to false in the ec-configs values override file

Upgrade notes

Upgrade to EC v5.10.12

Message store and Device Logs store

If an account (and/or its sub accounts) is using either the Message store or the Device Logs store services to store data and/or device logs, after the upgrade the two services may become disabled because of a bug fixed in this release. Execute the following steps to verify the current configuration and set the correct behaviour. For each account:

If the Message store service settings have 'messageStore.enabled == false' and 'dataTTL' is greater than zero, then change 'messageStore.enabled' to 'true'.
If the Device log store service setting have 'deviceLogStore.enabled == false' and 'storageTTL' is greater than zero, then change 'deviceLogStore.enabled' to 'true'.

If the account and its sub accounts are not using Message store or Device Logs store services, 'messageStore.enabled' and 'deviceLogStore.enabled' should keep set to 'false'.

Migrate to MySQL database engine

This release introduces the support for MySQL database engine in addition to MariaDB. If you need to migrate your database from MariaDB to MySQL please contact the our support team to get more information. Support of MariaDB will continue and is the default option for new deployments.