From 7c1eea4c0aa0a5684f3a045467f7a05b27d3108f Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Wed, 13 Mar 2024 13:10:26 -0500 Subject: [PATCH] DOC-3522 Clarify cluster license requirements & trial license generation --- content/rs/clusters/configure/license-keys.md | 15 +++++++-------- .../rest-api/objects/bootstrap/_index.md | 2 +- .../rest-api/requests/bootstrap/_index.md | 2 +- .../rest-api/requests/license/_index.md | 2 +- 4 files changed, 10 insertions(+), 11 deletions(-) diff --git a/content/rs/clusters/configure/license-keys.md b/content/rs/clusters/configure/license-keys.md index 8384ac91280..a1b01bbe764 100644 --- a/content/rs/clusters/configure/license-keys.md +++ b/content/rs/clusters/configure/license-keys.md @@ -12,17 +12,16 @@ aliases: [ /rs/clusters/configure/license-keys/, ] --- -The cluster key (or license) enables features and capacity within Redis Enterprise Software. -You can add or update a cluster key at any time in a cluster lifecycle. -When the cluster does not have a cluster key, the cluster is in trial mode. +The cluster license key enables Redis Enterprise Software features and determines shard usage and limits. +You can add or update a cluster key at any time. ## Trial mode -Trial mode is limited to thirty days and a total of four shards, including master and replica -shards. Any new installation starts its thirty-day clock from the day -the cluster setup was done (with the first cluster node provisioned). -This mode allows all features to be enabled, including Auto Tiering, -during the trial period. +Trial mode allows all features to be enabled during the trial period. + +Trial mode is limited to 30 days and 4 shards, including master and replica shards. A new Redis Enterprise Software installation starts its 30-day trial period from the day you set up the cluster on the first node. + +Trial mode requires a trial license. If you do not provide a license when you create a cluster using the Cluster Manager UI or a [bootstrapping REST API request]({{}}), a trial cluster license is generated by default. ## View cluster license key diff --git a/content/rs/references/rest-api/objects/bootstrap/_index.md b/content/rs/references/rest-api/objects/bootstrap/_index.md index c3b904bdf69..1c032c45317 100644 --- a/content/rs/references/rest-api/objects/bootstrap/_index.md +++ b/content/rs/references/rest-api/objects/bootstrap/_index.md @@ -28,7 +28,7 @@ A bootstrap configuration object. | envoy_admin_port | integer, (range: 1024-65535) | Envoy admin port. Changing this port during runtime might result in an empty response because envoy serves as the cluster gateway.| | envoy_mgmt_server_port | integer, (range: 1024-65535) | Envoy management server port| | gossip_envoy_admin_port | integer, (range: 1024-65535) | Gossip envoy admin port| -| license | string | License string | +| license | string | License string. If not provided, a trial license is set by default. | | max_retries | integer | Max number of retries in case of recoverable errors | | node | [node_identity]({{}}) object | Node description | | policy | [policy]({{}}) object | Policy object | diff --git a/content/rs/references/rest-api/requests/bootstrap/_index.md b/content/rs/references/rest-api/requests/bootstrap/_index.md index 3fda365a31a..b5dcf347539 100644 --- a/content/rs/references/rest-api/requests/bootstrap/_index.md +++ b/content/rs/references/rest-api/requests/bootstrap/_index.md @@ -208,7 +208,7 @@ POST /bootstrap/create_cluster }, "bigstore_driver": "rocksdb" }, - "license": "", + "license": "----- LICENSE START -----\ndi+iK...KniI9\n----- LICENSE END -----\n", "credentials": { "username": "my_username", "password": "my_password" diff --git a/content/rs/references/rest-api/requests/license/_index.md b/content/rs/references/rest-api/requests/license/_index.md index 3f693b83154..e2e1807dda0 100644 --- a/content/rs/references/rest-api/requests/license/_index.md +++ b/content/rs/references/rest-api/requests/license/_index.md @@ -97,7 +97,7 @@ Returns a JSON object that contains the license details: PUT /v1/license -Validate and install a new license string. +Validate and install a new license string. If you do not provide a valid license, the cluster behaves as if the license was deleted. #### Required permissions