Présentation de la gcloud CLI

Cette page présente Google Cloud CLI, ainsi que ses modèles de commande et ses fonctionnalités courants.

Qu'est-ce que la gcloud CLI ?

La Google Cloud CLI est un ensemble d'outils permettant de créer et de gérer des ressourcesGoogle 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 mécanismes 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 jobs 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 la 590.0.0.

Bien que nous vous recommandions vivement d'utiliser la version actuelle de gcloud CLI, vous pouvez également télécharger et installer les versions précédentes à partir de l'archive 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, gcloud CLI installe les commandes proposées en version Disponibilité générale. Des fonctionnalités supplémentaires sont disponibles dans les composants de 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 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 gcloud CLI ont 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. 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 en version preview, utilisée pour recueillir les commentaires des clients. Les offres en version 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 versions preview ne sont destinées à être utilisées que dans des environnements de test. La phase d'aperçu 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 en version 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 gcloud CLI sont organisées selon une hiérarchie imbriquée de groupes de commandes, chacun 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 preview Commandes lié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 gcloud CLI

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

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 de lecture d'écran plus fluide, 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. Une configuration fonctionne comme un profil.

Lorsque vous commencez à utiliser 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 basculer entre elles. Vous pouvez personnaliser les propriétés d'une configuration. 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 d'options gcloud CLI 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 positionnels et options

Bien que les arguments positionnels et les options affectent le résultat d'une commande gcloud CLI, il existe une différence subtile dans leurs cas d'utilisation. Un argument positionnel permet de définir une entité sur laquelle une commande s'exécute, tandis qu'une option est requise pour définir une variation du comportement d'une commande.

Utilisation de stdout et stderr

Le résultat des commandes gcloud CLI réussies est écrit dans stdout. Tous les autres types de réponses (invites, avertissements et erreurs) sont écrits dans stderr. N'écrivez pas de script pour les réponses écrites dans stderr, car ces réponses ne sont pas stables.

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

Rédaction de prompts

Pour vous protéger contre les actions destructrices 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 si nécessaire. 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 l'invite, 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'option --quiet (également -q) de la gcloud CLI désactive toutes les invites interactives lors de l'exécution de commandes de la gcloud CLI. Elle est utile pour les 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 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'option --verbosity.

Déterminer la structure du résultat

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

Pour définir uniquement le format de votre sortie, utilisez l'option --format afin de produire une version tabulée ou aplatie de votre sortie (pour l'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.

Étapes suivantes