Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.risingwave.com/llms.txt

Use this file to discover all available pages before exploring further.

RisingWave Console uses the same signed RisingWave license key as the RisingWave database. A single license key can be used for both Console enterprise features and RisingWave database premium features. The key is the same, but operators configure it in different places depending on what needs to read it:
License flowWhere it is usedWhat it controls
Console startup licenseThe Console server processWhether Console starts and whether Console premium features are available.
RisingWave database license keyA managed RisingWave cluster created from ConsoleWhether that RisingWave database cluster can use premium database features.
In other words, Console does not use a separate product license key. It uses the same RisingWave license key, provided once to Console for startup and separately to any managed RisingWave database cluster that needs the database-side license.

​
Console startup license

Production Console builds verify the signed RisingWave license key during startup. Console exits if the key is missing, invalid, expired, or does not include the premium feature. Set one of these environment variables: 
RW_LICENSE_KEY="<your-signed-license-token>"
or: 
RW_LICENSE_KEY_PATH=/etc/rconsole/license.jwt
For Docker: 
docker run -d -p 8020:8020 --name risingwave-console \
  -e RCONSOLE_ROOT_PASSWORD=your_secure_password \
  -e RW_LICENSE_KEY_PATH=/etc/rconsole/license.jwt \
  -v "$PWD/license.jwt:/etc/rconsole/license.jwt:ro" \
  -v risingwave-console-data:/var/lib/postgresql \
  risingwavelabs/risingwave-console:latest-pgbundle
For Kubernetes, store the key in a Secret and reference it from the Console StatefulSet: 
apiVersion: v1
kind: Secret
metadata:
  name: risingwave-console-license
  namespace: risingwave-console
type: Opaque
stringData:
  license.jwt: <your-signed-license-token>

- name: RW_LICENSE_KEY
  valueFrom:
    secretKeyRef:
      name: risingwave-console-license
      key: license.jwt

​
Upload a Console license in Settings

After signing in, you can upload the RisingWave license key from Settings for Console enterprise access.
  1. Open Settings.
  2. Find Console License.
  3. Paste the signed license key.
  4. Click Upload.
Console validates the key before accepting it. The upload updates the running Console server. For restart-safe rotation, also update the startup license source, such as the mounted file used by RW_LICENSE_KEY_PATH or the Kubernetes Secret used by the Console StatefulSet.

​
Managed RisingWave cluster license key

When Console creates a managed RisingWave cluster in a Kubernetes environment, you can provide the same RisingWave license key in the create-cluster form. Console stores that key in a Kubernetes Secret and references it from the RisingWave custom resource through spec.licenseKey. To set the key during cluster creation:
  1. Open Clusters.
  2. Click Create Cluster.
  3. Select a ready environment.
  4. Enter the cluster name and RisingWave version.
  5. Paste the license key in License key (optional).
  6. Create the cluster.
To update or clear the key after creation:
  1. Open Environments.
  2. Select the environment that owns the cluster.
  3. In the managed clusters area, open the license-key action for the cluster.
  4. Enter a new key and click Save, or click Clear to remove the current key.
Clearing the key removes the spec.licenseKey reference from the RisingWave custom resource and deletes the Kubernetes Secret that held the key.

​
Imported clusters

For imported clusters, Console does not inject a database license key. Configure the license on the RisingWave cluster through your normal deployment method, such as Kubernetes Operator configuration, Helm values, local configuration, or SQL-based license setup.

​
Troubleshooting

SymptomCheck
Console fails to start with no license token providedSet RW_LICENSE_KEY or RW_LICENSE_KEY_PATH in the Console process.
Console rejects a key as invalid or expiredConfirm that the key is signed by RisingWave, has not expired, and is active for the intended organization.
Console says the license does not enable premiumUse a key that includes the premium feature.
Managed cluster still cannot use a premium database featureConfirm the cluster is managed by Console, the license Secret exists in the cluster namespace, and the RisingWave custom resource has spec.licenseKey.secretName and spec.licenseKey.secretKey.
Uploaded Console license is lost after restartUpdate the startup license source as well, such as the mounted file used by RW_LICENSE_KEY_PATH or the Kubernetes Secret used by the Console pod.