Cette page contient une présentation de Google Cloud CLI, ainsi que de ses modèles et fonctionnalités de commande 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 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 gcloud CLI 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 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 version 481.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 des téléchargements.
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 initialize.
Par défaut, la gcloud CLI installe les commandes disponibles sous le statut Disponibilité générale. Des fonctionnalités supplémentaires sont disponibles dans les composants de la gcloud CLI nommés alpha et beta. Ces composants vous permettent d'utiliser la gcloud CLI pour travailler avec Bigtable, Dataflow et d'autres parties de Google Cloud à des niveaux de version antérieurs à la disponibilité générale.
Aide-mémoire de la gcloud CLI
Pour obtenir une présentation rapide de la gcloud CLI, obtenir la liste des commandes couramment utilisées et découvrir la structure de ces commandes, consultez l'aide-mémoire de gcloud CLI.
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 affectant 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 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 ou bêta et que le composant correspondant n'est pas installé, la gcloud CLI vous invite à l'installer.
Groupes de commandes
À chaque niveau de version, les commandes de la gcloud CLI 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 des commandes de gcloud CLI à partir de la ligne de commande et depuis des scripts et d'autres mécanismes d'automatisation (par exemple, avec Jenkins pour automatiser des tâches Google Cloud).
Propriétés
Les propriétés de la gcloud CLI sont des paramètres qui influent sur le comportement des outils de la gcloud CLI. Certaines de ces propriétés peuvent être définies à l'aide d'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 la gcloud CLI, vous utilisez 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 travailler avec 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 gcloud CLI 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 gcloud CLI.
Options et arguments positionnels
Bien que les options et les arguments positionnels affectent le résultat d'une commande de gcloud CLI, il existe une différence subtile dans leurs cas d'utilisation. Un argument positionnel permet de définir une entité sur laquelle s'exécute une commande, tandis qu'une option est requise pour définir une variation du comportement d'une commande.
Utilisation de stdout et de stderr
Le résultat des commandes de gcloud CLI 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 avec les réponses écrites dans stderr, car ces réponses ne sont pas stables.
Pour obtenir des instructions sur la gestion des résultats, reportez-vous au guide de script.
Invites
Pour vous protéger contre les actions de destruction inattendues, 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 êtes invité à choisir une zone lorsque vous créez 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'option --quiet (également, -q) de la gcloud CLI désactive toutes les invites interactives lors de l'exécution de commandes de CLI gcloud et est utile pour les scripts. Si une entrée est nécessaire, les valeurs par défaut sont utilisées. En l'absence de valeur par défaut, une erreur est générée.
Pour supprimer l'affichage 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 détail (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 gcloud CLI renvoie une liste de ressources, celles-ci sont mises en forme et affichées sur la sortie standard. Pour obtenir un résultat plus pertinent, 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 générer une version tabulée 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
- Consultez la documentation de référence de la gcloud CLI pour en savoir plus sur les commandes de gcloud CLI.