Déployer Redis en 5 minutes

Ce guide vous accompagne dans la création de votre premier cluster Redis depuis la console Hikube, jusqu'aux premiers tests avec redis-cli.

Objectifs

À la fin de ce guide, vous aurez :

Un cluster Redis déployé dans votre projet Hikube
Un mot de passe d'accès généré par la plateforme
Une connexion fonctionnelle avec redis-cli

Prérequis

Un compte Hikube et un projet disposant de quotas suffisants (CPU, mémoire, stockage)
Le client redis-cli installé sur votre poste, si vous souhaitez tester une connexion depuis Internet
Pour l'onglet API : une clé d'API admin du projet et les variables HIKUBE_API, HIKUBE_API_KEY et PROJECT_ID (voir Préparer l'environnement) ; les exemples utilisent curl et jq

Étape 1 : Créer le cluster

Console
API

Connectez-vous à la console Hikube et sélectionnez votre projet.
Dans le menu latéral, ouvrez DB & Messaging → Redis. La page Clusters Redis s'affiche.
Cliquez sur Créer un cluster. L'assistant Créer un cluster Redis s'ouvre.

Avec l'API, il n'y a pas d'assistant. Vérifiez que la clé donne accès au projet en listant ses clusters Redis, puis consultez les préconfigurations disponibles :

curl -sS "$HIKUBE_API/redis/v1alpha1/projects/$PROJECT_ID/clusters" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY"

curl -sS "$HIKUBE_API/redis/v1alpha1/presets" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" | jq '.presets[] | {name, cpu, memory}'

Résultat attendu : un objet {"totalCount": ..., "clusters": [...]}, puis la liste des préconfigurations (séries u1, s1 et m1) avec leur CPU et leur mémoire.

Étape 2 : Configurer et valider

Console
API

L'assistant comporte quatre étapes : Général, Configuration, Vérification et Résumé.

Général

Saisissez le Nom du cluster, par exemple demo-cache (3 à 16 caractères : minuscules, chiffres et tirets ; commence par une lettre, se termine par une lettre ou un chiffre). Cliquez sur Suivant.

Configuration

Champ	Valeur conseillée pour ce guide	Remarque
Version	`8 (Latest)`	Versions proposées : 8 et 7
Préconfiguration	`s1.small — 1 CPU / 2Gi`	Aucune préconfiguration n'est présélectionnée ; capacité allouée à chaque nœud
Taille du volume (Go)	`10`	Stockage alloué à chaque nœud
Nombre de réplicas	`3`	1 à 8 ; 2 minimum pour le failover automatique
Réseau public	Activé	Nécessaire pour vous connecter depuis votre poste
Activer l'authentification	Activé	Active par défaut ; à conserver

Le bandeau en haut de l'assistant affiche le Coût estimé et l'impact sur les quotas du projet. Cet impact compte aussi les trois sentinelles du cluster, à la taille de la préconfiguration. Cliquez sur Suivant.

attention

Le Nombre de réplicas ne peut plus être modifié après la création.

Vérification

Relisez le récapitulatif (Nom, Version, Préconfiguration, Réplicas, Taille de stockage, Réseau : Public ou Privé), puis cliquez sur Déployer.

Créez le cluster avec POST /redis/v1alpha1/projects/{projectId}/clusters, avec les mêmes valeurs que dans la console :

curl -sS -X POST "$HIKUBE_API/redis/v1alpha1/projects/$PROJECT_ID/clusters" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "democache",
    "version": "v8",
    "preset": "s1.small",
    "size": 10,
    "replicas": 3,
    "external": true,
    "authEnabled": true
  }' | jq '{name, status, password}'

Champ	Valeur	Remarque
`name`	`democache`	16 caractères maximum, en minuscules ; identifie le cluster dans les chemins de l'API
`version`	`v8`	`v7` ou `v8`
`preset`	`s1.small`	Une préconfiguration de `GET /redis/v1alpha1/presets` (séries `u1`, `s1` et `m1`)
`size`	`10`	Taille du volume de chaque nœud, en Go (1 à 4096)
`replicas`	`3`	1 à 8 ; `1` = nœud unique, 2 et plus = mode cluster. Le mode ne peut plus changer après la création
`external`	`true`	Accès depuis Internet (Réseau public)
`authEnabled`	`true`	Authentification par mot de passe

Mot de passe renvoyé une seule fois

Avec "authEnabled": true, la réponse de création contient le champ password. Il n'est renvoyé qu'ici : enregistrez-le aussitôt dans votre gestionnaire de secrets.

Étape 3 : Vérifier l'état

Console
API

L'étape Résumé affiche « Cluster créé avec succès ». Cliquez sur Terminer pour revenir à la liste Clusters Redis, puis ouvrez le cluster.

Statut	Signification
En création	Le cluster est en cours de provisionnement
Prêt	Le cluster est opérationnel
Erreur	La plateforme n'a pas pu appliquer la création ou la dernière modification du cluster

Résultat attendu : après quelques minutes, la section Connexion de la page du cluster affiche le Statut Prêt et l'hôte interne du cluster.

curl -sS "$HIKUBE_API/redis/v1alpha1/projects/$PROJECT_ID/clusters/democache" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" | jq '{name, status, host, internalHost, replicas, preset}'

`status`	Signification
`provisioning`	Le cluster est en cours de provisionnement
`ready`	Le cluster est opérationnel
`error`	Le provisionnement a échoué

Résultat attendu : après quelques minutes, status vaut ready et host contient l'adresse du cluster.

Étape 4 : Récupérer les identifiants

Console
API

Lorsque l'authentification est activée, l'étape Résumé de l'assistant affiche, dans Identifiants des utilisateurs :

l'utilisateur default ;
son Mot de passe ;
la Chaîne de connexion interne : l'adresse du cluster, lorsque le réseau public est activé.

attention

Copiez le mot de passe immédiatement : il ne sera plus affiché. En cas de perte, générez-en un nouveau depuis la section Sécurité de la page du cluster (Effectuer une rotation). Voir Renouveler le mot de passe.

La section Connexion de la page du cluster affiche ses adresses en deux zones, chacune avec un bouton de copie :

Interne, Depuis les ressources du projet uniquement : l'hôte interne, toujours renseigné, et le port (6379). Il se joint depuis les VM et les clusters Kubernetes du même projet, sans accès externe ;
Externe, Depuis Internet : l'adresse publique, lorsque l'Accès externe est activé.

Utilisateur : default ;
Mot de passe : le champ password de la réponse de création (étape 2). GET ne le renvoie jamais ;
Hôte : le champ host de GET .../clusters/democache (étape 3) depuis Internet, internalHost depuis les ressources du projet.

En cas de perte du mot de passe, générez-en un nouveau. La rotation révoque immédiatement l'ancien :

curl -sS -X POST "$HIKUBE_API/redis/v1alpha1/projects/$PROJECT_ID/clusters/democache/rotate-password" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" | jq -r '.password'

Voir Renouveler le mot de passe.

Étape 5 : Connexion et tests

Depuis votre poste, utilisez l'adresse de la zone Externe ; depuis une VM ou un cluster Kubernetes du projet, l'hôte de la zone Interne.

export REDIS_HOST=<hôte>
export REDISCLI_AUTH='<mot de passe>'

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

# Créer une clé
redis-cli -h "$REDIS_HOST" -p 6379 SET hello "hikube"
# OK

# Lire la clé
redis-cli -h "$REDIS_HOST" -p 6379 GET hello
# "hikube"

astuce

La variable REDISCLI_AUTH évite de faire apparaître le mot de passe dans l'historique du shell, contrairement à l'option -a.

Étape 6 : Dépannage rapide

La zone Externe affiche « Désactivé » ou « En attente d'attribution… »

« Désactivé » : l'Accès externe est coupé. Activez-le via Modifier si vous devez vous connecter depuis Internet ; depuis le projet, utilisez l'hôte de la zone Interne. « En attente d'attribution… » : l'adresse publique n'est pas encore attribuée, patientez quelques instants.

L'hôte interne ne se résout pas depuis une VM

Copiez le nom complet de la zone Interne, sans le raccourcir. Sur Debian 13, le nom ne se résout pas sans configuration : voir Joindre un service managé du projet.

`NOAUTH Authentication required` ou `WRONGPASS`

Le mot de passe est absent ou erroné. Vérifiez la variable REDISCLI_AUTH, ou générez un nouveau mot de passe depuis la section Sécurité.

Le bouton Suivant reste inactif

La configuration dépasse les quotas du projet, sentinelles comprises. Réduisez la préconfiguration, la taille du volume ou le nombre de réplicas.

Le cluster passe en Erreur

La plateforme n'a pas pu appliquer la création ou la dernière modification du cluster. Contactez le support en indiquant le nom du projet et du cluster.

Étape 7 : Nettoyage

Console
API

Ouvrez la page du cluster (DB & Messaging → Redis → nom du cluster).
Cliquez sur Supprimer.
Saisissez le nom exact du cluster dans le champ Nom de la ressource à confirmer, puis cliquez sur Supprimer définitivement.

curl -sS -X DELETE "$HIKUBE_API/redis/v1alpha1/projects/$PROJECT_ID/clusters/democache" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY"

Une réponse 200 avec un objet vide {} confirme la suppression. L'API ne demande pas de confirmation.

attention

Cette action supprime le cluster Redis et toutes les données associées. Elle est irréversible.

Résumé

Vous avez créé depuis la console :

Un cluster Redis répliqué, supervisé par Sentinel
Un mot de passe d'accès
Une connexion redis-cli via le réseau public

Objectifs​

Prérequis​

Étape 1 : Créer le cluster​

Étape 2 : Configurer et valider​

Général​

Configuration​

Vérification​

Étape 3 : Vérifier l'état​

Étape 4 : Récupérer les identifiants​

Étape 5 : Connexion et tests​

Étape 6 : Dépannage rapide​

La zone Externe affiche « Désactivé » ou « En attente d'attribution… »​

L'hôte interne ne se résout pas depuis une VM​

NOAUTH Authentication required ou WRONGPASS​

Le bouton Suivant reste inactif​

Le cluster passe en Erreur​

Étape 7 : Nettoyage​

Résumé​

Objectifs

Prérequis

Étape 1 : Créer le cluster

Étape 2 : Configurer et valider

Général

Configuration

Vérification

Étape 3 : Vérifier l'état

Étape 4 : Récupérer les identifiants

Étape 5 : Connexion et tests

Étape 6 : Dépannage rapide

La zone Externe affiche « Désactivé » ou « En attente d'attribution… »

L'hôte interne ne se résout pas depuis une VM

`NOAUTH Authentication required` ou `WRONGPASS`

Le bouton Suivant reste inactif

Le cluster passe en Erreur

Étape 7 : Nettoyage

Résumé