Manage License Key

This article explains how to configure encryption for data source credentials and set up a valid license key required to run GoodData.CN. It also covers how to update your license key after deployment.

Add License Key

GoodData.CN requires a valid license key to start. Use the key you received from GoodData.

Lost License Key?

If you cannot locate your key, contact GoodData Support.

You can provide the license key in one of two ways:

Option 1: Use a Kubernetes Secret

  1. Create a Secret in the gooddata-cn namespace that contains your license key:

    kubectl -n gooddata-cn create secret generic gooddata-cn-license    --from-literal=license=key/eyJhY2NvdW50I...a very long string...IGfMjaRJZcg==

  2. Reference the Secret in your Helm values file:

    license:
  existingSecret: gooddata-cn-license

License key format

Make sure you enter the license key exactly as received:

  • Do not omit or change any characters.
  • Remove all spaces.
  • Keep it on a single line.

If the license key is modified, GoodData.CN will fail to start.

Option 2: Pass the License Key Directly

For Testing Environments Only

We recommend you always encrypt your license key in production environments.

Add the key in your custom Helm values file:

license:
  key: "key/eyJhY2NvdW50I...a very long string...IGfMjaRJZcg=="

Update License Key

When your current license key expires or you renew your subscription, you must update the license key in your GoodData.CN deployment.

Ensure that while updating the license key, no other configuration settings are changed.

Kubernetes Secret

If your deployment references a Secret:

  1. Confirm that your Helm values file references the correct Secret:

    license:
  existingSecret: gooddata-cn-license

  2. Create or update the Secret in the gooddata-cn namespace:

    kubectl -n gooddata-cn create secret generic gooddata-cn-license    --from-literal=license=key/eyJhY2NvdW50I...a new and updated long string...IGfMjaRJZcg==    --dry-run=client -o yaml | kubectl apply -f -

    This command updates the existing Secret if it exists, or creates it if it does not.

    The new license key should be reloaded automatically within a few minutes.

Attention

After updating the license key, verify that your GoodData.CN instance starts correctly and functions as expected.
Keep a backup of your configuration files and be ready to perform a rollback if needed.

Custom Values File

If the license key was provided in a custom values file (for example, customized-values-gooddata-cn.yaml):

  1. Open the customized-values-gooddata-cn.yaml file.
  2. Locate the license section.
  3. Replace the existing key with your new one: 
    license:
  key: "key/eyJhY2NvdW50I...a new and updated long string...IGfMjaRJZcg=="
  4. Save the file.
  5. Apply the update using Helm: 
    helm upgrade [YOUR_HELM_RELEASE_NAME] --version <<TBD>> --namespace gooddata-cn      -f customized-values-gooddata-cn.yaml gooddata/gooddata-cn
Helm Chart Options
Switch to Istio