CluedIn PaaS

Upgrade guide

This guide provides instructions for upgrading CluedIn after the initial installation. Regular upgrades are recommended to ensure you benefit from the latest features, improvements, and fixes. For details about the updates available in a specific release, see Release notes.

The upgrade process typically involves the steps outlined below.

If issues occur during the upgrade, see Resolve common upgrade issues for troubleshooting instructions.

upgrade_process.png

Prerequisites for upgrade

Before starting an upgrade, make sure you have the following in place:

  1. Access to live CluedIn application.
  2. Access to Azure Kubernetes Service (AKS) cluster.
  3. Access to the kubeconfig file – this must be provided by your Azure administrator.
  4. A machine or a virtual machine (VM).
  5. All the required tools installed on the machine/VM.
  6. Valid and trusted SSL certificates for the environment.

Stage 1 – Plan your upgrade

  1. Get familiar with the versioning scheme. See instructions.
  2. Review upgrade-related documentation. See instructions.
  3. Schedule the upgrade window. See instructions.
  4. Inform the stakeholders. See instructions.
  5. Perform a full backup. See instructions.
  6. Prepare and test custom packages. See instructions.

Stage 2 – Prepare for the upgrade

  1. Get access to CluedIn application. See instructions.
  2. Prepare the kubeconfig file. See instructions.
  3. Configure kubectl. See instructions.
  4. Configure Helm. See instructions.
  5. (Optional) Connect Lens or Freelens to your cluster. See instructions.

Stage 3 – Perform the upgrade

  1. Get current Helm user values. See instructions.
  2. Prepare new Helm user values. See instructions.
  3. Perform system pre-checks. See instructions.
  4. Perform Helm upgrade. See instructions.
  5. Verify the upgrade. See instructions.
  6. Notify about upgrade completion. See instructions.

Useful resources