add-key.md

Adding a Product Key

You can apply your product key at any time within the product UI or during an install or upgrade process. More details on both options are provided below.

If you have a multi-cluster setup, you only need to apply your product key on the Kubecost primary cluster. In the event that you are viewing/repairing data on a secondary cluster, you will need to apply your product key on that cluster as well.

{% hint style="info" %} kubecostToken is a different concept from your product key and is used for managing trial access. {% endhint %}

Option 1: Storing product key in a secret

To create a secret you will need to create a JSON file called productkey.json with the following format. Be sure to replace <YOUR_PRODUCT_KEY> with your Kubecost product key.

{ 
  "key": "<YOUR_PRODUCT_KEY>"
}

Run the following command to create the secret. Replace <SECRET_NAME> with a name for the secret (example: productkeysecret):

{% code overflow="wrap" %}

$ kubectl create secret generic <SECRET_NAME> -n kubecost --from-file=productkey.json

{% endcode %}

Update your values.yaml to enable the product key and specify the secret name, then run a helm upgrade:

kubecostProductConfigs:
  productKey:
    enabled: true
    secretname: <SECRET_NAME>

Option 2: Apply your product key to values.yaml and upgrade Kubecost

You can also place your product key directly in your values.yaml, then run a helm upgrade.

kubecostProductConfigs:
  productKey:
    enabled: true
    key: "<YOUR_PRODUCT_KEY>"

Option 3: Apply your product key in the Kubecost UI

To apply your license key within the Kubecost UI, visit the Overview page, then select Upgrade in the page header.

Next, select Add Key in the dialog menu shown below.

You can then supply your Kubecost provided license key in the input box that is now visible.

Verification

To verify that your key has been applied successfully, visit Settings to confirm the final digits are as expected: