Skip to main content

Deploy Redis in 5 minutes

This guide walks you through creating your first Redis cluster from the Hikube console, up to the first tests with redis-cli.

Objectives​

By the end of this guide, you will have:

  • A Redis cluster deployed in your Hikube project
  • An access password generated by the platform
  • A working connection with redis-cli

Prerequisites​

  • A Hikube account and a project with sufficient quotas (CPU, memory, storage)
  • The redis-cli client installed on your workstation, if you want to test a connection from the Internet

Step 1: Create the cluster​

  1. Sign in to the Hikube console and select your project.
  2. In the side menu, open DB & Messaging → Redis. The Redis Clusters page is displayed.
  3. Click Create a cluster. The Create a Redis cluster wizard opens.

Step 2: Configure and confirm​

The wizard has four steps: General, Configuration, Summary and Done.

General​

Enter the Cluster Name, for example demo-cache (3 to 16 characters: lowercase letters, digits and hyphens; starts with a letter, ends with a letter or a digit). Click Next.

Configuration​

FieldRecommended value for this guideNote
Version8 (Latest)Offered versions: 8 and 7
Presets1.small — 1 CPU / 2GiNo preset is preselected; capacity allocated to each node
Volume size (GB)10Storage allocated to each node
Number of replicas31 to 8; 2 minimum for automatic failover
Public networkEnabledRequired to connect from your workstation
Enable authenticationEnabledOn by default; keep it

The banner at the top of the wizard shows the Estimated cost and the impact on the project quotas. This impact also counts the cluster's three sentinels, at the size of the preset. Click Next.

warning

The Number of replicas cannot be changed after creation.

Summary​

Review the summary (Name, Version, Preset, Replicas, Storage size, Network: Public or Private), then click Create.

Step 3: Check the status​

The Done step shows "Cluster successfully created". Click Finish to return to the Redis Clusters list, then open the cluster.

StatusMeaning
CreatingThe cluster is being provisioned
ReadyThe cluster is operational
ErrorThe platform could not apply the cluster's creation or its last change

Expected result: after a few minutes, the Connection section of the cluster page shows the Status Ready and the cluster's internal host.

Step 4: Retrieve the credentials​

When authentication is enabled, the wizard's Done step displays, under User Credentials:

  • the default user;
  • its Password;
  • the Internal Connection String: the cluster address, when the public network is enabled.
warning

Copy the password immediately: it will not be shown again. If it is lost, generate a new one from the Security section of the cluster page (Rotate password). See Renew the password.

The Connection section of the cluster page shows its addresses in two zones, each with a copy button:

  • Internal, From the project's resources only: the internal host, always filled in, and the port (6379). It is reachable from the VMs and Kubernetes clusters of the same project, without external access;
  • External, From the Internet: the public address, when External access is enabled.

Step 5: Connection and tests​

From your workstation, use the address in the External zone; from a VM or a Kubernetes cluster of the project, the host in the Internal zone.

export REDIS_HOST=<host>
export REDISCLI_AUTH='<password>'

# PING test
redis-cli -h "$REDIS_HOST" -p 6379 ping
# PONG

# Create a key
redis-cli -h "$REDIS_HOST" -p 6379 SET hello "hikube"
# OK

# Read the key
redis-cli -h "$REDIS_HOST" -p 6379 GET hello
# "hikube"
tip

The REDISCLI_AUTH variable keeps the password out of the shell history, unlike the -a option.

Step 6: Quick troubleshooting​

The External zone shows "Disabled" or "Waiting for allocation…"​

"Disabled": External access is turned off. Enable it via Edit if you need to connect from the Internet; from the project, use the host in the Internal zone. "Waiting for allocation…": the public address has not been assigned yet, wait a few moments.

The internal host does not resolve from a VM​

Copy the full name from the Internal zone, without shortening it. On Debian 13, the name does not resolve without configuration: see Reaching a managed service in the project.

NOAUTH Authentication required or WRONGPASS​

The password is missing or wrong. Check the REDISCLI_AUTH variable, or generate a new password from the Security section.

The Next button stays disabled​

The configuration exceeds the project quotas, sentinels included. Reduce the preset, the volume size or the number of replicas.

The cluster changes to Error​

The platform could not apply the cluster's creation or its last change. Contact support, stating the project name and the cluster name.

Step 7: Cleanup​

  1. Open the cluster page (DB & Messaging → Redis → cluster name).
  2. Click Delete.
  3. Enter the exact cluster name in the Resource name to confirm field, then click Permanently delete.
warning

This action deletes the Redis cluster and all associated data. It is irreversible.

Summary​

From the console, you have created:

  • A replicated Redis cluster, supervised by Sentinel
  • An access password
  • A redis-cli connection over the public network