Skip to content

Commit

Permalink
DOC-3522 Clarify cluster license requirements & trial license generation
Browse files Browse the repository at this point in the history
  • Loading branch information
rrelledge committed Mar 13, 2024
1 parent 8e2506d commit 7c1eea4
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
15 changes: 7 additions & 8 deletions content/rs/clusters/configure/license-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]({{<relref "/rs/references/rest-api/requests/bootstrap#post-bootstrap">}}), a trial cluster license is generated by default.

## View cluster license key

Expand Down
2 changes: 1 addition & 1 deletion content/rs/references/rest-api/objects/bootstrap/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ A bootstrap configuration object.
| envoy_admin_port | integer, (range:&nbsp;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:&nbsp;1024-65535) | Envoy management server port|
| gossip_envoy_admin_port | integer, (range:&nbsp;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]({{<relref "/rs/references/rest-api/objects/bootstrap/node_identity">}}) object | Node description |
| policy | [policy]({{<relref "/rs/references/rest-api/objects/bootstrap/policy">}}) object | Policy object |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion content/rs/references/rest-api/requests/license/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 7c1eea4

Please sign in to comment.