-
Notifications
You must be signed in to change notification settings - Fork 41
DOC-657 Add note about 30-day baked-in trial licenses for Redpanda 24.3 #853
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.
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
Merged
Merged
Changes from 28 commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
2caf0c6
Update config for new beta
Deflaimun c3ffdd4
update with rpk 24.3.1-rc1 (#819)
Deflaimun 58e0bff
DOC-502 License enforcement updates (#813)
JakeSCahill 121d5f4
Properties 24 3 (#822)
Deflaimun 19c0ec1
Add User resource docs (#773)
JakeSCahill fce336b
Leader pinning (#809)
kbatuigas 3e93983
DOC-287 Mountable TS topics (#725)
kbatuigas 03d3e60
Update with latest rpk commands from v0.0.0-20241104git4a0f859 (#835)
Deflaimun 41bfe40
what's new in 24.3 beta (#811)
micheleRP afba214
Force-update fallback 24.3-rc2
Deflaimun 488c9f6
Michele rp patch 1 (#837)
micheleRP 67c90f5
DOC-470 Debug bundle in Redpanda Console (#825)
JakeSCahill 16e9cda
add Tombstone property (#847)
Deflaimun 58ded83
Tombstone retention (#829)
kbatuigas 1b2ad07
Add note about 45-day baked-in trial licenses for Redpanda 24.3
JakeSCahill cd736ac
Apply suggestions from code review
JakeSCahill 1e5f9de
Add Leader Pinning to enterprise list and address feedback
JakeSCahill ddbe343
Doc-476 - Backfill partitioning update (#842)
Feediver1 183d021
Doc 2599 - Configure Redpanda with a Customer-Managed Key (#808)
Feediver1 1b5614d
Update modules/get-started/pages/licensing/overview.adoc
JakeSCahill 0cf4b28
DOC-759 fix link (#866)
micheleRP 37f0a24
Merge branch 'v-WIP/24.3' into DOC-657
Feediver1 8457507
Apply suggestions from code review
JakeSCahill e5e936f
Merge branch 'v-WIP/24.3' into DOC-657
JakeSCahill 7b441a1
Add note about upgrade restrictions
JakeSCahill c933dfb
More rpk examples and how to disable enterprise
JakeSCahill e8c7bc6
Merge branch 'v-WIP/24.3' into DOC-657
JakeSCahill 4ced649
consistency
JakeSCahill 775b73c
Apply suggestions from review
JakeSCahill 126795c
Apply suggestions from review
JakeSCahill 8b60146
Update monitor-license-status.adoc
JakeSCahill 1d1fc55
Update monitor-license-status.adoc
JakeSCahill e7438cb
Update disable-enterprise-features.adoc
JakeSCahill 7bef54d
Update whats-new.adoc
JakeSCahill f2b3ed6
Merge branch 'v-WIP/24.3' into DOC-657
JakeSCahill File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
170 changes: 170 additions & 0 deletions
170
modules/get-started/pages/licensing/disable-enterprise-features.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,170 @@ | ||
= Disable Enterprise Features in Redpanda | ||
:description: Disable specific enterprise features in Redpanda to ensure your cluster operates within the scope of the Community Edition without enterprise features. | ||
|
||
Enterprise features in Redpanda are available only in the Enterprise Edition and require a valid license. If your cluster has enterprise features enabled without a valid license, it is essential to either upload a valid license or disable these features to maintain compliance with Redpanda licensing terms. | ||
|
||
== Prerequisites | ||
|
||
Before you begin, consider the following: | ||
|
||
- Take a backup of your current configuration to allow rollback if needed. | ||
|
||
- Disabling enterprise features may affect cluster performance, security, or functionality. Test these changes in a staging environment before applying them to production. | ||
|
||
- If you need enterprise features, consider purchasing a valid license to continue using them. To get a trial license key or extend your trial period, https://redpanda.com/try-enterprise[generate a new trial license key^]. To purchase a license, contact https://redpanda.com/upgrade[Redpanda Sales^]. | ||
|
||
== Check for enterprise features in violation | ||
|
||
To check the status of your license, use the `rpk cluster license info` command. This command provides a detailed overview of your Redpanda license, including whether your cluster has enterprise features enabled without a valid license. | ||
|
||
[NOTE] | ||
==== | ||
This command reports license violations only if enterprise features in Redpanda are enabled without a valid license. It does not report license violations for enterprise features in xref:get-started:licensing/overview.adoc#connect[Redpanda Connect] or xref:get-started:licensing/overview.adoc#console[Redpanda Console]. | ||
==== | ||
|
||
. Ensure that xref:get-started:rpk-install.adoc[`rpk` is installed] and configured to connect to your cluster's Admin API endpoint. | ||
|
||
. Get the details about your cluster's license: | ||
+ | ||
[,bash] | ||
---- | ||
rpk cluster license info | ||
---- | ||
+ | ||
If the `License violation` status is `true`, you must either obtain a valid license or disable the enterprise features in use to ensure compliance. | ||
+ | ||
If the license is within 30 days of expiration, a warning is logged: | ||
+ | ||
[.no-copy] | ||
---- | ||
warning: your license will expire soon | ||
---- | ||
|
||
== Disable enterprise features | ||
|
||
To disable specific enterprise features, refer to the following table: | ||
|
||
[NOTE] | ||
==== | ||
These instructions apply to bare-metal deployments on Linux. If you are running Redpanda in a different environment, such as Kubernetes or Docker, the way you disable features may vary. | ||
==== | ||
|
||
[cols="1a,2a"] | ||
|=== | ||
| Feature | Action to Disable | ||
|
||
| xref:manage:audit-logging.adoc[Audit Logging] | ||
| | ||
Set the cluster config `audit_enabled` to `false`: | ||
|
||
[,bash] | ||
---- | ||
rpk cluster config set audit_enabled false | ||
---- | ||
|
||
| xref:manage:cluster-maintenance/continuous-data-balancing.adoc[Continuous Data Balancing] | ||
| | ||
Set the cluster config `partition_autobalancing_mode` to `node_add`: | ||
|
||
[,bash] | ||
---- | ||
rpk cluster config set partition_autobalancing_mode node_add | ||
---- | ||
|
||
| xref:manage:cluster-maintenance/cluster-balancing.adoc#intra-broker-partition-balancing[Continuous Intra-Broker Partition Balancing] | ||
(`core_balancing_continuous`) | ||
| | ||
Set the cluster config `core_balancing_continuous` to `false`: | ||
|
||
[,bash] | ||
---- | ||
rpk cluster config set core_balancing_continuous false | ||
---- | ||
|
||
| xref:manage:security/fips-compliance.adoc[FIPS Compliance] | ||
| | ||
Set the node config `fips_mode` to `disabled`: | ||
|
||
[,bash] | ||
---- | ||
rpk node config set fips_mode disabled | ||
---- | ||
|
||
| xref:manage:security/authentication.adoc#kerberos[Kerberos authentication] | ||
| | ||
Remove `GSSAPI` from the cluster config `sasl_mechanisms`: | ||
|
||
[,bash] | ||
---- | ||
rpk cluster config set sasl_mechanisms <other-mechanisms> | ||
---- | ||
|
||
| xref:manage:security/authentication.adoc#kerberos[Leader Pinning] | ||
| | ||
Set `default_leaders_preference` to `none`: | ||
|
||
[,bash] | ||
---- | ||
rpk cluster config set default_leaders_preference none | ||
---- | ||
|
||
| xref:manage:security/authentication.adoc#oidc[OAUTHBEARER/OIDC authentication] | ||
| | ||
Remove `OIDC` from the cluster config `sasl_mechanisms` and `http_authentication`: | ||
[,bash] | ||
---- | ||
rpk cluster config set sasl_mechanisms <other-mechanisms> | ||
rpk cluster config set http_authentication <other-mechanisms> | ||
---- | ||
|
||
| xref:manage:remote-read-replicas.adoc[Remote Read Replicas] | ||
| | ||
Set the cluster config `cloud_storage_enable_remote_read` to `false`: | ||
|
||
[,bash] | ||
---- | ||
rpk cluster config set cloud_storage_enable_remote_read false | ||
---- | ||
|
||
| xref:manage:security/authorization/rbac.adoc[Role-Based Access Control (RBAC)] | ||
| | ||
Use `rpk security role delete` to delete all configured roles: | ||
|
||
[,bash] | ||
---- | ||
rpk security role list | ||
rpk security role delete <role-name> | ||
---- | ||
|
||
| xref:manage:schema-reg/schema-id-validation.adoc[Server-Side Schema ID Validation] | ||
| | ||
Set the cluster config `enable_schema_id_validation` to `false`: | ||
|
||
[,bash] | ||
---- | ||
rpk cluster config set enable_schema_id_validation false | ||
---- | ||
|
||
| xref:manage:tiered-storage.adoc[Tiered Storage] | ||
| | ||
Set the cluster config `cloud_storage_enabled` to `false`: | ||
|
||
[,bash] | ||
---- | ||
rpk cluster config set cloud_storage_enabled false | ||
---- | ||
|
||
|=== | ||
|
||
== Verify the license status | ||
|
||
When all required changes are made, confirm that the `license violation` status is now `false`. | ||
|
||
[,bash] | ||
---- | ||
rpk cluster license info | ||
---- | ||
|
||
== Suggested reading | ||
|
||
For more information about licensing, see xref:get-started:licensing/overview.adoc[]. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JakeSCahill this warning section seems perhaps a bit out of place and the message is not accurate, though we should have it somewhere within the licensing docs
The warning behavior depends on the type of license and shows up in more places for TRIAL than for enterprise.
All the details of the behavior and final messages are here: https://redpandadata.atlassian.net/wiki/spaces/product/pages/924516359/Community+Monetization+CTAs+License+UX#RPK