Cluster Licensing & Configuration

Redis Software requires a valid cluster license that ties to the cluster's FQDN and entitlement limits (e.g., shard count, memory/flash usage, modules). Misconfigurations—especially around FQDN mismatches—are a common cause of license application errors and UI warnings. This guide covers how to acquire, apply, and manage licenses, configure your cluster settings properly, and troubleshoot common licensing issues. Key sections include Cluster Licensing, Cluster Configuration, Ongoing License Management, Common Issues & Troubleshooting, and Additional Resources with links to CLI/API usage and official docs.

Cluster Licensing

Purpose of Licensing
Licenses unlock paid Redis Software features and enforce environment constraints. Each license includes:

• Cluster FQDN (must match configured name)
• Expiration date
• Shard limits (RAM and Flash)
• Optional module entitlements

Types of Licenses

• Trial – 30-day license, 4 shards max, all features.
• Production – Purchased license matched to FQDN, shard/memory limits, expiration date.

Adding or Updating a Cluster License

UI:

• Navigate to: Cluster > Configuration > License
• Click “Change” and paste/upload your license string

API:

PUT /v1/license
{
  "license": "<license-content>"
}

CLI (example using curl):

curl -v -k -d '{"license":"-----LICENSE START-----...-----LICENSE END-----"}' \
  -u <admin-user> \
  -H "Content-Type: application/json" \
  -X PUT https://localhost:9443/v1/license

Notes:

• Once a production license is applied, the trial license cannot be restored.
• FQDN mismatches between license and cluster name will block activation.
• For upgrades, pre-load your new license before expiration.

Viewing License Details

• UI: Cluster > Configuration > License
• API: GET /v1/license
• Metrics: Prometheus-compatible metrics like cluster_shards_limit, bdb_shards_used

Behavior on Expiry

• Databases remain online
• UI/configuration changes blocked
• No new DBs, resizes, or scaling allowed
• Upload a valid license to restore full functionality

Cluster Configuration

Key Settings (Set During Cluster Creation):

• Cluster Name (FQDN):
  • Immutable once set (e.g., redis.prod.example.com)
  • Must match license FQDN
  • Used by DNS, endpoints, and the license file
• DNS Configuration:
  • Ensure FQDN resolves both internally and externally
  • Each node gets its own subdomain under the cluster FQDN
• License Upload:
  • Required for production use
  • Cannot revert to trial after setting a commercial license
• Misc Settings:
  • Set time zone, alerting emails, NTP, quorum enforcement
• Redis Software 8: Introduces new cluster and database configuration fields, including options for metrics authentication, password-rotation enforcement, and automatic shard balancing. 
  • See the Redis 8.0.2-17 release notes for details.

Quick Setup Process

1. Install Redis Enterprise Software
2. Visit https://<node>:8443/
3. Set admin credentials, cluster FQDN
4. Upload license

Ongoing License Management

Monitoring Usage & Expiry

• Prometheus: Monitor shard usage and limits
• API: GET /v1/license
• Alerts: Configure email alerts for expiration notice

REST API Summary

• View license: GET /v1/license
• Apply/update license: PUT /v1/license

Audit/Compliance

• Export license via API
• Validate shard usage and entitlements
• Download support package for audit trail

Renewals

• Request from Redis Account team
• Apply before expiry to avoid disruption
• Temporary licenses available for staging/migration use

Common Issues & Troubleshooting

Additional Resources

Cluster License Keys

Cluster Settings

New Cluster Setup