Install your InfluxDB Clustered license

Install your {{% product-name %}} license in your cluster to authorize the use of the {{% product-name %}} software.

Install your {{% product-name %}} license

1. If you haven't already, request an {{% product-name %}} license.

2. InfluxData provides you with a license.yml file that encapsulates your license token as a custom Kubernetes resource.

3. Use kubectl to apply and create the License resource in your InfluxDB namespace:

   <!--pytest.mark.skip-->
   bashCopy

   kubectl apply --filename license.yml --namespace influxdb
   

{{% product-name %}} detects the License resource and extracts the credentials into a secret required by {{% product-name %}} Kubernetes pods. Pods validate the license secret both at startup and periodically (roughly once per hour) while running.

Upgrade from a non-licensed release

If you are currently using a non-licensed preview release of {{% product-name %}} and want to upgrade to a licensed release, do the following:

1. Install an {{% product-name %}} license

2. If you use the AppInstance resource configuration to configure your cluster, in your myinfluxdb.yml, update the package version defined in spec.package.image to use a licensed release.

   If using the {{% product-name %}} Helm chart, update the image.tag property in your values.yamlto use a licensed release.

   [!Warning]

   Upgrade to checkpoint releases first

   When upgrading {{% product-name %}}, always upgrade to each checkpoint release first, before proceeding to newer versions. Upgrading past a checkpoint release without first upgrading to it may result in corrupt or lost data.

{{% code-placeholders "PACKAGE_VERSION" %}}

{{< code-tabs-wrapper >}} {{% code-tabs %}} AppInstance Helm {{% /code-tabs %}} {{% code-tab-content %}}

apiVersion: kubecfg.dev/v1alpha1
kind: AppInstance
# ...
spec:
  package:
    # ...
    image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:PACKAGE_VERSION

{{% /code-tab-content %}} {{% code-tab-content %}}

# values.yaml

image:
  tag: PACKAGE_VERSION

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}

{{% /code-placeholders %}}

Replace {{% code-placeholder-key %}}PACKAGE_VERSION{{% /code-placeholder-key %}} with the version number to upgrade to.

Verify your license

After you have activated your license, use the following signals to verify the license is active and functioning.

In your commands, replace the following:

• {{% code-placeholder-key %}}NAMESPACE{{% /code-placeholder-key %}}: your InfluxDB namespace
• {{% code-placeholder-key %}}POD_NAME{{% /code-placeholder-key %}}: your InfluxDB Kubernetes pod

Verify database components

After you install your license, run the following command to check that database pods start up and are in the Running state:

kubectl get pods -l app=iox --namespace influxdb

If a Pod fails to start, run the following command to view pod information:

kubectl describe pod POD_NAME --namespace influxdb

Verify the Secret exists

Run the following command to verify that the licensing activation created a iox-license secret:

kubectl get secret iox-license --namespace influxdb

If the secret doesn't exist, view license-controller logs for more information or errors. For troubleshooting guidance, see Manage your {{% product-name %}} license.

View license controller logs

The license controller component creates a Secret named iox-license from your License. To view license controller logs for troubleshooting, run the following command:

kubectl logs deployment/license-controller --namespace influxdb

Renew your license

[!Tip] Before your license expires, your InfluxData sales representative will contact you about license renewal. You may also contact your sales representative at any time.

If you have an expired license, follow the same process to install your renewed license using the new license.yml file provided by InfluxData.

[!Important]

Recover from an expired license

If your license has already expired and your cluster pods are in a CrashLoopBackoff state, applying a valid renewed license will restore normal operation. For more information about license enforcement and recovery, see Manage your {{% product-name %}} license.

For more information about {{% product-name %}} licensing, including license enforcement, grace periods, and detailed troubleshooting, see Manage your {{% product-name %}} license.

{{< page-nav prev="/influxdb3/clustered/install/set-up-cluster/configure-cluster/" prevText="Configure your cluster" next="/influxdb3/clustered/install/set-up-cluster/deploy/" nextText="Deploy your cluster" keepTab=true >}}