Skip to content

Commit 254a2fd

Browse files
authored
Clarify behavior of license expiration (#878)
1 parent 8b65a24 commit 254a2fd

File tree

12 files changed

+74
-41
lines changed

12 files changed

+74
-41
lines changed

modules/console/pages/config/configure-console.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The following YAML file contains a complete list of all Redpanda Console configu
5353
[CAUTION]
5454
====
5555
* Where necessary, ensure that values are enclosed in quotes and escaped. For example, put passwords with special characters in single quotes.
56-
* This configuration file contains both Redpanda Enterprise and Redpanda Community Edition configurations. If you don't provide an Enterprise license, Redpanda Console ignores configurations for enterprise features.
56+
* This configuration file contains both Redpanda Enterprise and Redpanda Community Edition configurations. If you don't provide an enterprise license, Redpanda Console ignores configurations for enterprise features.
5757
====
5858

5959
xref:shared:attachment$redpanda-console-config.yaml[Download the sample file].

modules/get-started/pages/licensing/monitor-license-status.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ If the license is within 30 days of expiration, a warning is logged. `rpk` displ
7171

7272
- *Trial expiration*: When enterprise features are enabled and a trial license expires in less than 15 days.
7373

74-
- *Enterprise expiration*: When enterprise features are enabled and an Enterprise license is expired.
74+
- *Enterprise expiration*: When enterprise features are enabled and an enterprise license is expired.
7575

7676
=== Examples
7777

@@ -131,7 +131,7 @@ Replace `<format>` with one of the available formats. See xref:reference:rpk/rpk
131131

132132
You can also check the status of your license in the Redpanda Console UI. See xref:console:ui/add-license.adoc[].
133133

134-
If Redpanda Console cannot find a valid license either locally or in the connected Redpanda cluster, it shuts down. Redpanda Console tries to load a valid license at startup in the following order:
134+
Redpanda Console tries to load a valid license at startup in the following order:
135135

136136
. From the local configuration file or environment variables.
137137
. From the connected Redpanda cluster (if available).

modules/get-started/pages/licensing/overview.adoc

Lines changed: 53 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,27 +30,39 @@ The Enterprise Edition is licensed with the https://github.com/redpanda-data/red
3030

3131
=== License keys
3232

33-
Enterprise features require an Enterprise Edition license key, sometimes referred to as Enterprise license, license key, or license.
33+
Enterprise features require an Enterprise Edition license key, sometimes referred to as enterprise license, license key, or license.
3434

3535
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.
3636

37-
To get a trial license key or extend your trial period, https://redpanda.com/try-enterprise[generate a new trial license key].
37+
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^].
3838

39-
To purchase a license, contact https://redpanda.com/upgrade[Redpanda Sales^].
39+
[IMPORTANT]
40+
====
41+
Redpanda Connect does not accept trial license keys. To use enterprise features of Redpanda Connect, https://redpanda.com/upgrade[upgrade to Redpanda Enterprise^]
42+
====
4043

4144
[NOTE]
4245
====
4346
include::get-started:partial$licensing/block-upgrades-note.adoc[]
4447
====
4548

4649
[[self-managed]]
47-
=== Enterprise features in Redpanda
50+
=== Redpanda enterprise features
51+
52+
The following table lists the Enterprise features for Redpanda and how Redpanda behaves upon license expiration when each enterprise feature is enabled.
53+
54+
- *Upon license expiration*:
55+
56+
** The cluster continues to operate without data loss, but the further use of enterprise features is restricted (see the <<redpanda-enterprise-features, table 1>>).
57+
** Configuration of enterprise features remains unchanged, allowing you to add a new license and continue using enterprise features as before expiration. For instructions, see xref:get-started:licensing/add-license-redpanda/index.adoc[]
4858

49-
The following table lists the available Enterprise features for Redpanda, along with the restrictions applied if the Enterprise license is invalid or has expired.
59+
- *After license expiration*: You cannot enable enterprise features without a valid license.
5060

61+
[[redpanda-enterprise-features]]
62+
.Enterprise features in Redpanda
5163
[cols="1a,2a,2a"]
5264
|===
53-
| Feature | Description | Restrictions Without Valid License
65+
| Feature | Description | Behavior Upon Expiration
5466

5567
| xref:manage:audit-logging.adoc[Audit Logging]
5668
| 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
6779

6880
| xref:manage:security/fips-compliance.adoc[FIPS Compliance]
6981
| Enables compliance with FIPS security standards for cryptography.
70-
| None
82+
| No change.
7183

72-
| xref:manage:security/authentication.adoc#kerberos[Kerberos authentication]
84+
| xref:manage:security/authentication.adoc#kerberos[Kerberos Authentication]
7385
| Provides secure Kerberos-based authentication.
74-
| None
86+
| No change.
7587

7688
| xref:manage:security/authentication.adoc#kerberos[Leader Pinning]
7789
| Specifies the set of availability zones where the leaders of partitions of a given topic should be located.
7890
| Leader Pinning is disabled on all topics.
7991

80-
| xref:manage:security/authentication.adoc#oidc[OAUTHBEARER/OIDC authentication]
92+
| xref:manage:security/authentication.adoc#oidc[OAUTHBEARER/OIDC Authentication]
8193
| Allows for OAUTHBEARER and OpenID Connect (OIDC) authentication.
82-
| None
94+
| No change.
8395

8496
| xref:manage:remote-read-replicas.adoc[Remote Read Replicas]
8597
| Enables remote clusters to read data stored in object storage for disaster recovery.
@@ -94,23 +106,44 @@ The following table lists the available Enterprise features for Redpanda, along
94106
| Topics with schema validation settings cannot be created or modified.
95107

96108
| xref:manage:tiered-storage.adoc[Tiered Storage]
97-
| Enables storage of data in cloud object storage for long-term retention and retrieval.
98-
| Topics cannot be created or modified to enable Tiered Storage features. Additional partitions cannot be added to topics that have any Tiered Storage properties enabled.
109+
| Enables data storage in cloud object storage for long-term retention and retrieval.
110+
| Topics cannot be created or modified to enable Tiered Storage features. Additional partitions cannot be added to topics with Tiered Storage properties enabled.
99111

100112
|===
101113

102114
[[console]]
103-
=== Enterprise features in Redpanda Console
115+
=== Redpanda Console enterprise features
104116

105117
The following enterprise features for Redpanda Console are activated with a valid Enterprise Edition license key:
106118

107-
* xref:console:config/security/authentication.adoc[Redpanda Console Authentication]
108-
* xref:console:config/security/authorization.adoc[Redpanda Console Authorization (RBAC)]
119+
.Enterprise features in Redpanda Console
120+
[cols="1a,2a,2a"]
121+
|===
122+
| Feature | Description | Restrictions Without Valid License
123+
124+
|xref:console:config/security/authentication.adoc[Redpanda Console Authentication]
125+
|Enables authentication for Redpanda Console, allowing secure access.
126+
|All endpoints are redirected to the license expiration landing page, and all other access is restricted.
127+
128+
|xref:console:config/security/authorization.adoc[Redpanda Console Authorization (RBAC)]
129+
|Manages user roles and permissions for accessing features within Redpanda Console.
130+
|All endpoints are redirected to the license expiration landing page, and all other access is restricted.
131+
|===
109132

110133
[[connect]]
111-
=== Enterprise features in Redpanda Connect
134+
=== Redpanda Connect enterprise features
135+
136+
The Enterprise Edition of Redpanda Connect includes additional connectors. An Enterprise Edition license is required to enable them.
112137

113-
The Enterprise Edition of Redpanda Connect includes additional connectors. For a list of all available connectors, see xref:redpanda-connect:components:catalog.adoc[].
138+
For all available connectors, see xref:redpanda-connect:components:catalog.adoc[].
139+
140+
- *License expires during runtime*: All enterprise features for Redpanda Connect become unavailable.
141+
- *License expired at startup*: Redpanda Connect logs an error message and blocks the use of all enterprise features.
142+
143+
[IMPORTANT]
144+
====
145+
Redpanda Connect does not accept trial license keys. To use enterprise features of Redpanda Connect, https://redpanda.com/upgrade[upgrade to Redpanda Enterprise^]
146+
====
114147

115148
== Manage licenses for Redpanda
116149

@@ -122,11 +155,11 @@ See xref:get-started:licensing/add-license-redpanda/index.adoc[].
122155

123156
Redpanda Console offers two methods for applying or updating a license, depending on your setup:
124157

125-
- If you are using Redpanda Console without connecting it to a Redpanda cluster, you can xref:console:config/enterprise-license.adoc[configure the license through the local configuration file or environment variables]. This method allows you to add a license for Redpanda Console independently of the Redpanda cluster.
158+
- If you use Redpanda Console without connecting it to a Redpanda cluster, you can xref:console:config/enterprise-license.adoc[configure the license through the local configuration file or environment variables]. This method allows you to add a license for Redpanda Console independently of the Redpanda cluster.
126159

127160
- If Redpanda Console is connected to a Redpanda cluster, you can xref:console:ui/add-license.adoc[upload a license through the Redpanda Console UI]. This method allows you to manage and update licenses for both Redpanda Console and the connected Redpanda cluster.
128161

129162
== Next steps
130163

131164
- xref:get-started:licensing/add-license-redpanda/index.adoc[]
132-
- xref:get-started:licensing/monitor-license-status.adoc[]
165+
- xref:get-started:licensing/monitor-license-status.adoc[]

modules/get-started/pages/whats-new.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ This release includes several updates to xref:get-started:licensing/overview.ado
4747

4848
- *Unified license management in Redpanda Console*: You can now upload and apply a single license key for both Redpanda Console and the connected Redpanda cluster through the Redpanda Console UI. Any existing license key is overridden by the new one.
4949

50-
- *30-day trial Enterprise 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.
50+
- *30-day trial enterprise 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.
5151

5252
== PKCS#12 support for TLS listeners
5353

modules/manage/pages/cluster-maintenance/cluster-balancing.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ Redpanda provides partition replica balancing when brokers are added or decommis
2828
|
2929
This balancer moves partition replicas across CPU cores in an individual broker. Redpanda maintains balanced partition replica assignments between cores to avoid topic hotspots on one or a few specific cores within a broker.
3030
+
31-
Continuous Intra-Broker Partition Balancing (`core_balancing_continuous`) requires an xref:get-started:licenses.adoc#redpanda-enterprise-edition[Enterprise license].
31+
Continuous Intra-Broker Partition Balancing (`core_balancing_continuous`) requires an xref:get-started:licenses.adoc#redpanda-enterprise-edition[enterprise license].
3232

3333
| xref:manage:cluster-maintenance/continuous-data-balancing.adoc[Continuous Data Balancing]
3434

3535
|
3636
This balancer monitors broker and rack availability, as well as disk usage, to avoid topic hotspots when moving data off brokers with fuller disks. Continuous Data Balancing enables self-healing clusters that dynamically balance partitions. It also ensures adherence to rack-aware replica placement policy and self-heals after rack (or availability zone) failure or replacement. This balancer does not keep the relative fullness of each broker within a defined range, it just prevents hitting the fullness threshold of each individual broker.
3737
+
38-
Continuous Data Balancing requires an xref:get-started:licenses.adoc#redpanda-enterprise-edition[Enterprise license].
38+
Continuous Data Balancing requires an xref:get-started:licenses.adoc#redpanda-enterprise-edition[enterprise license].
3939
|===
4040

4141

@@ -109,7 +109,7 @@ This is the default setting.
109109
| `continuous`
110110
| Redpanda continuously monitors the cluster for broker failures and high disk usage and automatically redistributes partitions to maintain optimal performance and availability. It also monitors rack availability after failures, and for a given partition, it tries to move excess replicas from racks that have more than one replica to racks where there are none. See xref:./continuous-data-balancing.adoc[Configure Continuous Data Balancing]. +
111111
+
112-
This requires an Enterprise license.
112+
This requires an enterprise license.
113113

114114
| `off`
115115
| All partition balancing from Redpanda is turned off. +
@@ -136,7 +136,7 @@ Configure the following properties to trigger intra-broker partition balancing:
136136
| xref:reference:cluster-properties.adoc#core_balancing_continuous[`core_balancing_continuous`]
137137
a| Set to `true` to rebalance partition assignments across cores in runtime, for example when partitions are moved to or away from brokers. Default value: `false`.
138138

139-
This requires an Enterprise license.
139+
This requires an enterprise license.
140140
|===
141141

142142
You can also manually trigger intra-broker partition balancing with the Admin API:

modules/manage/partials/authentication.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -690,7 +690,7 @@ endif::[]
690690
[[oidc]]
691691
==== OAUTHBEARER (OIDC)
692692

693-
NOTE: OpenID Connect (OIDC) authentication requires an xref:get-started:licenses.adoc[Enterprise license].
693+
NOTE: OpenID Connect (OIDC) authentication requires an xref:get-started:licenses.adoc[enterprise license].
694694
To upgrade, contact https://redpanda.com/try-redpanda?section=enterprise-trial[Redpanda sales^].
695695

696696
When you enable https://openid.net/developers/how-connect-works/[OIDC^], Redpanda and
@@ -971,7 +971,7 @@ ifndef::env-kubernetes[]
971971
[[kerberos]]
972972
==== GSSAPI (Kerberos)
973973

974-
NOTE: Kerberos authentication requires an xref:get-started:licenses.adoc[Enterprise license]. To upgrade, contact https://redpanda.com/try-redpanda?section=enterprise-trial[Redpanda sales^].
974+
NOTE: Kerberos authentication requires an xref:get-started:licenses.adoc[enterprise license]. To upgrade, contact https://redpanda.com/try-redpanda?section=enterprise-trial[Redpanda sales^].
975975

976976
To configure Kerberos authentication, use a keytab, which contains credentials for the service.
977977

modules/reference/pages/properties/cluster-properties.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3394,7 +3394,7 @@ Mode of xref:manage:cluster-maintenance/cluster-balancing.adoc[partition balanci
33943394

33953395
*Accepted values:*
33963396

3397-
* `continuous`: partition balancing happens automatically to maintain optimal performance and availability, based on continuous monitoring for node changes (same as `node_add`) and also high disk usage. This option requires an xref:get-started:licenses.adoc[Enterprise license], and it is customized by <<partition_autobalancing_node_availability_timeout_sec,`partition_autobalancing_node_availability_timeout_sec`>> and <<partition_autobalancing_max_disk_usage_percent,`partition_autobalancing_max_disk_usage_percent`>> properties.
3397+
* `continuous`: partition balancing happens automatically to maintain optimal performance and availability, based on continuous monitoring for node changes (same as `node_add`) and also high disk usage. This option requires an xref:get-started:licenses.adoc[enterprise license], and it is customized by <<partition_autobalancing_node_availability_timeout_sec,`partition_autobalancing_node_availability_timeout_sec`>> and <<partition_autobalancing_max_disk_usage_percent,`partition_autobalancing_max_disk_usage_percent`>> properties.
33983398
* `node_add`: partition balancing happens when a node is added.
33993399
* `off`: partition balancing is disabled. This option is not recommended for production clusters.
34003400

modules/reference/pages/public-metrics-reference.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Number of seconds remaining until the Enterprise Edition license expires.
5555

5656
*Type*: gauge
5757

58-
*Usage*: Use this metric to set up alerts or dashboards to track the license expiration status and ensure timely renewal.
58+
*Usage*: When no license is present, this gauge is -1. When the license is expired, this gauge is 0. Use this metric to set up alerts or dashboards to track the license expiration status and ensure timely renewal.
5959

6060
---
6161

@@ -73,7 +73,7 @@ Number of partition replicas in the cluster that are currently being removed fro
7373

7474
*Type*: gauge
7575

76-
*Usage*: When this gauge is non-zero, determine whether there is an expected or unexpected reassignment of partitions that is causing movement of partition replicas.
76+
*Usage*: When this gauge is non-zero, determine whether there is an expected or unexpected reassignment of partitions causing partition replica movement.
7777

7878
---
7979

modules/shared/attachments/redpanda-console-config.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,16 +169,16 @@ kafka:
169169
#maxRetryInterval: 60s
170170
#backoffMultiplier: 2
171171

172-
# To mount an Enterprise license, set either license or licenseFilepath.
173-
# This is only required if you want to use an Enterprise feature
172+
# To mount an enterprise license, set either license or licenseFilepath.
173+
# This is only required if you want to use an enterprise feature
174174
# such as SSO or RBAC.
175175
# Filepath to your redpanda.license file
176176
#licenseFilepath: ""
177177
# License string.
178178
#license: ""
179179

180180
# The enterprise block contains configurations for features that
181-
# can only be used with a valid Redpanda Enterprise license.
181+
# can only be used with a valid Redpanda enterprise license.
182182
#enterprise:
183183
#rbac:
184184
# Whether or not RBAC is used. This must be enabled
@@ -254,7 +254,7 @@ kafka:
254254
# Login contains all configurations in order to protect Redpanda Console
255255
# with a login screen. To support SSO, configure one or more of the identity
256256
# providers below.
257-
# This feature requires an Enterprise license.
257+
# This feature requires an enterprise license.
258258
#login:
259259
#enabled: false
260260
# jwtSecret is the secret key you must use to sign and encrypt the JSON
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
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^].
1+
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^].
22

3-
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.
3+
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.

0 commit comments

Comments
 (0)