-
Notifications
You must be signed in to change notification settings - Fork 47
Clarify behavior of license expiration #878
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 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
77a0281
Clarify behavior of license expiration
JakeSCahill dfc1e58
Update public-metrics-reference.adoc
JakeSCahill f39f1c2
Clarify behavior after/upon expiration
JakeSCahill 6aea314
Merge branch 'v-WIP/24.3' into license-update
JakeSCahill 3b43f0b
Add license behavior for RPCN
JakeSCahill c1efb6a
Apply suggestions from code review
JakeSCahill d84a071
Update overview.adoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,27 +30,39 @@ The Enterprise Edition is licensed with the https://github.com/redpanda-data/red | |
|
|
||
| === License keys | ||
|
|
||
| Enterprise features require an Enterprise Edition license key, sometimes referred to as Enterprise license, license key, or license. | ||
| Enterprise features require an Enterprise Edition license key, sometimes referred to as enterprise license, license key, or license. | ||
|
|
||
| Starting with version 24.3, new Redpanda clusters automatically receive a trial license that's valid for 30 days, allowing unrestricted use of enterprise features. This evaluation period begins when the cluster is created for the first time. After this period expires, inactive enterprise features are disabled, and active features enter a restricted state. | ||
|
|
||
| To get a trial license key or extend your trial period, https://redpanda.com/try-enterprise[generate a new trial license key]. | ||
| To get a trial license key or extend your trial period, https://redpanda.com/try-enterprise[generate a new trial license key]. Or, https://redpanda.com/upgrade[upgrade to Redpanda Enterprise^]. | ||
|
|
||
| To purchase a license, contact https://redpanda.com/upgrade[Redpanda Sales^]. | ||
| [IMPORTANT] | ||
| ==== | ||
| Redpanda Connect does not accept trial license keys. To use enterprise features of Redpanda Connect, https://redpanda.com/upgrade[upgrade to Redpanda Enterprise^] | ||
| ==== | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| include::get-started:partial$licensing/block-upgrades-note.adoc[] | ||
| ==== | ||
|
|
||
| [[self-managed]] | ||
| === Enterprise features in Redpanda | ||
| === Redpanda enterprise features | ||
|
|
||
| The following table lists the Enterprise features for Redpanda, along with how Redpanda behaves when each enterprise feature is enabled and the license expires. | ||
|
|
||
| - *Upon license expiration*: | ||
|
|
||
| ** The cluster continues to operate without data loss, but further use of enterprise features is restricted (see the <<redpanda-enterprise-features, table>>). | ||
| ** Configuration of enterprise features remains unchanged, allowing you to apply a new license and resume the use of enterprise features as they were before expiration. For instructions, see xref:get-started:licensing/add-license-redpanda/index.adoc[] | ||
|
|
||
| The following table lists the available Enterprise features for Redpanda, along with the restrictions applied if the Enterprise license is invalid or has expired. | ||
| - *After license expiration*: You cannot enable any enterprise features without a valid license. | ||
|
|
||
| [[redpanda-enterprise-features]] | ||
| .Enterprise features in Redpanda | ||
| [cols="1a,2a,2a"] | ||
| |=== | ||
| | Feature | Description | Restrictions Without Valid License | ||
| | Feature | Description | Behavior Upon Expiration | ||
|
|
||
| | xref:manage:audit-logging.adoc[Audit Logging] | ||
| | Records detailed logs of cluster activities for compliance and monitoring. | ||
|
|
@@ -67,19 +79,19 @@ The following table lists the available Enterprise features for Redpanda, along | |
|
|
||
| | xref:manage:security/fips-compliance.adoc[FIPS Compliance] | ||
| | Enables compliance with FIPS security standards for cryptography. | ||
| | None | ||
| | No change | ||
JakeSCahill marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | xref:manage:security/authentication.adoc#kerberos[Kerberos authentication] | ||
|
||
| | Provides secure Kerberos-based authentication. | ||
| | None | ||
| | No change | ||
JakeSCahill marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | xref:manage:security/authentication.adoc#kerberos[Leader Pinning] | ||
| | Specifies the set of availability zones where the leaders of partitions of a given topic should be located. | ||
| | Leader Pinning is disabled on all topics. | ||
|
|
||
| | xref:manage:security/authentication.adoc#oidc[OAUTHBEARER/OIDC authentication] | ||
| | Allows for OAUTHBEARER and OpenID Connect (OIDC) authentication. | ||
| | None | ||
| | No change | ||
JakeSCahill marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | xref:manage:remote-read-replicas.adoc[Remote Read Replicas] | ||
| | Enables remote clusters to read data stored in object storage for disaster recovery. | ||
|
|
@@ -100,17 +112,38 @@ The following table lists the available Enterprise features for Redpanda, along | |
| |=== | ||
|
|
||
| [[console]] | ||
| === Enterprise features in Redpanda Console | ||
| === Redpanda Console enterprise features | ||
|
|
||
| The following enterprise features for Redpanda Console are activated with a valid Enterprise Edition license key: | ||
|
|
||
| * xref:console:config/security/authentication.adoc[Redpanda Console Authentication] | ||
| * xref:console:config/security/authorization.adoc[Redpanda Console Authorization (RBAC)] | ||
| .Enterprise features in Redpanda Console | ||
| [cols="1a,2a,2a"] | ||
| |=== | ||
| | Feature | Description | Restrictions Without Valid License | ||
|
|
||
| |xref:console:config/security/authentication.adoc[Redpanda Console Authentication] | ||
| |Enables authentication for Redpanda Console, allowing secure access for users. | ||
| |All endpoints are redirected to the license expiration landing page, and all other access is restricted. | ||
|
|
||
| |xref:console:config/security/authorization.adoc[Redpanda Console Authorization (RBAC)] | ||
| |Manages user roles and permissions for accessing features within Redpanda Console. | ||
| |All endpoints are redirected to the license expiration landing page, and all other access is restricted. | ||
| |=== | ||
|
|
||
| [[connect]] | ||
| === Enterprise features in Redpanda Connect | ||
| === Redpanda Connect enterprise features | ||
|
|
||
| The Enterprise Edition of Redpanda Connect includes additional connectors. An Enterprise Edition license is required to enable them. | ||
|
|
||
| The Enterprise Edition of Redpanda Connect includes additional connectors. For a list of all available connectors, see xref:redpanda-connect:components:catalog.adoc[]. | ||
| For a list of all available connectors, see xref:redpanda-connect:components:catalog.adoc[]. | ||
|
|
||
| - *License expires during runtime*: All enterprise features for Redpanda Connect become unavailable. | ||
| - *License expired at startup*: Redpanda Connect logs an error message and blocks the use of all enterprise features. | ||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| Redpanda Connect does not accept trial license keys. To use enterprise features of Redpanda Connect, https://redpanda.com/upgrade[upgrade to Redpanda Enterprise^] | ||
| ==== | ||
|
|
||
| == Manage licenses for Redpanda | ||
|
|
||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| This feature requires an xref:get-started:licenses.adoc[Enterprise license]. 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^]. | ||
| This feature requires an xref:get-started:licenses.adoc[enterprise license]. 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^]. | ||
|
|
||
| If Redpanda Console has enterprise features enabled and it cannot find a valid license either in its xref:console:config/enterprise-license.adoc[local configuration] or in the xref:get-started:licensing/add-license-redpanda/index.adoc[connected Redpanda cluster], it shuts down. | ||
| If Redpanda Console has enterprise features enabled and it cannot find a valid license either in its xref:console:config/enterprise-license.adoc[local configuration] or in the xref:get-started:licensing/add-license-redpanda/index.adoc[connected Redpanda cluster], it redirects you to the license expiration landing page, and all other access is restricted. |
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 |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| This feature requires an xref:get-started:licenses.adoc[Enterprise license]. 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^]. | ||
| This feature requires an xref:get-started:licenses.adoc[enterprise license]. 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^]. | ||
|
|
||
| If Redpanda has enterprise features enabled and it cannot find a valid license, xref:get-started:licenses.adoc#self-managed[restrictions] apply. |
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
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.
Uh oh!
There was an error while loading. Please reload this page.