Skip to main content

Upgrade Instructions

How you upgrade the platform depends on how you deployed it. Upgrading should always be performed with caution. The upgrade process is irreversible, so it is essential to create backups of the database and of your deployment's configuration before proceeding.

Upgrading to 2.20.0​

Whatever your deployment, check the following before you upgrade to 2.20.0:

  • Maintenance window — at its first start, Core migrates the discovered certificates in its database, which can take minutes on a large installation. Plan a maintenance window, see Longer Core startup.
  • External message broker — before you upgrade, create the provider.discovery-work queue, its binding and Core's permission to read from it, as the notes for Helm and the Kubernetes Operator describe.
  • CBOM Repository — if a CBOM Repository URL is set in Platform Settings, upgrade the CBOM Repository to 1.2.0 or later, before the platform or together with it. On the virtual appliance, set ilm_cbom_repository_version, see Kubernetes upgrades.
  • Proxies — upgrade every proxy to 1.0.1, which Core 2.20.0 relies on. A Proxy resource of the Kubernetes Operator takes its version from the operator, see the Operator notes.
  • Pinned images — an image whose tag or digest you set yourself stays at that version, and so does a connector deployed outside the Helm chart. Move each to its version in Current Versions, including Auth 1.8.0. A Helm values file created with helm show values sets the image.tag of Core.

Choose your upgrade path​

DeploymentUpgrade guide
Kubernetes OperatorUpgrading
Helm chartUpgrading a Helm deployment below, and the chart's own Upgrading notes
Virtual applianceUpgrading

Upgrading a Helm deployment​

Pre-upgrade steps​

Backup​

Before upgrading, follow these steps to back up the database and Helm chart values:

Update Helm chart values​

Review the release notes of the new version for any necessary changes to Helm chart values. Create a copy of the current values:

bash
cp ilm-values-[current version].yaml ilm-values-[new version].yaml

Update the new file ilm-values-[new version].yaml with the required changes and save the updated file.

Upgrade the platform​

Once backups are secured and the Helm chart values are updated, proceed with the upgrade.

Run the following Helm command to upgrade the platform:

bash
helm upgrade --namespace ilm \
-f ilm-values-[new version].yaml ilm \
oci://hub.omnitrustregistry.com/ilm-helm/ilm \
--version [new version]

Verify that the upgrade completes successfully.

Post-upgrade steps​

  1. Monitor the application to ensure it is functioning correctly.
  2. If any issues arise, follow the Backup and Recovery steps to restore the platform to its previous state.