Présentation de la gcloud CLI

Cette page présente la Google Cloud CLI, ses modèles de commandes courants et ses fonctionnalités.

Qu'est-ce que la gcloud CLI ?

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

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

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

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

Télécharger et installer la gcloud CLI

La version actuelle de la gcloud CLI est 589.0.0.

Bien que nous vous recommandions vivement d'utiliser la version actuelle de la gcloud CLI, vous pouvez également télécharger et installer des versions antérieures à partir des archives de téléchargement.

Si vous utilisez Cloud Shell, la gcloud CLI est disponible automatiquement et vous n'avez pas besoin de l'installer. Sinon, téléchargez et installez la gcloud CLI puis initialisez-la.

Par défaut, la gcloud CLI installe les commandes qui sont en disponibilité générale. Des fonctionnalités supplémentaires sont disponibles dans les composants de la gcloud CLI nommés alpha, beta, et preview. Ces composants vous permettent d'utiliser la gcloud CLI pour travailler avec Bigtable, Dataflow et d'autres éléments de Google Cloud alors même qu'ils ne sont pas encore en disponibilité générale.

Aide-mémoire de la gcloud CLI

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

Niveaux de version

Les commandes de la gcloud CLI présentent les niveaux de version suivants :

Niveau de version Libellé Description
Disponibilité générale Aucun Les commandes sont considérées comme totalement stables et disponibles pour une utilisation en production use. Pour être informé à l'avance des modifications apportées aux commandes qui interrompent les fonctionnalités actuelles consultez les notes de version.
Aperçu preview Les commandes sont au niveau de version preview, utilisé pour recueillir les commentaires des clients. Les offres en Preview sont souvent annoncées publiquement, mais elles ne comportent pas nécessairement des fonctionnalités complètes, et ne sont associées à aucun contrat de niveau de service ni aucune obligation d'assistance technique Sauf indication contraire de la part de Google, les offres en Preview sont destinées à être utilisées dans des environnements de test uniquement. La phase Preview dure environ six mois.
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, beta et preview ne sont pas installés par défaut lorsque vous installez la gcloud CLI. 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, bêta ou preview et que le composant correspondant n'est pas installé, la gcloud CLI vous invite à l'installer.

Groupes de commandes

Dans chaque niveau de version, les commandes de la gcloud CLI sont organisées en une hiérarchie imbriquée de groupes de commandes, chacun représentant un produit ou une fonctionnalité de Google Cloud ou 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 preview Commandes associées à Google Cloud en version Preview
gcloud alpha app Commandes associées à la gestion des déploiements App Engine en version alpha

Exécuter des commandes de la gcloud CLI

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

Propriétés

Les propriétés de la gcloud CLI sont des paramètres qui affectent le comportement des outils de la gcloud CLI. 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 plus fluide avec le lecteur d'écran, la gcloud CLI est fournie avec 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 la gcloud CLI. Elle fonctionne comme un profil.

Lorsque vous commencez à utiliser la gcloud CLI, vous travaillez avec une seule configuration nommée default. Vous pouvez 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 configurer plusieurs configurations avec gcloud config configurations create et passer de l'une à l'autre. 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 gcloud CLI fournit un ensemble de options qui régissent le comportement des commandes à chaque appel. Les options remplacent les valeurs définies dans les propriétés de la gcloud CLI.

Arguments et options positionnels

Bien que les arguments et les options positionnels affectent la sortie d'une commande de la gcloud CLI, il existe une légère différence dans leurs cas d'utilisation. Un argument positionnel est utilisé pour définir une entité sur laquelle une commande opère, tandis qu'une option est nécessaire pour définir une variation dans le comportement d'une commande.

Utilisation de stdout et stderr

La sortie des commandes de la gcloud CLI réussies est écrite dans stdout. Tous les autres types de réponses (invites, avertissements et erreurs) sont écrits dans stderr. Ne créez pas de script selon les réponses écrites dans stderr, car elles ne sont pas stables.

Pour obtenir des instructions sur la gestion de la sortie, consultez le guide de création de scripts.

Rédaction de prompts

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

Vous pouvez être invité à fournir des informations supplémentaires. 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 les invites, écrire sur le terminal et journaliser

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

Pour supprimer 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 le niveau de détail des journaux, spécifiez un niveau de détail (debug, info, warning, error, critical ou none) à l'aide de l' --verbosity option.

Déterminer la structure du résultat

Par défaut, lorsqu'une commande de la gcloud CLI renvoie une liste de ressources, celles-ci sont affichées sur la sortie standard. Pour produire une sortie plus significative, les options format, filter et projection vous permettent d'affiner votre sortie.

Pour définir uniquement le format de votre sortie, utilisez l'option --format afin de générer une version tabulée ou aplatie de votre sortie (pour un affichage interactif) ou une version lisible par machine de la sortie (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 filtre et de format, vous pouvez suivre un tutoriel interactif rapide en cliquant sur Ouvrir dans Cloud Shell.

Ouvrir dans Cloud Shell

Étape suivante