Skip to content

Commit

Permalink
DOC-657 Add note about 30-day baked-in trial licenses for Redpanda 24…
Browse files Browse the repository at this point in the history
….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]>
  • Loading branch information
7 people authored Nov 24, 2024
1 parent 4f3a993 commit 1e54b6b
Show file tree
Hide file tree
Showing 18 changed files with 413 additions and 160 deletions.
5 changes: 3 additions & 2 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@
*** xref:console:quickstart.adoc[Redpanda Console]
** xref:get-started:licensing/index.adoc[Redpanda Licensing]
*** xref:get-started:licensing/overview.adoc[Editions and Enterprise Features]
*** xref:get-started:licensing/add-license-redpanda/index.adoc[Add an Enterprise License]
*** xref:get-started:licensing/add-license-redpanda/index.adoc[Add License]
**** xref:get-started:licensing/add-license-redpanda/linux.adoc[Linux]
**** xref:get-started:licensing/add-license-redpanda/kubernetes.adoc[Kubernetes]
**** xref:console:ui/add-license.adoc[Redpanda Console]
*** xref:get-started:licensing/monitor-license-status.adoc[Monitor Enterprise Licenses]
*** xref:get-started:licensing/monitor-license-status.adoc[Check Status]
*** xref:get-started:licensing/disable-enterprise-features.adoc[Disable Enterprise Features]
** xref:get-started:rpk/index.adoc[Redpanda CLI]
*** xref:get-started:intro-to-rpk.adoc[Introduction to rpk]
*** xref:get-started:rpk-install.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/enterprise-license.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ TIP: Redpanda Console can also load the license key from a connected Redpanda cl

== Prerequisites

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

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[].

Expand Down
31 changes: 16 additions & 15 deletions modules/develop/pages/produce-data/leader-pinning.adoc
Original file line number Diff line number Diff line change
@@ -1,44 +1,45 @@
= Leader Pinning
// tag::single-source[]
:description: Learn about leader pinning and how to configure a preferred partition leader location based on cloud availability zones or regions.

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.

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.

== Prerequisites
:description: Learn about Leader Pinning and how to configure a preferred partition leader location based on cloud availability zones or regions.

[NOTE]
====
include::shared:partial$enterprise-license.adoc[]
====

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

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.

== Prerequisites

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.

== Configure Leader Pinning

== Configure leader pinning
You can use both a topic configuration property and a cluster configuration property to configure Leader Pinning.

You can use both a topic configuration property and a cluster configuration property to configure leader pinning.
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.

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.

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:

* Set the topic configuration property xref:reference:properties/topic-properties.adoc#redpandaleaderspreference[`redpanda.leaders.preference`]. The property accepts the following string values:
+
--
** `none`: Opt out the topic from leader pinning.
** `none`: Opt out the topic from Leader Pinning.
** `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.
--
+
This property inherits the default value from the cluster property `default_leaders_preference`.

* 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`
* 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`
+
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.

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

== Leader pinning failover across availability zones
== Leader Pinning failover across availability zones

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To enable xref:get-started:licensing/overview.adoc[enterprise features for Redpa

== Prerequisites

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

== Add a new license

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To enable xref:get-started:licensing/overview.adoc[enterprise features for Redpa

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

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

== Add a new license

Expand Down
163 changes: 163 additions & 0 deletions modules/get-started/pages/licensing/disable-enterprise-features.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
= 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.

== 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,1a"]
|===
| 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[].
Loading

0 comments on commit 1e54b6b

Please sign in to comment.