Edge site upgrade methods

There are two ways to upgrade your Edge site:

  • Automatic: your Edge site automatically upgrades when a new version is available.
  • Manual: your Edge site alerts you when a new version is available, and you can review the Software bill of materials and perform security scans before completing the upgrade. If an upgrade is mandatory, your Edge site will be in read-only mode until you upgrade the site. A mandatory upgrade is required within 3 months of the Collibra Data Intelligence Platform quarterly release. Upgrades may become required sooner due to:
    • Important security updates.
    • Migrations.
    • New feature requirements.

Automatic upgrade

The Automatic mode is the default upgrade mode for Edge sites. This means that when a new Edge site version is released, you do not need to initiate the upgrade, as it will automatically be applied to your Edge site. You will only need to take action if the new version includes new software requirements or your installer becomes out-of-date. This information will be provided to you through release notes, and you can review the compatibility table to see which Edge site versions may require action, such as a reinstall for sites installed on k3s or a Kuberntes upgrade for sites installed on managed Kubernetes. For how to enable automatic upgrade mode for your Edge sites that use the manual upgrade mode, go to Enable Automatic upgrade for Edge sites.

Note If you created an Edge site prior to the 2023.08 release, your Edge sites have Automatic upgrade enabled.

Manual upgrade

The Manual upgrade mode allows you to choose when, and to which version, you want to upgrade your Edge sites. Whenever an Edge site version becomes available, a banner is displayed at the top of the page with an Upgrade Now button. After you select the version to which you want to upgrade your site, you can download the Software Bill of Materials to review and scan before beginning the upgrade.

Upgrade types

There are two types of upgrades:

  • Optional: minor updates which occur between quarterly releases, and include security and minor bug fixes. You can choose to wait or upgrade your Edge site.
  • Mandatory: major releases which occur on a quarterly basis, and include new features and enhancements. A mandatory upgrade is required within 3 months of the Collibra Data Intelligence Platform quarterly release. When a mandatory upgrade becomes available and you have manual upgrades enabled for an Edge site, your site will be in read-only mode until you upgrade the site to the mandatory version. For more information, go to the Compatibility between Edge sites and Collibra Data Intelligence Platform. This is to ensure that all Edge features are appropriately updated and compatible with Collibra.
    • Important You cannot start or configure any connections or capabilities if your Edge site is in read-only mode. You must perform the mandatory upgrade or wait until an upgrade has been completed to resume full access to Edge.

Your Edge site lists whether an upgrade is optional or mandatory. For how to enable manual upgrade mode for your Edge sites that use the automatic upgrade mode, go to Enable Manual upgrade for Edge sites.

Software Bill of Materials

You can download a Software Bill of Materials (SBOM) to review the contents of an Edge site version. A SBOM is a list of images included in an Edge site version that your security team may want to perform security scans and evaluations on before your Edge site is upgraded to a new version.

For more information about Edge security and scanning, go to Security scanning.

You can retrieve the SBOM through one of the following methods:

  • A REST API.
    • Location: <hostname>/edge/api/rest/v2/releaseinfo/<edge version>/bom
  • Selecting an upgrade version in the Edge platform.

The SBOM is downloaded as a zip file containing JSON files. These are in SPDX and CYCLONEDX formats which you can use as input files for your security scanning tools.

Note Security scans report are only accepted for the most recent generally available (GA) release. For more information, go to one of the following resources:

What's next?