Skip to content

Commit

Permalink
Merge branch 'master' into rc-packaging
Browse files Browse the repository at this point in the history
  • Loading branch information
cmilesb committed Mar 21, 2024
2 parents 8eafe47 + 573b2f8 commit 0737dbe
Show file tree
Hide file tree
Showing 18 changed files with 888 additions and 89 deletions.
55 changes: 26 additions & 29 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 All @@ -39,7 +38,7 @@ To view the cluster license key, use:
For a list of returned fields, see the [response section]({{<relref "/rs/references/rest-api/requests/license#get-response">}}).

{{<note>}}
As of version 7.2, Redis Enteprise will enforce the shards limits by their types (RAM, flash) rather than total number of shards. The flash shards limit only appears in the UI if Auto Tiering is enabled.
As of version 7.2, Redis Enterprise enforces shard limits by shard types, RAM or flash, instead of the total number of shards. The flash shards limit only appears in the UI if Auto Tiering is enabled.
{{</note>}}

## Update cluster license
Expand All @@ -63,13 +62,13 @@ You can update the cluster license key:
1. Select **Save**.

You can update an existing cluster key at any time.
Redis Enterprise checks the validay of it in terms of:
- cluster name
- activation and expiration dates
- shard usage and limits
- features
Redis Enterprise checks its validity for the following:
- Cluster name
- Activation and expiration dates
- Shard usage and limits
- Features

If saving a new cluster key fails, the operation returns an error including failure reason.
If saving a new cluster key fails, the operation returns an error with the failure's cause.
In this case, the existing key stays in effect.

## Expired cluster license
Expand All @@ -78,35 +77,33 @@ When the license is expired:

- You cannot do these actions:

- Change database settings including security and configuration options.

- Add or remove a database.
- Change database settings, including security and configuration options.

- Upgrade a database to a new version.

- Add or remove a node.
- Add a database.

- You can do these actions:

- Sign in to the admin console and view settings and metrics at all resolutions for the cluster, nodes, and databases.

- Change cluster settings including license key, security for administrators, and cluster alerts.
- Change cluster settings, including the license key, security for administrators, and cluster alerts.

- Failover when a node fails and explicitly migrate shards between nodes.
- Fail over when a node fails and explicitly migrate shards between nodes.

- Upgrade a node to a new version of Redis Enterprise Software.

## Monitor cluster license

As of version 7.2, Redis Enterprise exposes the license quotas and the shards consumption metrics in the Cluster Manager UI or via the [Prometheus integration]({{< relref "/rs/clusters/monitoring/prometheus-integration.md" >}}).

The 'cluster_shards_limit' metric displays the total shard limit by the license by shard type (ram / flash).
The `cluster_shards_limit` metric displays the total shard limit by shard type.

Examples:
- cluster_shards_limit{cluster="mycluster.local",shard_type="ram"} 100.0
- cluster_shards_limit{cluster="mycluster.local",shard_type="flash"} 50.0
- `cluster_shards_limit{cluster="mycluster.local",shard_type="ram"} 100.0`
- `cluster_shards_limit{cluster="mycluster.local",shard_type="flash"} 50.0`

The `bdb_shards_used` metric displays the used shard count by database and shard type.

The 'bdb_shards_used' metric displays the used shard count by database and by shard type (ram / flash).
Examples:
- bdb_shards_used{bdb="2",cluster="mycluster.local",shard_type="ram"} 86.0
- bdb_shards_used{bdb="3",cluster="mycluster.local",shard_type="flash"} 23.0
- `bdb_shards_used{bdb="2",cluster="mycluster.local",shard_type="ram"} 86.0`
- `bdb_shards_used{bdb="3",cluster="mycluster.local",shard_type="flash"} 23.0`

19 changes: 7 additions & 12 deletions content/rs/databases/configure/database-persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,26 +104,21 @@ crdb-cli crdb update --crdb-guid <CRDB_GUID> --default-db-config \

## Auto Tiering data persistence

If you are enabling data persistence for databases running on Redis
Enterprise Flash, by default both master and replica shards are
configured to write to disk. This is unlike a standard Redis Enterprise
Software database where only the replica shards persist to disk. This
master and replica dual data persistence with replication is done to
better protect the database against node failures. Flash-based databases
are expected to hold larger datasets and repair times for shards can
be longer under node failures. Having dual-persistence provides better
protection against failures under these longer repair times.
Auto Tiering flash storage is not considered persistent storage.

Flash-based databases are expected to hold larger datasets, and shard repair times can take longer after node failures. To better protect the database against node failures with longer repair times, consider enabling master and replica dual data persistence.

However, dual data persistence with replication adds some processor
and network overhead, especially for cloud configurations
with network-attached persistent storage, such as EBS-backed
volumes in AWS.

There may be times when performance is critical for your use case and
you don't want to risk data persistence adding latency. If that is the
case, you can disable data-persistence on the master shards using the
you don't want to risk data persistence adding latency.

You can enable or turn off data persistence on the master shards using the
following `rladmin` command:

```sh
rladmin tune db <database_ID_or_name> master_persistence disabled
rladmin tune db <database_ID_or_name> master_persistence <disabled | enabled>
```
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
1 change: 1 addition & 0 deletions content/rs/references/rest-api/objects/proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ An API object that represents a [proxy](https://en.wikipedia.org/wiki/Proxy_serv
| dynamic_threads_scaling | boolean | Automatically adjust the number of threads|
| ignore_bdb_cconn_limit | boolean | Ignore client connection limits |
| ignore_bdb_cconn_output_buff_limits | boolean | Ignore buffer limit |
| log_level | `crit`<br />`error`<br />`warn`<br />`info`<br />`trace`<br />`debug` | Minimum log level to log. Only logs with this level or greater will be logged. |
| max_listeners | integer | Max number of listeners |
| max_servers | integer | Max number of Redis servers |
| max_threads | integer, <nobr>(range: 1-256)</nobr> | Max number of threads |
Expand Down
Loading

0 comments on commit 0737dbe

Please sign in to comment.