Cette page présente la Google Cloud CLI, ainsi que ses modèles de commande courants et ses capacités.
Qu'est-ce que la gcloud CLI ?
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 solutions 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.
Télécharger et installer la gcloud CLI
La version actuelle de la gcloud CLI est la version 496.0.0.
Bien que nous vous recommandions vivement d'utiliser la version actuelle de gcloud CLI, vous pouvez aussi télécharger et installer à 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écharger et installer la gcloud CLI, puis initialisez-la.
Par défaut, la gcloud CLI installe
commandes qui sont en Disponibilité générale. D'autres fonctionnalités sont
disponible dans la gcloud CLI
composants nommés alpha et beta. Ces composants vous permettent d'utiliser la CLI gcloud pour travailler avec Bigtable, Dataflow et d'autres composants de Google Cloud, avec des versions plus récentes que celles en disponibilité générale.
Aide-mémoire de la gcloud CLI
Pour découvrir une présentation rapide de la gcloud CLI, une liste des commandes couramment utilisées et un aperçu de leur structure, consultez l'aide-mémoire de la 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 | Aucun | Les commandes sont considérées comme totalement stables et disponibles pour une utilisation en production. Pour un avis préalable en cas de modifications apportées aux commandes consultez la 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
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 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 la gcloud CLI à partir de la ligne de commande et à partir de scripts et autres automatisations, 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 régissent le comportement des outils de la CLI gcloud. 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 CLI gcloud possède 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 CLI gcloud. A fonctionne comme un profil.
Lorsque vous commencerez à utiliser la gcloud CLI, vous travaillerez avec un seul
de configuration nommée default. Vous pouvez définir les 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 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 Options de la gcloud CLI qui régissent le comportement des commandes appel par appel. Remplacement des options 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 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 alors qu'une option est requise pour définir une variation dans le comportement d'une commande.
Utilisation de stdout et stderr
Le résultat des commandes de CLI gcloud ayant abouti est écrit dans stdout. Tous les autres types de réponses (invites, avertissements et erreurs) sont
écrit dans stderr. Ne créez pas de script pour les réponses écrites dans stderr, car elles ne sont pas stables.
Pour obtenir des instructions sur la gestion des résultats, reportez-vous au Guide de rédaction
Invites
Pour vous protéger contre les actions de destruction inattendues, la gcloud CLI
pour confirmer vos intentions avant d'exécuter des commandes
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 les invites, écrire sur le terminal et journaliser
L'option --quiet (ou sa forme abrégé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. S'il y a
n'est pas une 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é (debug, info, warning,
d'erreur, critique ou aucun) à l'aide de l'attribut
--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 et affichées sur la sortie standard. Pour produire des images plus significatives
les options format, filter et projection vous permettent d'affiner
votre sortie.
Pour définir uniquement le format de la sortie, utilisez la fonction
L'option --format pour générer un tableau
ou aplatie de votre sortie (pour un affichage interactif) ou
une version de la sortie lisible par l'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 effectuer une rapide interactif en cliquant sur Ouvrir dans Cloud Shell.
Étape suivante
- Pour en savoir plus sur les commandes de la gcloud CLI, consultez la documentation de référence de la gcloud CLI.