side menu

Update version of BRIX Enterprise offline

To ensure data integrity when migrating with a version change of the BRIX edition, it is recommended to update each major version without skipping any, for example, X.4.1 can be updated to X.7.1.

The BRIX Enterprise update process consists of four stages:

  1. Determine the number of update steps.
  2. Download the Helm chart of the latest version.
  3. Copy the configuration file from the currently installed version.
  4. Update using helm in the Kubernetes cluster for the BRIX application.

Step 1: Determine the number of update steps

  1. Determine the version of the installed chart with which the BRIX application was previously deployed or updated:

helm show chart brix365/brix365

  1. On a computer with internet access, determine the version of the latest chart:

helm repo add brix365 https://charts.brix365.com
helm repo update
helm search repo brix365/brix365

  1. If you need to update your chart for more than one version, install each major version until you reach the latest chart.

Important: when updating to the next major version, install its latest minor release.

начало примера

Examples

Major On-Premises releases use version numbers X.1, X.4, X.7, and X.10. In the examples, the current minor version is marked as N. When upgrading, use the latest available version:

  1. If the installed chart version is X.1.12 and the latest chart version is X.4.N, upgrade in a single step: directly to X.4.N.
  2. If the installed chart version is X.1.12 and the latest chart version is X.7.N, upgrade in two steps: X.1.12 > X.4.N > X.7.N.
  3. If the installed chart version is X.1.12 and the latest chart version is X.10.N, upgrade in three steps: X.1.12 > X.4.N > X.7.N > X.10.N.

конец примера

Please note that your current version in an LTS version, you can update directly to the next LTS version according to the release life cycle schedule.

To see the list of all BRIX versions, use the following command:

helm repo add brix365 https://charts.brix365.com
helm repo update
helm search repo brix365/brix365 --versions

Step 2: Download the helm chart of the latest version

  1. On a computer with internet access, download the recent BRIX images and upload them into the local image registry. For more details, see Download BRIX images.
  1. Update the list of charts in the repository:

helm repo add brix365 https://charts.brix365.com
helm repo update

  1. If needed, download the archive files of the intermediate minor versions for all update steps:

helm pull brix365/brix365 --version <brix365-chart-version>

  1. Download the archive of the latest version of the BRIX On-Premises chart.

helm pull brix365/brix365

  1. Copy the obtained archive (or archives, if there are intermediate update steps) of the elma365-X.Y.Z.tgz chart to the server where the update will be performed.
  1. On the server where the update will take place, unpack the elma365-X.Y.Z.tgz chart or charts, each into a separate directory.

mkdir /path/to/brix365-X.Y.Z.tgz
tar -xf brix365-X.Y.Z.tgz -C /path/to/brix365-X.Y.Z.tgz --strip-components=1

Step 3: Copy the configuration file from the currently installed version

Copy the configuration file values-elma365.yaml from the directory with the chart of the old (current) installation of BRIX On-Premises into each directory with the chart prepared at the step of downloading the helm-chart of the latest version.

If the values-elma365.yaml file was lost, retrieve the parameters of the current BRIX installation and save them in this file by executing the command:

helm get values brix365 [-n namespace] > values-brix365.yaml

Please note that starting from version 2023.4.30, the structure of the values-elma365.yaml configuration file has been updated.

If you are updating from 2023.4.0-21 or earlier versions to 2023.4.30 or newer versions, you need to:

  1. On a computer with internet access, obtain the updated configuration file values-elma365.yaml:
  • For the latest version by executing the command:

helm show values brix365/brix365 > values-brix365.yaml

  • For a certain version by executing the command with the --version flag:

helm show values brix365/brix365 --version <brix365-chart-version> > values-brix365.yaml

Where <elma365-chart-version> is the system version required.

  1. Copy the new file values-elma365.yaml to the server where the update will be performed.
  1. Manually transfer the application parameters from the old  configuration file values-elma365.yaml (versions before 2023.4.30) to the new configuration file.

Step 4: Update using Helm in the Kubernetes cluster for the BRIX application

Update the BRIX applications using the values-elma365.yaml configuration file. If there are intermediate minor versions (two or more update steps), sequentially perform the update for each intermediate minor version.

Navigate to the directory with the required version of BRIX and execute the command:

helm upgrade --install brix365 ./brix365 -f values-brix365.yaml --timeout=30m --wait [-n namespace]

Updating the application takes 10-30 minutes. Wait for the update of the BRIX Enterprise application parameters to complete.