Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc CLI option for license key #49

Merged
merged 3 commits into from
Nov 20, 2024
Merged

Doc CLI option for license key #49

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5d2180
Update rw-premium-edition-intro.mdx
WanYixian Nov 13, 2024
a01bddb
adjust structure
WanYixian Nov 14, 2024
27c70c1
rename
WanYixian Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion get-started/rw-premium-edition-intro.mdx
View file
Open in desktop
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