Skip to main content

Migrating to 0.4.0

Migration Guide

Here you can find the needed steps to upgrade your current Witboost installation to v0.4.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 0.3.0 or earlier and wish to upgrade to version 0.4.0.

Follow these steps to migrate from the previous version to Witboost version 0.4.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 0.4.0. Refer to the published Helm chart for details.

Upgrade Steps

Core

  • Create new entry in vault in path backstage/license with following keys:
    • licenseFile: contains license information such as product usage expiration. It is a JSON file.
    • signature: the signature calculated with the private key on file licenseFile.

The license will be resolved automatically from Vault. Update also your Helm charts accordingly:

  • Create license-secret.yaml under k8s/chart/backstage/templates/ with the following contents:
    apiVersion: v1
    kind: Secret
    metadata:
    name: {{ include "backstage.fullname" . }}-license
    type: Opaque
    data:
    licenseFile: {{ .Values.license.licenseFile | b64enc }}
    signature: {{ .Values.license.signature | b64enc }}
  • In k8s/chart/backstage/templates/backend-deployment.yaml define a volume (under volumes) as:
    - name: license
    secret:
    secretName: {{ include "backstage.fullname" . }}-license
  • In the same file of step 2, make sure to mount the license volume under volumeMounts by adding these lines:
    - name: license
    readOnly: true
    mountPath: "/app/license"
    subPath: licenseFile
    - name: license
    readOnly: true
    mountPath: "/app/signature"
    subPath: signature
  • Finally, in values.deployment.yaml add the following lines:
    license:
    licenseFile: !vault k8s/backstage/license#licenseFile
    signature: !vault k8s/backstage/license#signature