Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 2.63 KB

add-key.md

File metadata and controls

58 lines (34 loc) · 2.63 KB
Raw

Add 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, and not on any of the Kubecost secondary clusters.

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

At install-time

Many Kubecost product configuration options can be specified at install-time, including your product key.

Option 1: Storing productkey 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):

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

Update your values.yaml to enable the product key and specify the secret name:

  • kubecostProductConfigs.productKey.enabled = true
  • kubecostProductConfigs.productKey.secretname = <SECRET_NAME>

Run a helm upgrade to start using your product key.

Option 2: Specifying product key in values.yaml

This specific parameter can be configured under kubecostProductConfigs.productKey.key in your values.yaml.

Note: You must also set the kubecostProductConfigs.productKey.enabled config to true when using this option. That this will leave your secrets unencrypted in values.yaml. Use a Kubernetes secret as in the previous method to avoid this.

In product

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.

Add key dialog

Verification

To verify that your key is properly supplied, visit Settings to confirm the final digits are as expected:

image