Cette page a été traduite par l'API Cloud Translation.

Créer des scripts pour les commandes de CLI gcloud

En plus d'exécuter des commandes de CLI Google Cloud à partir de la ligne de commande, vous pouvez les exécuter à partir de scripts ou d'autres systèmes d'automatisation, par exemple lorsque vous utilisez Jenkins pour automatiser des tâches Google Cloud.

La CLI gcloud intègre divers outils tels que le filtrage, la mise en forme et l'option --quiet, qui vous permettent de gérer efficacement les résultats et d'automatiser les tâches.

Principes de base de la création de scripts avec gcloud CLI

Pour obtenir un guide par étapes sur la création de scripts de base avec la CLI gcloud, consultez cet article de blog : Créer des scripts avec gcloud: guide de démarrage pour automatiser les tâches Google Cloud.

Autorisation

Lorsque vous créez un script avec gcloud CLI, vous devez prendre en compte les méthodes d'autorisation. La CLI gcloud propose deux options:

Autorisation via un compte utilisateur
Autorisation via un compte de service

L'autorisation via un compte utilisateur est recommandée si vous exécutez un script ou une autre forme d'automatisation sur une seule machine.

Pour autoriser l'accès et effectuer d'autres étapes de configuration courantes de la CLI gcloud:

gcloud init

L'autorisation via un compte de service est recommandée si vous déployez un script ou une autre forme d'automatisation sur des machines d'un environnement de production. C'est également la méthode d'autorisation recommandée si vous exécutez des commandes de CLI gcloud sur une instance de machine virtuelle Compute Engine où tous les utilisateurs ont accès à root.

Pour utiliser l'autorisation du compte de service, utilisez un compte de service existant ou créez-en un sur la page "Comptes de service" :

Accéder à la page "Comptes de service"

Pour créer et télécharger la clé privée associée en tant que fichier de clé au format JSON, sélectionnez Gérer les clés dans le menu d'actions du compte de service.

Pour exécuter l'autorisation, exécutez gcloud auth activate-service-account:

gcloud auth activate-service-account --key-file [KEY_FILE]

Vous pouvez vous connecter en SSH à votre instance de VM à l'aide de gcloud compute ssh, qui s'occupe de l'authentification. Les fichiers de configuration SSH peuvent être définis à l'aide de gcloud compute config-ssh.

Pour obtenir des instructions détaillées sur l'autorisation des outils de CLI gcloud, consultez la section Autoriser la CLI gcloud.

Désactiver les invites

Certaines commandes de CLI gcloud sont interactives et invitent les utilisateurs à confirmer une opération ou demandent une entrée supplémentaire pour une commande saisie.

Dans la plupart des cas, ce comportement n'est pas souhaitable lors de l'exécution de commandes dans un script ou une autre forme d'automatisation. Vous pouvez désactiver les invites des commandes de la CLI gcloud en définissant la propriété disable_prompts dans votre configuration sur True, ou en utilisant l'option globale --quiet ou -q. La plupart des commandes interactives possèdent des valeurs par défaut lorsqu'une confirmation ou une entrée supplémentaire est requise. Si les invites sont désactivées, ces valeurs par défaut sont utilisées.

Exemple :

gcloud debug targets list --quiet

Filtrer et mettre en forme les résultats

Pour créer des scripts avec la CLI gcloud, il est important de disposer d'une sortie prévisible. C'est là que les options --filter et --format sont utiles. Elles permettent de s'assurer que l'exécution d'une commande à l'aide de la CLI gcloud génère une sortie conforme à votre format (json, yaml, csv ou texte, par exemple) et à votre filtre (noms de VM précédés du préfixe "test '", année de création après 2015, etc.).

Pour suivre un tutoriel interactif sur l'utilisation des options de filtrage et de mise en forme, cliquez sur le bouton ci-dessous :

Voici des exemples d'utilisations courantes de la mise en forme et du filtrage avec les commandes de CLI gcloud :

Répertorier les instances créées dans la zone us-central1-a :

gcloud compute instances list --filter="zone:us-central1-a"

Répertorier au format JSON les projets pour lesquels les libellés correspondent à des valeurs spécifiques (par exemple, label.env est 'test' et label.version est alpha) :

gcloud projects list --format="json" \
  --filter="labels.env=test AND labels.version=alpha"

Répertorier les projets avec leur date et heure de création dans le fuseau horaire local :

gcloud projects list \
  --format="table(name, project_id, createTime.date(tz=LOCAL))"

Répertorier les projets créés après une date donnée sous forme de table :

gcloud projects list \
  --format="table(projectNumber,projectId,createTime)" \
  --filter="createTime.date('%Y-%m-%d', Z)='2016-05-11'"

Notez que, dans le dernier exemple, une projection sur la clé a été utilisée. Le filtre est appliqué à la clé createTime une fois la mise en forme de la date définie.

Répertorier une table imbriquée des quotas d'une région :

gcloud compute regions describe us-central1 \
  --format="table(quotas:format='table(metric,limit,usage)')"

Afficher une liste aplatie des quotas globaux au format CSV :

gcloud compute project-info describe --flatten='quotas[]' \
  --format='csv(quotas.metric,quotas.limit,quotas.usage)'

Répertorier les ressources d'instance de calcul avec les attributs et les titres de cadre, triées par nom, sous forme de table :

gcloud compute instances list \
  --format='table[box,title=Instances](name:sort=1,zone:label=zone,status)'

Répertorier l'adresse e-mail de l'utilisateur authentifié du projet :

gcloud info --format='value(config.account)'

Pour voir d'autres exemples impliqués dans les fonctionnalités de configuration de sortie intégrées aux indicateurs gcloud filters, formats et projections, consultez cet article de blog sur le filtrage et la mise en forme.

Bonnes pratiques

Si vous souhaitez qu'un script ou une autre forme d'automatisation exécute des actions de manière conditionnelle en fonction du résultat d'une commande de CLI gcloud, tenez compte des éléments suivants :

Fiez-vous à l'état de sortie de la commande.

Si l'état de sortie est différent de zéro, une erreur s'est produite et le résultat peut être incomplet, sauf indication contraire dans la documentation de la commande. Par exemple, une commande qui crée plusieurs ressources peut n'en créer que quelques-unes, les répertorier sur la sortie standard, puis se terminer avec un état différent de zéro. Vous pouvez également utiliser la propriété show_structured_logs pour analyser les journaux d'erreurs. Exécutez gcloud config pour obtenir davantage d'informations.
Ne vous fiez pas aux messages affichés avec une erreur standard.

La formulation de ces messages peut changer dans les futures versions de la CLI gcloud et interrompre votre automatisation.
Ne vous fiez pas au résultat brut des messages affichés avec la sortie standard.

Le résultat par défaut d'une commande peut changer dans une version ultérieure. Vous pouvez minimiser l'impact de ces changements en utilisant l'option --format pour mettre en forme le résultat avec l'un des éléments suivants : --format=json|yaml|csv|text|list pour spécifier les valeurs à renvoyer. Exécutez gcloud topic formats pour obtenir plus d'options.

Vous pouvez modifier la sortie par défaut de --format à l'aide de projections. Pour plus de précision, utilisez l'option --filter pour renvoyer un sous-ensemble de valeurs basé sur une expression. Vous pouvez ensuite écrire un script par rapport à ces valeurs renvoyées.

Vous trouverez des exemples de mise en forme et de filtrage du résultat dans la section ci-dessous.

Exemples de scripts

Grâce à la fonctionnalité de format et de filtre, vous pouvez combiner des commandes de CLI gcloud dans un script afin d'extraire facilement des informations intégrées.

Répertorier les clés de tous vos projets

Les exemples de scripts suivants répertorient les clés associées à tous vos projets de comptes de service:

Itération de vos projets
Obtenir les comptes de service associés à chaque projet
Obtenir les clés associées à chaque compte de service

Bash

#!/bin/bash
for project in  $(gcloud projects list --format="value(projectId)")
do
  echo "ProjectId:  $project"
  for robot in $(gcloud iam service-accounts list --project $project --format="value(email)")
   do
     echo "    -> Robot $robot"
     for key in $(gcloud iam service-accounts keys list --iam-account $robot --project $project --format="value(name.basename())")
        do
          echo "        $key"
     done
   done
done

Windows PowerShell

Via Windows PowerShell :

foreach ($project in gcloud projects list --format="value(projectId)")
{
  Write-Host "ProjectId: $project"
  foreach ($robot in  gcloud iam service-accounts list --project $project --format="value(email)")
  {
      Write-Host "    -> Robot $robot"
      foreach ($key in gcloud iam service-accounts keys list --iam-account $robot --project $project --format="value(name.basename())")
      {
        Write-Host "        $key"
      }
  }
}

Analyser la sortie pour le traitement

L'exemple suivant montre comment analyser le résultat à des fins de traitement. En particulier, l'exemple de script écrit les informations de compte de service dans un tableau et sépare les valeurs dans le champ serviceAccounts.scope() à valeurs multiples au format CSV:

#!/bin/bash
for scopesInfo in $(
    gcloud compute instances list --filter=name:instance-1 \
        --format="csv[no-heading](name,id,serviceAccounts[].email.list(),
                      serviceAccounts[].scopes[].map().list(separator=;))")
do
      IFS=',' read -r -a scopesInfoArray<<< "$scopesInfo"
      NAME="${scopesInfoArray[0]}"
      ID="${scopesInfoArray[1]}"
      EMAIL="${scopesInfoArray[2]}"
      SCOPES_LIST="${scopesInfoArray[3]}"

      echo "NAME: $NAME, ID: $ID, EMAIL: $EMAIL"
      echo ""
      IFS=';' read -r -a scopeListArray<<< "$SCOPES_LIST"
      for SCOPE in  "${scopeListArray[@]}"
      do
        echo "  SCOPE: $SCOPE"
      done
done