Présentation de l'outil gcloud

Cette page contient une présentation de l'outil de ligne de commande gcloud, de ses modèles de commande courants et de ses capacités.

Qu'est-ce que l'outil gcloud ?

L'outil de ligne de commande gcloud est l'outil CLI principal qui permet de créer et de gérer les ressources Google Cloud. Cet outil permet d'effectuer de nombreuses tâches courantes sur la plate-forme, à partir de la ligne de commande ou dans des scripts et autres mécanismes d'automatisation.

Par exemple, vous pouvez utiliser l'outil 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 l'outil gcloud pour déployer des applications App Engine, gérer l'authentification, personnaliser la configuration locale et effectuer d'autres tâches. Pour en savoir plus sur les fonctionnalités de l'outil gcloud, consultez la documentation de référence sur l'outil gcloud.

Aide-mémoire de l'outil gcloud

Pour une présentation rapide dugcloud et une liste de commandes couramment utilisées, ainsi que la structure de ces commandes, reportez-vous augcloud aide-mémoire (Installation de Python groupée).

Outil gcloud et SDK Cloud

L'outil gcloud fait partie du SDK Cloud. Avant d'utiliser l'outil gcloud, vous devez télécharger et installer le SDK Cloud sur votre système et initialiser le SDK Cloud .

Par défaut, le SDK Cloud installe les commandes de l'outil gcloud au niveau "Disponibilité générale". Des fonctionnalités supplémentaires sont disponibles dans les composants du SDK Cloud nommés alpha et beta. Ces composants vous permettent d'utiliser l'outil gcloud avec Cloud Bigtable, Dataflow et d'autres parties de Google Cloud à des niveaux de version antérieurs à la disponibilité générale.

Les versions de l'outil gcloud ont le même numéro de version que le SDK Cloud. La version actuelle du SDK Cloud est 365.0.1. Vous pouvez télécharger et installer les versions précédentes du SDK Cloud à partir de l'archive des téléchargements.

Télécharger l'outil gcloud

Vous pouvez télécharger la dernière version du SDK Cloud (qui inclut l'outil gcloud) sur la page de téléchargement.

Niveaux de version

Les commandes de l'outil 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 perturbent la fonctionnalité actuelle, consultez les notes de version.
Bêta beta Les commandes sont complètes sur le plan fonctionnel, mais elles peuvent toujours présenter des problèmes en suspens. Il est possible d'apporter des modifications importantes à 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 avec le SDK Cloud. 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é, l'outil gcloud vous invite à l'installer.

Groupes de commandes

À chaque niveau de version, les commandes de l'outil 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 les commandes de l'outil gcloud

Vous pouvez exécuter les commandes de l'outil gcloud à partir de la ligne de commande de la même façon que pour les autres outils de ligne de commande. Vous pouvez également exécuter les commandes de l'outil gcloud à partir de 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 l'outil gcloud sont des paramètres qui régissent le comportement de l'outil gcloud et des autres outils du SDK Cloud. Certaines de ces propriétés peuvent être définies à l'aide d'indicateurs globaux ou de commande. Dans ce cas, la valeur définie par l'indicateur est prioritaire.

Activer les fonctionnalités d'accessibilité

Pour une expérience de lecture plus fluide, l'outil gcloud possède une propriété accessibility/screen_reader.

Pour activer cette propriété, exécutez la commande suivante :

gcloud config set accessibility/screen_reader true

Pour en savoir plus sur les fonctionnalités d'accessibilité fournies avec l'outil de ligne de commande gcloud, consultez le guide Activer les fonctionnalités d'accessibilité.

Configurations

Une configuration est un ensemble nommé de propriétés de l'outil gcloud. Une configuration fonctionne comme un profil.

Lorsque vous commencez à utiliser le SDK Cloud, vous utilisez une configuration unique 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 elles. 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

L'outil gcloud fournit un ensemble d'options à l'échelle de l'outil gcloud qui régissent le comportement des commandes à chaque appel. Les options remplacent les valeurs définies dans les propriétés du SDK Cloud.

Options et arguments positionnels

Bien que les options et les arguments positionnels affectent le résultat d'une commande d'outil gcloud, il existe une légère différence dans leurs cas d'utilisation. Un argument positionnel permet de définir une entité sur laquelle une commande agit, tandis 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 gcloud réussies de l'outil est écrit dans stdout. Tous les autres types de réponses (invites, avertissements et erreurs) sont écrits dans stderr. N'exécutez pas de scripts sur les réponses écrites dans stderr, car ces réponses ne sont pas stables.

Pour en savoir plus sur la gestion des résultats, consultez le guide de la création de scripts.

Invites

Pour empêcher les actions potentiellement destructives ou non souhaitées, l'outil gcloud vous demande de confirmer vos intentions avant d'exécuter des commandes telles que gcloud projects delete.

Vous pouvez également vous attendre à des invites si vous créez une instance de machine virtuelle Compute Engine à l'aide de gcloud compute instances create test-instance. Vous êtes invité à choisir la zone dans laquelle créer l'instance.

Pour désactiver les invites, utilisez l'option --quiet.

N'utilisez pas de script contre le texte des invites, car celui-ci est susceptible de changer.

Supprimer les invites, écrire sur le terminal et journaliser

L'option --quiet (ou -q) de l'outil gcloud désactive toutes les invites interactives lors de l'exécution des commandes de l'outil gcloud. 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'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 régler la verbosité des journaux, spécifiez un niveau de verbosité (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 l'outil gcloud renvoie une liste de ressources, celles-ci sont présentées sous forme de résultat standard. Pour produire des résultats plus pertinents, les options format, filter et projection vous permettent d'ajuster votre sortie.

Pour définir uniquement le format de votre résultat, utilisez l'option --format afin de produire une version tabulée ou dégroupée de votre résultat (pour l'affichage interactif), ou une machine. Version lisible du résultat (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.

Ouvrir dans Cloud Shell

Étape suivante