Présentation de la CLI gcloud

Cette page présente la CLI Google Cloud et ses schémas et capacités de commande courants.

Qu'est-ce que la CLI gcloud ?

La CLI Google Cloud est un ensemble d'outils permettant de créer et de gérer les ressources Google Cloud. Vous pouvez utiliser ces outils pour effectuer de nombreuses tâches courantes sur la plate-forme à partir de la ligne de commande, ou via des scripts et d'autres processus d'automatisation.

Par exemple, vous pouvez utiliser la CLI gcloud pour créer et gérer les éléments suivants:

  • Instances de machines virtuelles et autres ressources Compute Engine
  • Instances Cloud SQL
  • Clusters Google Kubernetes Engine
  • Clusters et tâches Dataproc
  • Ensembles d'enregistrements et zones gérées Cloud DNS
  • Déploiements Cloud Deployment Manager

Vous pouvez également utiliser la CLI gcloud pour déployer des applications App Engine, gérer l'authentification, personnaliser la configuration locale et effectuer d'autres tâches.

Aide-mémoire pour la CLI gcloud

Pour une présentation rapide de la CLI gcloud, une liste des commandes couramment utilisées et un aperçu de la structure de ces commandes, consultez l'aide-mémoire sur gcloud.

Télécharger et installer la CLI gcloud

Si vous utilisez Cloud Shell, la CLI gcloud est disponible automatiquement et vous n'avez pas besoin de l'installer. Vous pouvez également télécharger et installer la CLI gcloud, puis l'initialiser.

Par défaut, la CLI gcloud installe les commandes au niveau de la disponibilité générale. Des fonctionnalités supplémentaires sont disponibles dans les composants de la CLI gcloud nommés alpha et beta. Ces composants vous permettent d'utiliser la CLI gcloud pour travailler avec Cloud Bigtable, Dataflow et d'autres éléments de Google Cloud à des niveaux de version antérieurs à la disponibilité générale.

La version actuelle de la CLI gcloud est 387.0.0. Vous pouvez télécharger et installer les versions précédentes de la CLI gcloud à partir de l'archive de téléchargement

Niveaux de version

Les commandes de la CLI gcloud comportent les niveaux de version suivants :

Niveau de version Libellé Description
Disponibilité générale Aucune Les commandes sont considérées comme totalement stables et disponibles pour une utilisation en production. Pour être informé à l'avance des modifications apportées aux commandes qui interrompent le fonctionnement actuel, consultez les notes de version.
Bêta beta Les commandes sont complètes sur le plan fonctionnel, mais il pourrait rester des problèmes en suspens. Des modifications destructives peuvent être apportées à ces commandes sans préavis.
Alpha alpha Les commandes sont à un stade précoce et peuvent changer sans préavis.

Les composants alpha et beta ne sont pas installés par défaut lorsque vous installez la CLI gcloud. Vous devez installer ces composants séparément à l'aide de la commande gcloud components install. Si vous essayez d'exécuter une commande alpha ou bêta et que le composant correspondant n'est pas installé, la CLI gcloud vous invite à l'installer.

Groupes de commandes

À chaque niveau de version, les commandes de CLI gcloud sont organisées dans une hiérarchie imbriquée de groupes de commandes, chacune représentant un produit ou une fonctionnalité de Google Cloud ou de ses sous-groupes fonctionnels.

Exemple :

Groupe de commandes Description
gcloud compute Commandes associées à Compute Engine en disponibilité générale
gcloud compute instances Commandes associées aux instances Compute Engine en disponibilité générale
gcloud beta compute Commandes associées à Compute Engine en version bêta
gcloud alpha app Commandes associées à la gestion des déploiements App Engine en version alpha

Exécuter des commandes de CLI gcloud

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

Properties

Les propriétés de CLI CLI sont des paramètres qui affectent le comportement des outils de la CLI gcloud. Certaines de ces propriétés peuvent être définies par des options globales ou de commande. Dans ce cas, la valeur définie par l'option est prioritaire.

Activer les fonctionnalités d'accessibilité

Pour une expérience de lecture d'écran simplifiée, la CLI gcloud intègre une propriété accessibility/screen_reader.

Pour activer la propriété d'accessibilité, exécutez la commande suivante:

gcloud config set accessibility/screen_reader true

Pour plus d'informations sur les fonctionnalités d'accessibilité disponibles avec l'outil de ligne de commande gcloud, consultez le guide Activer les fonctionnalités d'accessibilité.

Configurations

Une configuration est un ensemble de propriétés de CLI gcloud. Une configuration fonctionne comme un profil.

Lorsque vous commencerez à utiliser la CLI gcloud, vous travaillerez avec une configuration unique nommée default et vous pourrez définir des propriétés en exécutant gcloud init ou gcloud config set. Cette configuration par défaut unique convient à la plupart des cas d'utilisation.

Pour travailler avec plusieurs projets ou comptes d'autorisation, vous pouvez définir plusieurs configurations avec gcloud config configurations create et basculer entre les différentes configurations. Dans une configuration, vous pouvez personnaliser les propriétés. Par exemple, pour définir votre projet dans une configuration active, utilisez la propriété project:

gcloud config set project <project-id>

Pour une description détaillée de ces concepts, consultez le guide des configurations.

Options globales

La CLI gcloud fournit un ensemble d'options de CLI gcloud qui régissent le comportement des commandes appel par appel. Les options remplacent les valeurs définies dans les propriétés de la CLI gcloud.

Arguments et options de position

Bien que les arguments et les options de position affectent la sortie d'une commande de CLI gcloud, leurs différences d'utilisation sont légèrement différentes. Un argument positionnel est utilisé pour définir une entité sur laquelle une commande fonctionne, tandis qu'une option est nécessaire pour définir une variation dans le comportement d'une commande.

Utilisation de stdout et stderr

Le résultat des commandes CLI gcloud réussies est écrit dans stdout. Tous les autres types de réponses (invites, avertissements et erreurs) sont écrits dans stderr. Ne créez pas de script par rapport aux réponses écrites à stderr, car elles ne sont pas stables.

Pour obtenir des consignes sur la gestion des résultats, consultez le guide de script.

Invites

Pour vous protéger contre des actions destructives involontaires, la CLI gcloud confirme vos intentions avant d'exécuter des commandes telles que gcloud projects delete.

Un message peut s'afficher lorsque des informations supplémentaires sont nécessaires. Par exemple, vous serez invité à choisir une zone lorsque vous créerez une instance de machine virtuelle Compute Engine à l'aide de gcloud compute instances create test-instance.

Pour désactiver les invites, utilisez l'option --quiet.

Ne créez pas de script selon la formulation des invites, car celle-ci peut changer.

Supprimer des invites, écrire sur le terminal et effectuer une journalisation

L'option --quiet (également appelée -q) de la CLI gcloud désactive toutes les invites interactives lors de l'exécution de commandes de CLI gcloud et est utile pour la création de scripts. Si une entrée est nécessaire, les valeurs par défaut sont utilisées. Si aucune valeur par défaut n'est définie, une erreur est générée.

Pour désactiver l'impression du résultat de la commande sur la sortie standard et l'erreur standard dans le terminal, utilisez l'option --no-user-output-enabled.

Pour ajuster la verbosité des journaux, spécifiez un niveau de verbosité (débogage, informations, avertissement, erreur, critique ou aucun) à l'aide de l'option --verbosity.

Déterminer la structure du résultat

Par défaut, lorsqu'une commande de CLI gcloud renvoie une liste de ressources, celles-ci sont imprimées sur la sortie standard. Pour obtenir des résultats plus pertinents, vous pouvez affiner les résultats à l'aide des options format, filter et projection.

Pour définir uniquement le format de votre sortie, utilisez l'option --format pour produire une version tabulaire ou aplatie de votre sortie (pour l'affichage interactif) ou une version lisible par machine (json, csv, yaml, value).

Pour mettre en forme une liste de clés qui sélectionnent les valeurs de données de ressources, utilisez projections. Pour affiner le résultat en fonction d'un critère que vous définissez, utilisez l'option filter.

Pour vous familiariser avec les fonctionnalités de filtrage et de mise en forme, vous pouvez suivre un tutoriel interactif rapide en cliquant sur Ouvrir dans Cloud Shell.

Ouvrir dans Cloud Shell

Étapes suivantes