CluedIn PaaS

2025.05.00

On this page

  1. Prerequisites
  2. Guide
    1. Stage 1: Prepare for Upgrade
    2. Stage 2: Run Data Upgrade
    3. Stage 3: Finalize Upgrade

This document covers the upgrade process from 2024.12 to 2025.05.00.

We do not support upgrading directly to this version from prior to 2024.12.

Prerequisites

  • Access to the helm chart version 2.5.0. You may need to helm repo update to grab the latest.
  • kubectl and helm

Guide

Before any upgrade takes place, ensure you have taken a snapshot or backup of all your running PVCs in your AKS cluster. This is very important as databases may be upgraded during this process.

Stage 1: Prepare for Upgrade

  1. Connect to your cluster via the kubeconfig.
  2. Export your current running helm values file. Keep one for this process, and also keep one as a backup.
  3. In the values file we’ll be working with, update the following properties:

     global:
       image:
         tag: "2025.05.00"
       strategy:
         type: Recreate
    
     application:
       cluedin:
         components:
           packages:
           - name: "CluedIn.Connector.AzureEventHub"
             version: "4.5.0"
           - name: "CluedIn.Connector.Dataverse"
             version: "4.5.0"
           - name: "CluedIn.Connector.Http"
             version: "4.5.0"
           - name: "CluedIn.EventHub"
             version: "4.5.0"
           - name: "CluedIn.Vocabularies.CommonDataModel"
             version: "4.5.0"
           - name: "CluedIn.Connector.AzureDataLake"
             version: "4.5.0"
           - name: "CluedIn.Connector.AzureDedicatedSqlPool"
             version: "4.0.2"
           - name: "CluedIn.Connector.AzureServiceBus"
             version: "4.5.0"
           - name: "CluedIn.Connector.OneLake"
             version: "4.5.0"
           - name: "CluedIn.ExternalSearch.Providers.DuckDuckGo.Provider"
             version: "4.5.0"
           - name: "CluedIn.ExternalSearch.Providers.PermId.Provider"
             version: "4.5.0"
           - name: "CluedIn.ExternalSearch.Providers.Web"
             version: "4.4.1"
           - name: "CluedIn.Provider.ExternalSearch.Bregg"
             version: "4.4.1"
           - name: "CluedIn.Provider.ExternalSearch.ClearBit"
             version: "4.4.1"
           - name: "CluedIn.Provider.ExternalSearch.CompanyHouse"
             version: "4.5.0"
           - name: "CluedIn.Provider.ExternalSearch.CVR"
             version: "4.4.1"
           - name: "CluedIn.Provider.ExternalSearch.Gleif"
             version: "4.4.1"
           - name: "CluedIn.Provider.ExternalSearch.GoogleMaps"
             version: "4.5.0"
           - name: "CluedIn.Provider.ExternalSearch.KnowledgeGraph"
             version: "4.5.0"
           - name: "CluedIn.Provider.ExternalSearch.Libpostal"
             version: "4.4.1"
           - name: "CluedIn.Provider.ExternalSearch.OpenCorporates"
             version: "4.5.0"
           - name: "CluedIn.Provider.ExternalSearch.Providers.VatLayer"
             version: "4.5.0"
           - name: "CluedIn.Purview"
             version: "4.5.0"
           - name: "CluedIn.PowerApps"
             version: "4.5.0"
           - name: "CluedIn.EnterpriseFlows.PowerAutomate"
             version: "4.5.0"
           - name: "CluedIn.Connector.SqlServer"
             version: "4.5.0"
           - name: "CluedIn.Connector.FabricOpenMirroring"
             version: "4.5.0"
           - name: "CluedIn.Provider.ExternalSearch.Providers.AzureOpenAI"
             version: "4.4.1"
           - name: "CluedIn.Provider.ExternalSearch.GoogleImages"
             version: "4.4.1"
           - name: "CluedIn.Provider.ExternalSearch.RestApi"
             version: "4.5.0"
    
       gql:
         hubSpotToken: <pat-token>
    
  4. Apply the values file from your shell by running the following:

     # ${CustomValues} refers to the values file you have amended with the above changes. Please type the full path here.
    
     helm upgrade cluedin-platform -n cluedin cluedin/cluedin-platform \
         --version 2.5.0 \
         --values ${CustomValues} \
         --set application.system.upgradeMode=true \
         --set application.system.runDatabaseJobsOnUpgrade=true \
         --set application.system.runNugetFullRestore=true \
         --wait \
         --timeout 10m0s
    

    After a few minutes, it should successfully complete.

    1. Validation:
    • ❗ Wait until deployment finishes. Make sure that all pods are healthy and all jobs are completed.
    • ❗ Don’t proceed further if any of the pods have health issues. Rather investigate the issues. This will apply dynamic mappings to every CluedIn index

Stage 2: Run Data Upgrade

  1. Apply data upgrade by running following command:
     kubectl apply -f - <<EOF
     apiVersion: api.cluedin.com/v1
     kind: DataUpgrade
     metadata:
       annotations:
         meta.helm.sh/release-name: cluedin-platform
         meta.helm.sh/release-namespace: cluedin
       labels:
         app: cluedin
         app.kubernetes.io/instance: cluedin-platform
         app.kubernetes.io/managed-by: Helm
         app.kubernetes.io/name: application
         helm.sh/chart: application-2.5.0
         release: cluedin-platform
       name: data-upgrade-450
       namespace: cluedin
     spec:
       toVersion: Version450
     EOF
    
  2. Validation:

    • ❗ Confirm the data upgrade completed successfully.

Stage 3: Finalize Upgrade

  1. Run the final stage of the upgrade to bring the system back online (disable upgrade mode):

     # ${CustomValues} refers to the values file you have amended with the above changes. Please type the full path here.
    
     helm upgrade cluedin-platform -n cluedin cluedin/cluedin-platform \
       --version 2.5.0 \
       --values ${CustomValues}
       --set application.system.upgradeMode=false \
       --set application.system.runDatabaseJobsOnUpgrade=false \
       --set application.system.runNugetFullRestore=false
    
  2. Validation:

    • Ensure no errors in the pod logs.
    • Verify the server starts in normal mode.
    • Ensure cluedin-ui pod is Running..

If there are any issues during the upgrade process, please do not hesitate to reach out to CluedIn support.