License and sales key renewal

When your license expires or you obtain a new sales key, you must renew your Custom Edition license. In addition, you can view detailed license information that includes expiration dates, entitlements, and status.

License renewal

When your license expires or you get a new sales key, you must renew your Custom Edition license. To do so, complete the following steps:

  1. Download the new license either by using the kubectl plug-in or by using the curl command.
    • Use the kubectl plug-in to download the new license.
      kubectl instana license download --sales-key <SalesKey>
       
    • Use the curl command to download the license.
      curl https://instana.io/onprem/license/download/v2/allValid?salesId=<your-SalesKey> -o license.json
       
  2. Update the license in the config.yaml file that is in the unit secret.
    1. List the available units in your namespace to identify the unit name.
      kubectl get unit -n <unit_namespace>
    2. Extract config.yaml from the Instana unit secret and save it as config-<unit_name>.yaml file. Use the unit name from the previous step.

      kubectl get secret <unit_name> -n <unit_namespace> -o jsonpath="{.data.config\.yaml}" | base64 -d > config-<unit_name>.yaml
       
      Note: If multiple units exist in the namespace, run this command for each unit.
    3. Update the license in the config-<unit_name>.yaml file with the new license.

    4. Update the unit secret with the new config-<unit_name>.yaml file.

      kubectl delete secret <unit_name> -n <unit_namespace>
      kubectl create secret generic <unit_name> -n <unit_namespace> --from-file=config.yaml=/path/to/config-<unit_name>.yaml
       
      Note: The new license automatically activates after the old license expires. If a message appears on the Instana UI about license expiry, you can ignore the message.

View license information

You can now view detailed license information by using the kubectl instana command.

  • To view license details, run the following command:
    kubectl instana license info --tenant <tenant-name> --unit <unit-name> -n <namespace> 
  • To view the license usage summary, including status, remaining days, expiry date, and active license, run the following command:
    kubectl instana license info --tenant <tenant-name> --unit <unit-name> -n <namespace> --usage

Sales key renewal

When you get a new sales key, you must update the salesKey value in the config.yaml of Instana core secret.

To update the sales key, complete the following steps:

  1. Extract the config.yaml from the Instana core secret and save it as config.yaml file

    kubectl get secret instana-core -n <core_namespace> -o jsonpath={'.data.config\.yaml'}|base64 -d > config.yaml
     
  2. Update the salesKey value in config.yaml file with the new sales key.

  3. Update the Instana core secret with the updated config.yaml file.

    kubectl delete secret instana-core -n <core_namespace>
    kubectl create secret generic instana-core -n <core_namespace> --from-file=config.yaml=/path/to/config.yaml