Install your InfluxDB Clustered license
Install your InfluxDB Clustered license in your cluster to authorize the use of the InfluxDB Clustered software.
Install your InfluxDB Clustered license
If you haven’t already, request an InfluxDB Clustered license.
InfluxData provides you with a
license.yml
file that encapsulates your license token as a custom Kubernetes resource.Use
kubectl
to apply and create theLicense
resource in your InfluxDB namespace:kubectl apply --filename license.yml --namespace influxdb
InfluxDB Clustered detects the License
resource and extracts the credentials
into a secret required by InfluxDB Clustered 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 InfluxDB Clustered and want to upgrade to a licensed release, do the following:
If you use the
AppInstance
resource configuration to configure your cluster, in yourmyinfluxdb.yml
, update the package version defined inspec.package.image
to use a licensed release.If using the InfluxDB Clustered Helm chart, update the
image.tag
property in yourvalues.yaml
to use a licensed release.Upgrade to checkpoint releases first
When upgrading InfluxDB Clustered, 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.
apiVersion: kubecfg.dev/v1alpha1
kind: AppInstance
# ...
spec:
package:
# ...
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:PACKAGE_VERSION
# values.yaml
image:
tag: PACKAGE_VERSION
Replace PACKAGE_VERSION
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:
NAMESPACE
: your InfluxDB namespacePOD_NAME
: 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 InfluxDB Clustered 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
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.
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 InfluxDB Clustered license.
For more information about InfluxDB Clustered licensing, including license enforcement, grace periods, and detailed troubleshooting, see Manage your InfluxDB Clustered license.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB Clustered and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.