This page provides information on changes to helm customizations that may cause confusion or
backwards incompatibility with older charts. Additional information on the customizations can be
found in the default values.yaml packaged in the SD Elements helm chart.
Any changes marked as "Important" will contain new changes requiring mandatory modification to
your custom overlays. All other changes are provided by default in the provided values.yaml
packaged with the SD Elements helm chart.
|
See Immutable Values for more information.
Certain SD Elements versions include changes that prevent the version from being skipped during an upgrade and, in some cases, from rolling back to a previous version after passing it. When upgrading an SD Elements instance beyond the next major version, ensure your upgrade plan is staged to stop at each of the SD Elements versions below. In this section these versions will be referred to as checkpoint versions.
This example uses a ficticious application, ExApp, with 5 versions: 1.0, 2.0, 3.0, 4.0, and 5.0. Version 4.0 contains a change that requires an ExApp instance is on version 4.0 before it can be upgraded to 5.0.
If the current ExApp version is 2.0 and target version is 5.0, the upgrade will need to take place in two stages:
Upgrade from 2.0 to 4.0
Upgrade from 4.0 to 5.0
Checkpoint Versions |
Notes |
|
Database engine upgrade from Postgres 12 to Postgres 16 |
|
Introduction of a new pod, change in database migration strategy during SD Elements upgrades. |
|
Data migration from |
Upgrading to a new SD Elements version is performed using helm upgrade. Usage instructions can be found in the upstream Helm Docs on the helm upgrade page.
The upgrade plan takes into account all [Checkpoint Versions] between the current and target SD Elements versions.
Upgrade notes, including version-specific prerequisites, for all SD Elements versions between current and target have been reviewed.
The Security Compass artifact store is accessible from within the Kubernetes cluster where SD Elements is deployed.
Review the upgrade prerequisites above
Determine custom values file changes . See the Compatibility section for more details.
$ helm repo update
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "sdelements" chart repository
Update Complete. ⎈Happy Helming!⎈To retrieve the latest SD Elements version:
$ helm search repo sdelements/sde
NAME CHART VERSION APP VERSION DESCRIPTION
sdelements/sde 2024.2.86 2024.2.86 SDElements by Security Compass Ltd.To retrieve a list of all SD Elements versions (note: lines have been removed from the example below):
$ helm search repo sdelements/sde
NAME CHART VERSION APP VERSION DESCRIPTION
sdelements/sde 2024.2.86 2024.2.86 SDElements by Security Compass Ltd.
sdelements/sde 2024.2.74 2024.2.74 SDElements by Security Compass Ltd.
sdelements/sde 2024.1.45 2024.1.45 SDElements by Security Compass Ltd.
sdelements/sde 2024.1.42 2024.1.42 SDElements by Security Compass Ltd.
sdelements/sde 2023.4.28 2023.4.28 SDElements by Security Compass Ltd.
sdelements/sde 2023.4.22 2023.4.22 SDElements by Security Compass Ltd.Run helm upgrade with the same parameters used with helm install … in the previous section.
$ helm upgrade {RELEASE_NAME} sdelements/sde -f {CUSTOM_VALUES_FILE} -n {NAMESPACE} --version {SDE_VERSION}
NAME: {RELEASE_NAME}
LAST DEPLOYED: XXX XXX XX XX:XX:XX XXXX
NAMESPACE: {NAMESPACE}
STATUS: deployed
REVISION: #
NOTES:
[...]