Skip to main content

Migrating to 2.3.0

Migration Guide​

Here you can find the needed steps to upgrade your current Witboost installation to v2.3.0. Please refer to the release notes for a detailed list of changes and improvements. This guide is intended for users who are currently running Witboost version 2.3.0 or earlier and wish to upgrade to version 2.3.0.

Follow these steps to migrate from the previous version to Witboost version 2.3.0:

Backup Your Data​

Before starting the migration, ensure you have a complete backup of your database and configuration files.

Update Dependencies​

Ensure all the dependencies in the Helm files are updated to their compatible versions for 2.3.0. Refer to the published Helm chart for details.

Upgrade Steps​

Core​

Migration

  • If you're explicitly overriding config catalog.rules.allow (under appConfig in the ui block of the values.yaml file of the Witboost Chart): Append TaxonomyType, Trait to the catalog.rules.allow list

  • This version introduces the Skeleton Entity model as the new standard for defining catalog-info.yaml files of systems and components.

    You can migrate gradually — at your own pace — by updating entities (systems and components), along with their associated creation, edit, and reverse provisioning templates, and tech adapters. There's no need to migrate everything upfront: Legacy entities will continue to be supported alongside Skeleton Entities.

    We recommend reviewing the documentation to fully understand the Skeleton model (you can start from the Witboost Catalog section) and follow the provided migration guidelines.

    Upgrading to the latest Witboost version does not require all entities to adopt the Skeleton model.

Coordinator and Computational Governance Platform Split​

Changes

Until now, the Provisioning Coordinator and Computational Governance Platform (CGP) have been run as two distinct services within the same server (i.e., a single Docker image — the Provisioning Coordinator's one — containing both).

Starting with this release, CGP and Coordinator can be run independently.

Migration

By default, the Provisioning Coordinator will continue to launch both the Coordinator and CGP services, just as before. This means splitting them is not mandatory yet. However, we strongly recommend making the split now, as it will become mandatory in a future release.

Provisioning Coordinator​

Navigate to the provisioning-coordinator section in the values.yaml file of the Witboost Chart. In configOverride, add the following configurations under the provisioning-coordinator key:

enable-coordinator-cgp-compatibility = false
cgp-url = "http://governance-platform:8090/governance-platform"
# ...
  • enable-coordinator-cgp-compatibility = false tells the Coordinator not to start CGP alongside it.
  • cgp-url specifies the new location of the CGP service.

Within configOverride you'll also find a computational-governance-platform configuration block:

computational-governance-platform {...}

It must be moved to a new governance-platform section in values.yaml — this section does not exist yet and must be created. Define it as follows (follow the comments carefully):

governance-platform:
  enabled: true
  extraEnv: # Set only if present in the 'provisioning-coordinator' section
      - name: CGP_DB_DBNAME
        value: # Use the same value set in the 'provisioning-coordinator' section for this same key
  useClientCertificate: # Configure only if if present in the 'provisioning-coordinator' section
    enabled: true # Same value as in 'provisioning-coordinator'
    remoteSecretName: <same value as in 'provisioning-coordinator'> # Same value as in 'provisioning-coordinator'

  # Copy "akka" from 'provisioning-coordinator > configOverride' (if defined)
  # Move "computational-governance-platform" from 'provisioning-coordinator > configOverride'
  configOverride: |-
    akka {
      # Copy (but do not remove) this section from 'provisioning-coordinator > configOverride' if defined
    }
    computational-governance-platform {
      # Move this section from 'provisioning-coordinator > configOverride'
    }
Core​

Go to the ui block in the values.yaml file of the Witboost Chart. Under appConfig, set mesh.governance.baseUrl as shown below:

mesh:
  governance:
     baseUrl: "http://governance-platform:8090/governance-platform"