Skip to content

Commit

Permalink
Doc CLI option for license key (#49)
Browse files Browse the repository at this point in the history
* Update rw-premium-edition-intro.mdx

* adjust structure

* rename
  • Loading branch information
WanYixian authored Nov 20, 2024
1 parent 286f40e commit 75c9f1b
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion get-started/rw-premium-edition-intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,11 @@ The Premium Edition features are only available to users who have purchased a li

### Set license key

To set your license key:
There are two primary methods for setting the license key in your environment:

#### Manual method

To set your license key manually:

1. Before launching a new cluster:
* Add `system.license_key` to your TOML configuration file, or
Expand All @@ -48,6 +52,15 @@ To set your license key:
ALTER SYSTEM SET license_key TO '...';
```

#### Automated method

To set your license key automatically:

1. Use the `--license-key-path` CLI option for the meta node to monitor and reload the license key from a specified file. This streamlines license key rotation in Cloud environments.
2. Alternatively, set the `RW_LICENSE_KEY_PATH` environment variable.

The `--license-key-path` CLI option is only available for the meta node, as the license key is propagated to other nodes through system parameters. When the `--license-key-path` option is specified, any manual configuration of the license key through system parameters (`license_key`), the initial configuration (`system.license_key`), or the `RW_LICENSE_KEY` environment variable will be rejected.

### Verify license key

To check if your license key is valid, run:
Expand All @@ -58,6 +71,9 @@ SELECT rw_test_paid_tier();

A result of `t` means the key is valid; an error message indicates an invalid key.




## Support

RisingWave Premium edition offers the premium support:
Expand Down

0 comments on commit 75c9f1b

Please sign in to comment.