Gérer l'authentification IAM

Cette page fournit des instructions sur les tâches courantes de la fonctionnalité d'authentification IAM pour Memorystore for Redis Cluster. Pour en savoir plus sur cette fonctionnalité, consultez À propos de l'authentification IAM.

Créer une instance avec l'authentification IAM

Pour créer une instance Memorystore for Redis Cluster qui utilise l'authentification IAM, exécutez la commande create :

gcloud redis clusters create INSTANCE_ID --region=REGION_ID --network=NETWORK --node-type=NODE_TYPE --shard-count=SHARD_COUNT --auth-mode=iam-auth

Remplacez les éléments suivants :

• INSTANCE_ID est l'ID de l'instance Memorystore for Redis Cluster que vous créez. L'ID de votre instance doit comporter entre 1 et 63 caractères et ne contenir que des lettres minuscules, des chiffres ou des traits d'union. Il doit commencer et se terminer par une lettre minuscule ou un chiffre.

• REGION_ID est la région dans laquelle vous souhaitez placer l'instance.

  Remarque : Vous ne pouvez créer des instances que dans les régions compatibles avec Memorystore for Redis Cluster. Toutes les régions actuellement compatibles avec Memorystore pour Redis ne sont pas disponibles pour Memorystore for Redis Cluster. Les commandes gcloud redis regions list affichent les régions compatibles avec Memorystore pour Redis, et non avec Memorystore for Redis Cluster.

• NETWORK est le réseau utilisé pour créer votre instance. Il doit utiliser le format suivant : projects/NETWORK_PROJECT_ID/global/networks/NETWORK_ID. L'ID de réseau utilisé ici doit correspondre à celui utilisé par la stratégie de connexion de service. Sinon, l'opération create échoue. Pour en savoir plus, consultez la section Mise en réseau.

• NODE_TYPE est le type de nœud du cluster.

  Attention : Nous vous recommandons d'utiliser le type de nœud redis-shared-core-nano uniquement à des fins de développement ou de test car il n'est pas couvert par un contrat de niveau de service. Si vous exécutez Memorystore for Redis Cluster dans un environnement de production, nous vous recommandons d'utiliser un autre type de nœud.

• SHARD_COUNT détermine le nombre de fragments dans votre instance. Le nombre de fragments détermine la capacité totale de mémoire pour stocker les données du cluster. Pour en savoir plus sur les spécifications du cluster, consultez la section Spécifications du cluster et des nœuds.

Accorder des autorisations pour l'authentification IAM

Pour accorder un accès IAM, suivez les instructions de la section Attribuer un rôle IAM afin d'attribuer le rôle roles/redis.dbConnectionUser au compte principal. Un compte principal est une identité à laquelle vous pouvez accorder l'accès à des ressources Google Cloud. Par exemple, un compte principal peut être un compte de service qui peut accéder à votre Google Cloud projet.

Par défaut, l'attribution du rôle roles/redis.dbConnectionUser à un compte principal lui permet d'accéder à toutes les instances de votre projet.

Remarque : Pour obtenir des instructions sur la limitation de l'accès des utilisateurs par instance, consultez la section Accorder l'accès à un groupe de ressources en fonction des préfixes des noms de ressources. Lorsque vous accordez un accès limité à votre instance, utilisez l'attribut resource.name et le format suivant pour le nom de l'instance : projects/PROJECT/locations/REGION/clusters/INSTANCE_NAME.

Créer un rôle d'administrateur IAM limité pour une instance

Vous pouvez créer un rôle qui peut modifier les autorisations IAM de connexion à une instance sans accorder un accès complet d'administrateur IAM. Pour ce faire, créez un administrateur IAM limité pour le rôle roles/redis.dbConnectionUser. Pour en savoir plus, consultez la section Créer des administrateurs IAM limités.

Se connecter à une instance qui utilise l'authentification IAM

1. Si vous ne disposez pas encore d'une VM Compute Engine utilisant le même réseau autorisé que votre cluster Redis, créez-en une et connectez-vous en suivant les instructions de la page Démarrage rapide à l'aide d'une VM Linux.

2. Pour votre projet, utilisez la gcloud compute instances set-service-account commande pour définir un compte de service et activer le champ d'application de l'API Cloud Platform pour votre VM Compute Engine.

   gcloud compute instances set-service-account VM_NAME \
   --service-account=SERVICE_ACCOUNT_EMAIL \
   --scopes=SCOPE
   

   Effectuez les remplacements suivants :

   • VM_NAME : nom de votre VM Compute Engine
   • SERVICE_ACCOUNT_EMAIL : adresse e-mail de votre compte de service
   • SCOPE : champ d'application de l'API Cloud Platform pour la VM (cloud-platform)

   Par exemple, la commande suivante attribue le compte de service [e-mail] à une VM appelée example-VM et définit le niveau d'accès sur cette VM sur l'API Cloud Platform :

   gcloud compute instances set-service-account example-VM \
   --service-account=[e-mail] \
   --scopes=cloud-platform
   

   Pour en savoir plus sur l'activation de ce niveau d'accès, consultez la section Associer le compte de service et mettre à jour le niveau d'accès. Pour en savoir plus sur les bonnes pratiques concernant ce champ d'application, consultez la section Bonnes pratiques concernant les champs d'application.

3. Pour votre projet, activez l'API Memorystore pour Redis.

   API Memorystore pour Redis

4. Installez redis-cli sur la VM Compute Engine en exécutant la commande suivante à partir du terminal SSH de Compute Engine :

   sudo apt-get install redis-tools
   

5. Exécutez la commande suivante pour obtenir un jeton d'accès pour votre utilisateur IAM :

   gcloud auth print-access-token
   

   Remarque : Les jetons d'accès expirent au bout d'une heure. Pour en savoir plus, consultez la section Délai d'expiration des jetons d'accès IAM.

6. Connectez-vous au point de terminaison de détection de votre instance :

   redis-cli -h NETWORK_ADDRESS -p PORT -a ACCESS_TOKEN -c
   

   Remplacez les éléments suivants :

   • NETWORK_ADDRESS est l'adresse réseau de l'instance. Pour afficher l' adresse réseau, consultez la section Afficher les informations de l'instance.

   • PORT est le numéro de port des instances. Pour afficher le numéro de port, consultez la section Afficher les informations de l'instance.

   • ACCESS_TOKEN est le jeton d'accès IAM récupéré lors des étapes précédentes.

   Remarque : N'utilisez pas de nom d'utilisateur ni de nom de compte de service pour vous connecter au point de terminaison. De plus, les connexions authentifiées sont valides pendant 12 heures. Pour en savoir plus, consultez la section Délai d'expiration des jetons d'accès IAM.

7. Exécutez la commande CLUSTER SHARDS pour afficher la topologie de votre cluster. Notez l'adresse IP et le numéro de port de l'un des nœuds.

8. Pour utiliser redis-cli afin de vous authentifier et de vous connecter à votre nœud, utilisez la commande suivante :

   redis-cli -h NODE_IP_ADDRESS -p NODE_PORT -a ACCESS_TOKEN -c
   

   Remplacez les éléments suivants :

   • NODE_IP_ADDRESS : adresse IP du nœud que vous avez trouvée à l'étape précédente
   • NODE_PORT : numéro de port du nœud que vous avez trouvé à l'étape précédente
   • ACCESS_TOKEN : jeton d'accès IAM que vous avez récupéré lors des étapes précédentes
   Remarque : Les connexions authentifiées sont valides pendant 12 heures. Pour en savoir plus, consultez la section Délai d'expiration des jetons d'accès IAM.

9. Pour vérifier que vous disposez d'une connexion authentifiée à votre nœud, exécutez une commande Redis SET et GET.

10. Supprimez la VM Compute Engine que vous avez utilisée pour vous connecter au cluster Redis. Vous éviterez ainsi que des frais soient facturés sur votre compte de facturation Cloud.

Automatiser la récupération des jetons d'accès

Remarque : Nous vous recommandons vivement d'automatiser la récupération des jetons d'accès dans votre application. En raison de la courte durée de vie d'un jeton d'accès, il est difficile de le coder en dur.

Pour obtenir un exemple de code qui montre comment authentifier votre application à l'aide de bibliothèques clientes courantes, consultez la section Exemple de code de bibliothèque cliente d'authentification IAM.

1. (Facultatif) Si ce n'est pas déjà fait, créez un compte de service pour votre application (consultez Créer et gérer un compte de service).

   gcloud iam service-accounts create SA_NAME \
       --description="DESCRIPTION" \
       --display-name="DISPLAY_NAME"
   

   Remplacez les éléments suivants :

   • SA_NAME est le nom du compte de service.
   • DESCRIPTION est une description facultative du compte de service.
   • DISPLAY_NAME est un nom de compte de service à afficher dans la Google Cloud console.

2. Attribuez le rôle redis.dbConnectionUser à votre compte de service sur votre projet.

   gcloud projects add-iam-policy-binding PROJECT_ID \
   --member="serviceAccount:SA_NAME@PROJECT_ID.iam.gserviceaccount.com" \
   --role=roles/"ROLE_NAME"
   

   Remplacez les éléments suivants :

   • PROJECT_ID : ID du projet.
   • SA_NAME : nom du compte de service.
   • ROLE_NAME : nom de rôle. Pour cet exemple : redis.dbConnectionUser.

3. Authentifiez votre application en tant que compte de service donné. Pour en savoir plus, consultez la page sur les comptes de service.

Exemple de code pour se connecter à une instance qui utilise l'authentification IAM

Vous pouvez consulter un exemple de code qui montre comment authentifier votre application à l'aide de bibliothèques clientes courantes. Vous pouvez également voir comment utiliser cet exemple de code pour vous connecter à une instance qui utilise l'authentification IAM.

Résoudre les messages d'erreur avec l'authentification IAM

Message d'erreur	Action recommandée	Description
-WRONGPASS invalid username-password pair or user is disabled	Vérifiez le nom d'utilisateur et le jeton d'accès fournis au serveur Memorystore for Redis Cluster.	Le nom d'utilisateur ou le jeton d'accès fourni n'est pas valide. "default" est le seul nom d'utilisateur accepté. Si votre application utilise déjà le nom d'utilisateur "default", vérifiez que le jeton d'accès n'a pas expiré et qu'il est récupéré en suivant les instructions de la section Se connecter à une instance qui utilise l'authentification IAM. La propagation des autorisations IAM peut prendre quelques minutes si elles ont été modifiées récemment.
-NOAUTH Authentication required	Vérifiez que l'application est configurée pour fournir un jeton d'accès IAM au serveur Memorystore for Redis Cluster.	L'application ne fournit pas de jeton d'accès au serveur Memorystore for Redis Cluster. Vérifiez que l'application est configurée pour fournir un jeton d'accès en suivant les instructions de la section Se connecter à une instance qui utilise l'authentification IAM.
-ERR (ERR_IAM_EXHAUSTED) Memorystore IAM authentication backend quota exceeded. See https://cloud.google.com/memorystore/docs/cluster/manage-iam-auth#error_messages.	Réessayez avec un intervalle exponentiel entre les tentatives.	Le backend IAM est surchargé et a renvoyé une erreur de dépassement de quota au serveur Memorystore for Redis Cluster. Les applications doivent tenter de réessayer cette erreur avec un intervalle exponentiel entre les tentatives pour éviter d'autres échecs de connexion.
-ERR (ERR_IAM_OTHER) Memorystore IAM authentication backend error. See https://cloud.google.com/memorystore/docs/cluster/manage-iam-auth#error_messages.	Réessayez avec un intervalle exponentiel entre les tentatives.	Le backend IAM a renvoyé une erreur temporaire au serveur Memorystore for Redis Cluster. Les applications doivent tenter de réessayer cette erreur avec un intervalle exponentiel entre les tentatives pour éviter d'autres échecs de connexion.