Cluster license keys

The cluster key (or license) enables features and capacity within Redis Enterprise Software

Redis Enterprise Software

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

To view the cluster license key, use:

  • Cluster Manager UI

    1. Go to Cluster > Configuration > General > License to see the cluster license details.

    2. Select Change to view the cluster license key.

  • REST API - GET /v1/license

    For a list of returned fields, see the response section.

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

Update cluster license

Note:
After you add a cluster key, you cannot remove the key to return the cluster to trial mode.

You can update the cluster license key:

  • During cluster setup using the Cluster Manager UI or CLI

  • After cluster setup using the Cluster Manager UI:

    1. Go to Cluster > Configuration > General > License.

    2. Select Change.

    3. Upload or enter your cluster license key.

    4. Select Save.

You can update an existing cluster key at any time. 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 with the failure's cause. In this case, the existing key stays in effect.

Expired cluster license

When the license is expired:

  • You cannot do these actions:

    • Change database settings, including security and configuration options.

    • Add a database.

  • You can do these actions:

    • Sign in to the Cluster Manager UI and view settings and metrics at all resolutions for the cluster, nodes, and databases.

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

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

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

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

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
RATE THIS PAGE
Back to top ↑