Skip to main content

Migrating to 2.8.0

Migration Guide​

Here you can find the needed steps to upgrade your current Witboost installation to v2.8.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.7.0 or earlier and wish to upgrade to version 2.8.0.

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

Backup Your Data​

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

Update Dependencies​

If you use the remote Witboost chart, as documented, you can skip this section.

If you install Witboost by unpacking the helm chart, make sure to download the new one and unpack it. In this way you are sure to bring all necessary updates from the upstream.

warning

If you have applied customization to the templates, make sure you add them in the new chart.

Upgrade Steps​

If you are using the Witboost Infrastructure CLI, you can execute the following command to automatically migrate your configuration file by replacing the placeholder <path_to_values.yaml> with the path pointing the values.yaml file storing the configuration.

witboost-infra transform --user-values <path_to_values.yaml> --set-target 2.8.0 --output-path <path_to_values.yaml>

After this, you can follow the rest of the migrations, skipping the steps that are marked as automatically done by the Infra CLI.

Core​

note

You can skip this section if you're using the Witboost Infra CLI transform operation, as this step is automatically performed by it.

The flag ui.appConfig.catalog.disableDeployedDataProductUnregister has been removed in favour of the new configuration ui.appConfig.catalog.disableDeployedEntitiesUnregister, which has been enabled by default. This flag will prevent the unregistration of both systems and components that are currently deployed in any environment.

warning

Be aware that this new configuration differs from the old configuration which would only apply for systems, whereas the new one also disables the unregistration for deployed components. Starting from this version, it won't be possible to disable the unregistration of deployed systems while allowing the unregistration of deployed components at the same time.

If your values.yaml configuration file has the flag ui.appConfig.catalog.disableDeployedDataProductUnregister present, rename it to ui.appConfig.catalog.disableDeployedEntitiesUnregister. If this value is not present, no migration is needed as it will keep the same default behaviour:

ui:
  appConfig:
    catalog:
      # disableDeployedDataProductUnregister: false <-- Old configuration, renamed
      disableDeployedEntitiesUnregister: false # <-- New configuration, rename and keep the same value

Starting with this release, ui subcharts unifies the image repository.

In the previous version, ui referenced two different docker images, one for the backend and one for the frontend, and they were configured with the same value.

ui:
  backend:
    image:
      registry: ...
  frontend:
    image:
      registry: ...

They have now been deprecated in favor of the unified ui.image.registry.

ui:
  image:
    registry: ...

This change ensures a unified and simplified configuration structure for UI image registries.

Custom Views​

The default custom views marketplace_system and marketplace_component have been updated to include a new column that uses the violations-status-summarycomponent. This column displays a summary of policy violations affecting each component within an entity.

These changes apply only to the default views. If you are using customizations for these pages and want to incorporate the new functionality. Navigate to the Custom View page, by going into the Witboost UI Administration Panel > Custom Views, verify if you have customizations for the marketplace_system and marketplace_component custom views and if such update them as shown below into this documentation. You can update your customizations by adding the new columns as in the example below:

marketplace_system


- type: marketplace_component_card
  title: "{{ label }}"
  children:
    - type: table
      path: components
      click: showComponent
      filters: ...
      children:
        - type: string
          path: name
          label: Name
          width: 35%
          sortable: true
        - type: violations-status-summary
          path: _policyViolationCount
          label: policies
          width: "100"
        ...

marketplace_component


- type: table
  showRowWhen:
    value: "{{ consumable }}"
    notEquals: false
  click: showSubcomponent
  path: components
  children:
    - type: string
      value: "{{ name }}"
      label: Name
    - type: violations-status-summary
      path: _policyViolationCount
      label: policies
      width: "100"
    ...

Third party services​

note

You can skip this section if you're using the Witboost Infra CLI transform operation, as this step is automatically performed by it.

Beginning with this version, the auxiliary services that were previously bundled with the helm chart will no longer be included. These services, listed below, were historically shipped alongside Witboost but are not part of the core platform:

  • loki
  • fluent-bit
  • grafana
  • cert-manager
  • external-dns

As of this release, they can be removed from the product distribution to streamline the platform and reduce maintenance overhead.

danger

If any of this subcharts is enabled in your installation, you need to migrate them outside of Witboost installation. Otherwise, they will be uninstalled in the next upgrade. As a safety measure, the Infrastructure CLI will fail if any of those services is found enabled.

You can simply remove their block from the values.yaml configuration file.

New services​

KGM & witboost-mcp-client​
note

You can skip this section if you're using the Witboost Infra CLI transform operation, as this step is automatically performed by it.

Starting with this version, Witboost introduces a few optional services called kgm and witboost-mcp-client which will be disabled by default.