feat: introduce license manager and feature tiers #17396

BugenZhao · 2024-06-21T09:55:48Z

Signed-off-by: Bugen Zhao [email protected]I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

Introduce LicenseManager and feature tiers roughly based on the design in the doc.

A license key is a JWT (JSON Web Token) encoding information like tier and expiration time, of which the integrity can be validated with asymmetric encryption.

The license key is made a system parameter, which can be set through ALTER SYSTEM SET license_key TO .. in runtime or config.toml on the very-first startup of the cluster. Whenever the key is changed, it'll be propagated to all components in the cluster and get refreshed. The reason for not making it something static (like env var) is due to concerns on expiration of the license key. By allowing it to be updated online, users don't have to suspend the service when renewing the license.

Certain enterprise features may be restricted to specific tiers. This can be done by adding a new entry to the macro for_all_features, then check it during runtime with Feature::Foo.check_available()?. Complete guidelines are included in the source file as documentation.

To simplify testing, a license key with tier Paid is set by default in debug mode, so that all features should be available without any other configuration. This is okay because the issuer in the key specifies that the key is for testing purposes only and will be rejected in production.

The test case error_ui/simple/license.slt shows the behavior when a paid feature is called under different circumstances.

Checklist

I have written necessary rustdoc comments
I have added necessary unit tests and integration tests
All checks passed in ./risedev check (or alias, ./risedev c)

Documentation

My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

This PR introduces a new system parameter of license_key that can be set to enable some enterprise features in the future.

Besides, this PR introduces a new SQL function SELECT rw_test_paid_tier(); that checks whether the current deployment has the paid tier access. Please refer users to the enterprise feature tier document for details. If the user is using a valid license key, the result will be 't' (true). Otherwise, this function will return an error.

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

Signed-off-by: Bugen Zhao <[email protected]>

github-actions

license-eye has totally checked 5147 files.

Valid	Invalid	Ignored	Fixed
2198	1	2948	0

Click to see the invalid file list

src/common/src/license.rs

src/common/src/license.rs

Signed-off-by: Bugen Zhao <[email protected]>

fuyufjh

Generally LGTM!

src/frontend/src/binder/expr/function.rs

fuyufjh · 2024-06-25T08:09:09Z

src/common/src/license/key.pub

How about storing the private key in a saparated git repo?

I'm still considering the options. One is to store the private key directly in a private repository, while another option is to not expose the key at all but only provide the keygen utility (like a web app) behind some sort of authentication within our organization.

fuyufjh · 2024-06-25T08:13:45Z

src/common/src/license/manager.rs

+            #[cfg(debug_assertions)]
+            "test.risingwave.com",


So test.risingwave.com only works for debug builds. IIUC, the tests using release build (such as the main-cron and benchmarks) will need to set up a prod.risingwave.com license to run, right?

You're right. We should

either generate a prod key and set them for benchmarks (with potential risk of leaking it)

or use a better compiler flag to distinguish between test/development build and production build, which we don't have now AFAIK

Do you have any preference or other ideas? Also cc @xxchan

BTW, ci-release profile is used in main-cron, which enables debug assertions.

Also related #17456 (comment)

or use a better compiler flag to distinguish between test/development build and production build, which we don't have now AFAIK

You reminds me of this: https://github.com/tikv/tikv/blob/master/etc/cargo.config.dist "really prod/dist config" (e.g., fat LTO) vs "release/bench" config. I also wanted a "release without LTO" before, because LTO compiles for too long. 🤣

Anyway, I feel generate a prod key for benchmark is enough. And we can manage it in test env like AWS secrets.

You reminds me of this: tikv/tikv@master/etc/cargo.config.dist "really prod/dist config" (e.g., fat LTO) vs "release/bench" config. I also wanted a "release without LTO" before, because LTO compiles for too long. 🤣

True. The problem is that we don't currently distinguish between production and bench builds. So we have to either refactor the benchmark pipeline to use another set of images, or provide runtime functionality to switch between them, which is certainly unsafe.

Anyway, I feel generate a prod key for benchmark is enough.

Okay.

src/license/src/manager.rs

src/common/src/system_param/common.rs

neverchanje

The user interface LGTM.

Signed-off-by: Bugen Zhao <[email protected]>

src/common/Cargo.toml

xxchan

👍

xxchan · 2024-06-26T06:10:36Z

src/license/src/manager.rs

+}
+
+static PUBLIC_KEY: LazyLock<DecodingKey> = LazyLock::new(|| {
+    DecodingKey::from_rsa_pem(include_bytes!("key.pub"))


nit: Can we inline the file key.pub?

xxchan · 2024-06-26T06:24:12Z

src/common/src/license/manager.rs

+            #[cfg(debug_assertions)]
+            "test.risingwave.com",


or use a better compiler flag to distinguish between test/development build and production build, which we don't have now AFAIK

You reminds me of this: https://github.com/tikv/tikv/blob/master/etc/cargo.config.dist "really prod/dist config" (e.g., fat LTO) vs "release/bench" config. I also wanted a "release without LTO" before, because LTO compiles for too long. 🤣

Anyway, I feel generate a prod key for benchmark is enough. And we can manage it in test env like AWS secrets.

Co-authored-by: xxchan <[email protected]>

Signed-off-by: Bugen Zhao <[email protected]>

WanYixian · 2024-09-04T05:29:29Z

Hi @BugenZhao, wanna a double check, on the very-first startup of the cluster, would there be a prompt to remind user to specify the license file location? Thanks

BugenZhao · 2024-09-04T05:51:54Z

Hi @BugenZhao, wanna a double check, on the very-first startup of the cluster, would there be a prompt to remind user to specify the license file location? Thanks

No.

Also it's not to provide a license file. Users can specify the license key content in following ways:

before launching a fresh cluster
- through system.license_key in the TOML configuration
- through RW_LICENSE_KEY env var
after the cluster is initialized, through SQL interface with ALTER SYSTEM SET license_key TO '..' online

WanYixian · 2024-09-04T05:58:13Z

Hi @BugenZhao, wanna a double check, on the very-first startup of the cluster, would there be a prompt to remind user to specify the license file location? Thanks

No.

Also it's not to provide a license file. Users can specify the license key content in following ways:

before launching a fresh cluster

through system.license_key in the TOML configuration

through RW_LICENSE_KEY env var

after the cluster is initialized, through SQL interface with ALTER SYSTEM SET license_key TO '..' online

Good to know and I'll add this info into doc

BugenZhao added 2 commits June 21, 2024 16:45

add license manager

d1f7974

Signed-off-by: Bugen Zhao <[email protected]>

refine

209fd32

Signed-off-by: Bugen Zhao <[email protected]>

github-actions bot added the type/feature label Jun 21, 2024

github-actions bot reviewed Jun 21, 2024

View reviewed changes

src/common/src/license.rs Outdated Show resolved Hide resolved

BugenZhao added 5 commits June 24, 2024 15:23

resolve todos and refine docs

c8a568c

Signed-off-by: Bugen Zhao <[email protected]>

reorganize files

27b351e

Signed-off-by: Bugen Zhao <[email protected]>

add more docs

ba375db

Signed-off-by: Bugen Zhao <[email protected]>

switch to rs256

1a9f8ac

Signed-off-by: Bugen Zhao <[email protected]>

add tests

90e7eff

Signed-off-by: Bugen Zhao <[email protected]>

BugenZhao force-pushed the bz/license branch from 91a3ef2 to 90e7eff Compare June 24, 2024 09:51

add more todos

80f9138

Signed-off-by: Bugen Zhao <[email protected]>

BugenZhao changed the title ~~feat: introduce license manager and feature tiers~~ feat: introduce license manager and feature tiers [WIP] Jun 24, 2024

BugenZhao marked this pull request as ready for review June 24, 2024 10:01

BugenZhao requested a review from a team as a code owner June 24, 2024 10:01

BugenZhao added 4 commits June 25, 2024 13:43

refine more docs

3b07f9e

Signed-off-by: Bugen Zhao <[email protected]>

use issuer for testing and use default system param

9d934f0

Signed-off-by: Bugen Zhao <[email protected]>

add more unit tests

d8dea8d

Signed-off-by: Bugen Zhao <[email protected]>

update e2e tests

0d608e7

Signed-off-by: Bugen Zhao <[email protected]>

BugenZhao force-pushed the bz/license branch from 312196c to 0d608e7 Compare June 25, 2024 07:30

BugenZhao added 3 commits June 25, 2024 15:38

rename key

88670e3

Signed-off-by: Bugen Zhao <[email protected]>

refine tests

870d924

Signed-off-by: Bugen Zhao <[email protected]>

fix tests

383c702

Signed-off-by: Bugen Zhao <[email protected]>

BugenZhao requested review from hzxa21 and fuyufjh June 25, 2024 07:53

BugenZhao changed the title ~~feat: introduce license manager and feature tiers [WIP]~~ feat: introduce license manager and feature tiers Jun 25, 2024

fuyufjh requested a review from neverchanje June 25, 2024 08:02

split into crates

33a741d

Signed-off-by: Bugen Zhao <[email protected]>

fuyufjh approved these changes Jun 25, 2024

View reviewed changes

neverchanje reviewed Jun 25, 2024

View reviewed changes

fix fmt and skip typos check

05dc04d

Signed-off-by: Bugen Zhao <[email protected]>

BugenZhao added the user-facing-changes Contains changes that are visible to users label Jun 25, 2024

BugenZhao added 2 commits June 25, 2024 17:28

refine tracing and test_paid_tier function doc

b12d23b

Signed-off-by: Bugen Zhao <[email protected]>

refine todo comments

a562042

Signed-off-by: Bugen Zhao <[email protected]>

BugenZhao mentioned this pull request Jun 25, 2024

Tracking: license manager and feature tiers #17446

Open

7 tasks

update docs

121b989

Signed-off-by: Bugen Zhao <[email protected]>

stdrc self-requested a review June 26, 2024 02:41

xxchan self-requested a review June 26, 2024 03:30

xxchan mentioned this pull request Jun 26, 2024

feat(secret): introduce secret management #17456

Merged

9 tasks

xxchan reviewed Jun 26, 2024

View reviewed changes

src/common/Cargo.toml Outdated Show resolved Hide resolved

xxchan reviewed Jun 26, 2024

View reviewed changes

BugenZhao mentioned this pull request Jun 26, 2024

better way to differentiate development and production builds #17465

Open

BugenZhao and others added 2 commits June 26, 2024 15:51

Update src/common/Cargo.toml

87994bf

Co-authored-by: xxchan <[email protected]>

update cargo.lock

d6fe5ae

Signed-off-by: Bugen Zhao <[email protected]>

BugenZhao enabled auto-merge June 27, 2024 03:36

BugenZhao added this pull request to the merge queue Jun 27, 2024

Merged via the queue into main with commit 855251c Jun 27, 2024
33 checks passed

BugenZhao deleted the bz/license branch June 27, 2024 04:36

fuyufjh mentioned this pull request Sep 3, 2024

feat: support license risingwavelabs/risingwave-operator#709

Merged

2 tasks

BugenZhao mentioned this pull request Sep 18, 2024

risingwave 2.0.0 risingwavelabs/homebrew-risingwave#44

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: introduce license manager and feature tiers #17396

feat: introduce license manager and feature tiers #17396

BugenZhao commented Jun 21, 2024 •

edited

Loading

github-actions bot left a comment

fuyufjh left a comment

fuyufjh Jun 25, 2024

BugenZhao Jun 25, 2024

fuyufjh Jun 25, 2024

BugenZhao Jun 25, 2024

yuhao-su Jun 26, 2024

xxchan Jun 26, 2024

BugenZhao Jun 26, 2024

neverchanje left a comment

xxchan left a comment

xxchan Jun 26, 2024

xxchan Jun 26, 2024

WanYixian commented Sep 4, 2024 •

edited

Loading

BugenZhao commented Sep 4, 2024

WanYixian commented Sep 4, 2024

feat: introduce license manager and feature tiers #17396

feat: introduce license manager and feature tiers #17396

Conversation

BugenZhao commented Jun 21, 2024 • edited Loading

What's changed and what's your intention?

Checklist

Documentation

Release note

github-actions bot left a comment

Choose a reason for hiding this comment

fuyufjh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neverchanje left a comment

Choose a reason for hiding this comment

xxchan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WanYixian commented Sep 4, 2024 • edited Loading

BugenZhao commented Sep 4, 2024

WanYixian commented Sep 4, 2024

BugenZhao commented Jun 21, 2024 •

edited

Loading

WanYixian commented Sep 4, 2024 •

edited

Loading