Add a License Key to Redpanda Console

The Redpanda Operator deploys Redpanda Console v2.x, not v3.x.

Redpanda Console v3 is not yet available when deploying with the Redpanda Operator. The Redpanda Operator continues to deploy Redpanda Console v2. To try Redpanda Console v3 in Kubernetes, you can deploy Redpanda using the Redpanda Helm chart instead of the Redpanda Operator.

Redpanda Console configuration syntax varies by major version. Before configuring, determine which version you’re using:

# Check console version from deployment
kubectl get deployment -n <namespace> redpanda-console -o jsonpath='{.spec.template.spec.containers[0].image}'

# Or check from running pod
kubectl get pod -n <namespace> -l app.kubernetes.io/name=console -o jsonpath='{.items[0].spec.containers[0].image}'

# Or check from console logs
kubectl logs -n <namespace> -l app.kubernetes.io/name=console | grep "started Redpanda Console"

If you see output like redpandadata/console:v2.8.0, you’re using Redpanda Console v2.x. If you see redpandadata/console:v3.0.0, you’re using Redpanda Console v3.x.

To enable enterprise features for Redpanda Console, you must have an Enterprise Edition license to load at startup. This guide explains how to configure Redpanda Console to load the license key from its local configuration.

This option is best for deployments that are not connected to a Redpanda cluster. If you plan to connect Redpanda Console to a Redpanda cluster, consider uploading the license to the Redpanda cluster. See Add an Enterprise Edition License to Redpanda Console.

Prerequisites

You must have an Enterprise Edition license. To get a trial license key or extend your trial period, generate a new trial license key. To purchase a license, contact Redpanda Sales.

If Redpanda Console has enterprise features enabled and cannot find a valid license locally or in the connected Redpanda cluster, it shuts down. See Redpanda Licenses and Enterprise Features.

Add a new license to Redpanda Console

To add a new license to Redpanda Console, you have two options:

Use a license file

Specify the path to the license file in one of the following ways:

  • Set the licenseFilepath property in the /etc/redpanda/redpanda-console-config.yaml configuration file:

    licenseFilepath: <path-to-license-file>

  • Set the REDPANDA_LICENSE_FILEPATH environment variable:

    export REDPANDA_LICENSE_FILEPATH=<path-to-license-file>

Use the license key contents directly

If you don’t want to provide a path to the license file, you can use the contents of the license key directly in one of the following ways:

  • Set the license property in the /etc/redpanda/redpanda-console-config.yaml configuration file:

    license: <license-key-contents>

  • Set the REDPANDA_LICENSE environment variable:

    export REDPANDA_LICENSE=<license-key-contents>

Update an existing license

To update an existing license:

  1. Update your configuration file or environment variables with one of the following:

  2. Restart Redpanda Console to make the changes take effect.

Next steps

Check the Status of Licenses.

Suggested reading