Skip to content

Commit 1e54b6b

Browse files
JakeSCahillDeflaimunFeediver1pgellertasimms41
authored
DOC-657 Add note about 30-day baked-in trial licenses for Redpanda 24.3 (#853)
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Joyce Fee <[email protected]> Co-authored-by: Gellért Peresztegi-Nagy <[email protected]> Co-authored-by: Angela Simms <[email protected]> Co-authored-by: Kat Batuigas <[email protected]> Co-authored-by: Michele Cyran <[email protected]>
1 parent 4f3a993 commit 1e54b6b

File tree

18 files changed

+413
-160
lines changed

18 files changed

+413
-160
lines changed

modules/ROOT/nav.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@
1010
*** xref:console:quickstart.adoc[Redpanda Console]
1111
** xref:get-started:licensing/index.adoc[Redpanda Licensing]
1212
*** xref:get-started:licensing/overview.adoc[Editions and Enterprise Features]
13-
*** xref:get-started:licensing/add-license-redpanda/index.adoc[Add an Enterprise License]
13+
*** xref:get-started:licensing/add-license-redpanda/index.adoc[Add License]
1414
**** xref:get-started:licensing/add-license-redpanda/linux.adoc[Linux]
1515
**** xref:get-started:licensing/add-license-redpanda/kubernetes.adoc[Kubernetes]
1616
**** xref:console:ui/add-license.adoc[Redpanda Console]
17-
*** xref:get-started:licensing/monitor-license-status.adoc[Monitor Enterprise Licenses]
17+
*** xref:get-started:licensing/monitor-license-status.adoc[Check Status]
18+
*** xref:get-started:licensing/disable-enterprise-features.adoc[Disable Enterprise Features]
1819
** xref:get-started:rpk/index.adoc[Redpanda CLI]
1920
*** xref:get-started:intro-to-rpk.adoc[Introduction to rpk]
2021
*** xref:get-started:rpk-install.adoc[]

modules/console/pages/config/enterprise-license.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ TIP: Redpanda Console can also load the license key from a connected Redpanda cl
77

88
== Prerequisites
99

10-
You must have an Enterprise Edition license. If you don't have a license yet, https://www.redpanda.com/contact[request one^].
10+
You must have an Enterprise Edition 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^].
1111

1212
If Redpanda Console has enterprise features enabled and cannot find a valid license locally or in the connected Redpanda cluster, it shuts down. See xref:get-started:licensing/overview.adoc[].
1313

modules/develop/pages/produce-data/leader-pinning.adoc

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,45 @@
11
= Leader Pinning
22
// tag::single-source[]
3-
:description: Learn about leader pinning and how to configure a preferred partition leader location based on cloud availability zones or regions.
4-
5-
Produce requests that write data to Redpanda topics go through the topic partition leader, which syncs messages across its follower replicas. For a Redpanda cluster deployed across multiple availability zones (AZs), leader pinning ensures that a topic's partition leaders are geographically closer to clients, which helps decrease networking costs and guarantees lower latency.
6-
7-
If consumers are located in the same preferred region or AZ for leader pinning, and you have not set up xref:develop:consume-data/follower-fetching.adoc[follower fetching], leader pinning can also help reduce networking costs on consume requests.
8-
9-
== Prerequisites
3+
:description: Learn about Leader Pinning and how to configure a preferred partition leader location based on cloud availability zones or regions.
104

115
[NOTE]
126
====
137
include::shared:partial$enterprise-license.adoc[]
148
====
159

16-
Before you can enable leader pinning, you must xref:manage:rack-awareness.adoc#configure-rack-awareness[configure rack awareness] on the cluster. If the config_ref:enable_rack_awareness,true,properties/cluster-properties[] cluster configuration property is set to `false`, leader pinning is disabled across the cluster.
10+
Produce requests that write data to Redpanda topics go through the topic partition leader, which syncs messages across its follower replicas. For a Redpanda cluster deployed across multiple availability zones (AZs), Leader Pinning ensures that a topic's partition leaders are geographically closer to clients, which helps decrease networking costs and guarantees lower latency.
11+
12+
If consumers are located in the same preferred region or AZ for Leader Pinning, and you have not set up xref:develop:consume-data/follower-fetching.adoc[follower fetching], Leader Pinning can also help reduce networking costs on consume requests.
13+
14+
== Prerequisites
15+
16+
Before you can enable Leader Pinning, you must xref:manage:rack-awareness.adoc#configure-rack-awareness[configure rack awareness] on the cluster. If the config_ref:enable_rack_awareness,true,properties/cluster-properties[] cluster configuration property is set to `false`, Leader Pinning is disabled across the cluster.
17+
18+
== Configure Leader Pinning
1719

18-
== Configure leader pinning
20+
You can use both a topic configuration property and a cluster configuration property to configure Leader Pinning.
1921

20-
You can use both a topic configuration property and a cluster configuration property to configure leader pinning.
22+
You can set the topic configuration property for individual topics only, or set the cluster-wide configuration property that will enable Leader Pinning by default for all topics. You can also use a combination in which a default setting applies across the cluster, and you toggle the setting on or off for specific topics.
2123

22-
You can set the topic configuration property for individual topics only, or set the cluster-wide configuration property that will enable leader pinning by default for all topics. You can also use a combination in which a default setting applies across the cluster, and you toggle the setting on or off for specific topics.
2324

2425
This configuration is based on the following scenario: you have Redpanda deployed in a multi-AZ or multi-region cluster, and you have configured each broker so that the config_ref:rack,true,properties/broker-properties[] configuration property contains rack IDs corresponding to the AZ IDs:
2526

2627
* Set the topic configuration property xref:reference:properties/topic-properties.adoc#redpandaleaderspreference[`redpanda.leaders.preference`]. The property accepts the following string values:
2728
+
2829
--
29-
** `none`: Opt out the topic from leader pinning.
30+
** `none`: Opt out the topic from Leader Pinning.
3031
** `racks:<rack1>[,<rack2>,...]`: Specify the preferred location (rack) of all topic partition leaders. The list can contain one or more rack IDs, and you can list the IDs in any order. Spaces in the list are ignored, for example: `racks:rack1,rack2` and `racks: rack1, rack2` are equivalent. You cannot specify empty rack IDs, for example: `racks: rack1,,rack2`. If you specify multiple IDs, Redpanda tries to distribute the partition leader locations equally across brokers in these racks.
3132
--
3233
+
3334
This property inherits the default value from the cluster property `default_leaders_preference`.
3435

35-
* Set the cluster configuration property config_ref:default_leaders_preference,true,properties/cluster-properties[], which specifies the default leader pinning configuration for all topics that don’t have `redpanda.leaders.preference` explicitly set. It accepts values in the same format as `redpanda.leaders.preference`. Default: `none`
36+
* Set the cluster configuration property config_ref:default_leaders_preference,true,properties/cluster-properties[], which specifies the default Leader Pinning configuration for all topics that don’t have `redpanda.leaders.preference` explicitly set. It accepts values in the same format as `redpanda.leaders.preference`. Default: `none`
3637
+
3738
This property also affects internal topics, such as `__consumer_offsets` and transaction coordinators. All offset tracking and transaction coordination requests get placed within the preferred regions or AZs for all clients, so you see end-to-end latency and networking cost benefits.
3839

39-
If there is more than one broker in the preferred AZ (or AZs), leader pinning distributes partition leaders uniformly across brokers in the AZ.
40+
If there is more than one broker in the preferred AZ (or AZs), Leader Pinning distributes partition leaders uniformly across brokers in the AZ.
4041

41-
== Leader pinning failover across availability zones
42+
== Leader Pinning failover across availability zones
4243

4344
If there are three AZs: A, B, and C, and A becomes unavailable, the failover behavior is as follows:
4445

modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To enable xref:get-started:licensing/overview.adoc[enterprise features for Redpa
66

77
== Prerequisites
88

9-
You must have an Enterprise Edition license. https://www.redpanda.com/contact[Request a license^] if you don't have one already.
9+
You must have an Enterprise Edition 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^].
1010

1111
== Add a new license
1212

modules/get-started/pages/licensing/add-license-redpanda/linux.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ To enable xref:get-started:licensing/overview.adoc[enterprise features for Redpa
77

88
- You must have xref:get-started:rpk-install.adoc[`rpk` installed] and configured to connect to your Redpanda cluster.
99

10-
- You must have an Enterprise Edition license. https://www.redpanda.com/contact[Request a license^] if you don't have one already.
10+
- You must have an Enterprise Edition 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^].
1111

1212
== Add a new license
1313

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
= Disable Enterprise Features in Redpanda
2+
:description: Disable specific enterprise features in Redpanda to ensure your cluster operates within the scope of the Community Edition without enterprise features.
3+
4+
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.
5+
6+
== Prerequisites
7+
8+
Before you begin, consider the following:
9+
10+
- Take a backup of your current configuration to allow rollback if needed.
11+
12+
- Disabling enterprise features may affect cluster performance, security, or functionality. Test these changes in a staging environment before applying them to production.
13+
14+
- 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^].
15+
16+
== Check for enterprise features in violation
17+
18+
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.
19+
20+
[NOTE]
21+
====
22+
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].
23+
====
24+
25+
. Ensure that xref:get-started:rpk-install.adoc[`rpk` is installed] and configured to connect to your cluster's Admin API endpoint.
26+
27+
. Get the details about your cluster's license:
28+
+
29+
[,bash]
30+
----
31+
rpk cluster license info
32+
----
33+
+
34+
If the `license violation` status is `true`, you must either obtain a valid license or disable the enterprise features in use to ensure compliance.
35+
36+
== Disable enterprise features
37+
38+
To disable specific enterprise features, refer to the following table:
39+
40+
[NOTE]
41+
====
42+
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.
43+
====
44+
45+
[cols="1a,1a"]
46+
|===
47+
| Feature | Action to Disable
48+
49+
| xref:manage:audit-logging.adoc[Audit Logging]
50+
|
51+
Set the cluster config `audit_enabled` to `false`:
52+
53+
[,bash]
54+
----
55+
rpk cluster config set audit_enabled false
56+
----
57+
58+
| xref:manage:cluster-maintenance/continuous-data-balancing.adoc[Continuous Data Balancing]
59+
|
60+
Set the cluster config `partition_autobalancing_mode` to `node_add`:
61+
62+
[,bash]
63+
----
64+
rpk cluster config set partition_autobalancing_mode node_add
65+
----
66+
67+
| xref:manage:cluster-maintenance/cluster-balancing.adoc#intra-broker-partition-balancing[Continuous Intra-Broker Partition Balancing]
68+
(`core_balancing_continuous`)
69+
|
70+
Set the cluster config `core_balancing_continuous` to `false`:
71+
72+
[,bash]
73+
----
74+
rpk cluster config set core_balancing_continuous false
75+
----
76+
77+
| xref:manage:security/fips-compliance.adoc[FIPS Compliance]
78+
|
79+
Set the node config `fips_mode` to `disabled`:
80+
81+
[,bash]
82+
----
83+
rpk node config set fips_mode disabled
84+
----
85+
86+
| xref:manage:security/authentication.adoc#kerberos[Kerberos authentication]
87+
|
88+
Remove `GSSAPI` from the cluster config `sasl_mechanisms`:
89+
90+
[,bash]
91+
----
92+
rpk cluster config set sasl_mechanisms <other-mechanisms>
93+
----
94+
95+
| xref:manage:security/authentication.adoc#kerberos[Leader Pinning]
96+
|
97+
Set `default_leaders_preference` to `none`:
98+
99+
[,bash]
100+
----
101+
rpk cluster config set default_leaders_preference none
102+
----
103+
104+
| xref:manage:security/authentication.adoc#oidc[OAUTHBEARER/OIDC authentication]
105+
|
106+
Remove `OIDC` from the cluster config `sasl_mechanisms` and `http_authentication`:
107+
[,bash]
108+
----
109+
rpk cluster config set sasl_mechanisms <other-mechanisms>
110+
rpk cluster config set http_authentication <other-mechanisms>
111+
----
112+
113+
| xref:manage:remote-read-replicas.adoc[Remote Read Replicas]
114+
|
115+
Set the cluster config `cloud_storage_enable_remote_read` to `false`:
116+
117+
[,bash]
118+
----
119+
rpk cluster config set cloud_storage_enable_remote_read false
120+
----
121+
122+
| xref:manage:security/authorization/rbac.adoc[Role-Based Access Control (RBAC)]
123+
|
124+
Use `rpk security role delete` to delete all configured roles:
125+
126+
[,bash]
127+
----
128+
rpk security role list
129+
rpk security role delete <role-name>
130+
----
131+
132+
| xref:manage:schema-reg/schema-id-validation.adoc[Server-Side Schema ID Validation]
133+
|
134+
Set the cluster config `enable_schema_id_validation` to `false`:
135+
136+
[,bash]
137+
----
138+
rpk cluster config set enable_schema_id_validation false
139+
----
140+
141+
| xref:manage:tiered-storage.adoc[Tiered Storage]
142+
|
143+
Set the cluster config `cloud_storage_enabled` to `false`:
144+
145+
[,bash]
146+
----
147+
rpk cluster config set cloud_storage_enabled false
148+
----
149+
150+
|===
151+
152+
== Verify the license status
153+
154+
When all required changes are made, confirm that the `license violation` status is now `false`.
155+
156+
[,bash]
157+
----
158+
rpk cluster license info
159+
----
160+
161+
== Suggested reading
162+
163+
For more information about licensing, see xref:get-started:licensing/overview.adoc[].

0 commit comments

Comments
 (0)