Deploying Clusters in Redis Software

To deploy a Redis cluster, you must first install the Redis Software on all nodes that'll be part of the cluster. Once installation is complete, you can deploy the cluster using one of three supported methods: Cluster Manager UI, REST API, or the rladmin CLI.

The cluster name is permanent and tied to your Redis license. It must match the name provided in your license agreement. If you need to change the name after deployment, the cluster must be rebuilt.     

Deploy Using the Cluster Manager UI

1. Open a browser and navigate to https://<node_ip>:8443 on one of the nodes.

2. Click Create New Cluster.

3. Fill in the required fields:

   • Cluster name (must match your license)

   • Admin email

   • Admin password

4. Submit the form to initialize the cluster.

5. On the other nodes, open the same UI and click Join Cluster.

   • Enter the IP address of the first node and use the same admin credentials.

6. (Optional) Configure features like:

   • Rack-zone awareness

   • Persistent storage path

➡ See full UI-based deployment guide

Deploy Using the REST API

1. On one node, send a POST request to the /v1/bootstrap endpoint over port 9443:

   POST https://<node_ip>:9443/v1/bootstrap

   Example payload:

   

2. On each additional node, send a POST request to the /v1/cluster/join endpoint, providing:

   • The IP of the first node

   • The same admin username and password

3. (Optional) Use additional REST endpoints to configure rack-zone awareness or other cluster settings.

➡ View REST API reference

Deploy Using the rladmin CLI

1. On the first node, run:

   rladmin cluster create name <cluster-name> username <admin-email> password <admin-password>

2. On each additional node, run:

   rladmin cluster join username <admin-email> password <admin-password> nodes <first-node-ip>

3. Verify the cluster status:

   rladmin status

➡ See full CLI reference

After Deployment

Once all nodes have joined the cluster and the deployment is complete, you can:

• Log into the Cluster Manager UI

• Use the rladmin CLI or REST API to manage and monitor the cluster

• Begin creating databases and enabling features like TLS, database persistence, and more
  
   

Onboarding Progress

Previous: DNS Setup for Redis Cluster Access
Next: Security Considerations

Return to the Redis Software Onboarding Overview to view all steps.