Cette page présente la CLI Google Cloud ainsi que ses fonctionnalités et modèles de commande courants.
Qu'est-ce que gcloud CLI ?
Google Cloud CLI 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 mécanismes 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 de la CLI gcloud
Pour une présentation rapide de la CLI gcloud, une liste des commandes couramment utilisées et une présentation de la structure de ces commandes, consultez l'aide-mémoire pour la CLI 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. Sinon, téléchargez et installez la CLI gcloud, puis initialisez-la.
Par défaut, la commande gcloud de la CLI installe des commandes au niveau de 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 parties de Google Cloud à des niveaux de version antérieurs à la disponibilité générale.
La version actuelle de la CLI gcloud est la 397.0.0. Vous pouvez télécharger et installer les versions précédentes de la CLI gcloud à partir de l'archive des téléchargements.
Niveaux de version
Les commandes de la CLI gcloud comportent 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 perdent des fonctionnalités actuelles, 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 la CLI gcloud sont organisées selon une hiérarchie imbriquée de groupes de commandes, représentant chacun 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 les commandes de CLI gcloud à partir de la ligne de commande ou à partir de scripts et autres automatisations, par exemple lorsque vous utilisez Jenkins pour automatiser des tâches Google Cloud.
Propriétés
Les propriétés de la CLI gcloud 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 des commandes. Dans ce cas, la valeur définie par l'option est prioritaire.
Activer les fonctionnalités d'accessibilité
Pour une expérience de lecteur d'écran simplifiée, la CLI gcloud est fournie avec une propriété accessibility/screen_reader.
Pour activer la propriété 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 commencez à utiliser la CLI gcloud, vous travaillez avec une seule configuration nommée default, et 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 utiliser plusieurs projets ou comptes d'autorisation, vous pouvez définir plusieurs configurations avec gcloud config configurations create et basculer entre les 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 positionnels
Bien que les options et les arguments positionnels affectent le résultat d'une commande de la CLI gcloud, il existe une différence subtile dans leurs cas d'utilisation. Un argument positionnel est utilisé pour définir une entité sur laquelle une commande fonctionne, tandis qu'une option est requise pour définir une variante dans le comportement d'une commande.
Utilisation de stdout et de stderr
Le résultat des commandes de CLI gcloud réussies est écrit dans stdout. Tous les autres types de réponses (invites, avertissements et erreurs) sont écrits dans stderr. N'exécutez pas de script sur les réponses écrites dans stderr, car elles ne sont pas stables.
Pour plus d'informations sur la gestion des résultats, reportez-vous au guide sur les scripts.
Invites
Pour vous protéger contre les actions de destruction inattendues, la CLI gcloud confirme vos intentions avant d'exécuter des commandes telles que gcloud projects delete.
Vous serez peut-ê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 des invites, écrire sur le terminal et effectuer une journalisation
L'option --quiet (également appelée -q) de la gcloud CLI désactive toutes les invites interactives lors de l'exécution de commandes 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'y a 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 la verbosité des journaux, spécifiez un niveau de verbosité (débogage, informations, avertissement, erreur, niveau 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 mises en forme sur la sortie standard. Pour obtenir des résultats plus significatifs, les options format, filter et projection vous permettent de l'affiner.
Pour définir uniquement le format de votre sortie, utilisez l'option --format pour produire une version tabulaire ou aplatie de votre sortie (pour un affichage interactif) ou une version lisible par un ordinateur (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.
Étapes suivantes
- Pour en savoir plus sur les commandes de CLI gcloud, consultez la documentation de référence de la CLI gcloud.