Présentation de l'outil gcloud

Cette page présente l'outil de ligne de commande gcloud et présente ses fonctionnalités et modèles de commande courants.

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 machine virtuelle Compute Engine et autres ressources
  • Instances Cloud SQL
  • Clusters GKE
  • Clusters et tâches Dataproc
  • Zones gérées et jeux d'enregistrements 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 plus d'informations sur les fonctionnalités de l'outil gcloud, consultez la documentation de référence de l'outil gcloud.

Aide-mémoire 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).

L'outil gcloud et le SDK Cloud

L'outil gcloud fait partie du SDK Cloud. Vous devez télécharger et installer le SDK Cloud sur votre système et l'initialiser pour pouvoir utiliser l'outil gcloud.

Par défaut, le SDK Cloud n'installe que les commandes de l'outil gcloud au niveau de 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 éléments 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 358.0.0. 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. Des avertissements préalables seront émis pour les commandes entraînant des problèmes de fonctionnement et ajoutés aux notes de version.
Bêta beta Les commandes sont complètes sur le plan fonctionnel, mais il reste peut-être des problèmes en suspens. Des modifications importantes 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 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 des commandes de l'outil gcloud

Vous pouvez exécuter les commandes de l'outil de ligne de commande gcloud à partir de la ligne de commande de la même manière 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 outils 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 influent sur le comportement de l'outil gcloud et d'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 simplifier l'expérience du lecteur d'écran, l'outil gcloud inclut une propriété accessibility/screen_reader.

Pour activer cette propriété, 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 nommé de propriétés de l'outil gcloud. Elle fonctionne comme un profil.

À vos débuts sur 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.

Si vous souhaitez travailler avec plusieurs projets ou comptes d'autorisation, vous pouvez établir plusieurs configurations avec gcloud config configurations create et basculer de l'une à l'autre au besoin. Ces configurations vous permettent de personnaliser les propriétés. Par exemple, pour définir le 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.

Arguments et indicateurs de position

Bien que les indicateurs et les arguments positionnels affectent le résultat d'une commande gcloud, il existe une légère différence dans leurs cas d'utilisation. Un argument positionnel est utilisé pour définir une entité sur laquelle opère une commande, tandis qu'une option est requise pour définir une variante du comportement d'une commande.

Utilisation de stdout et stderr

Le résultat des commandes de l'outil gcloud a été écrit dans stdout. Tous les autres types de réponses (invites, avertissements et erreurs) sont écrits dans stderr. Notez que tout ce qui est écrit dans stderr n’est pas stable et ne doit pas faire l’objet de scripts.

Pour obtenir la liste définitive des directives de gestion des résultats, consultez le guide des scripts.

Invites

Pour éviter les actions destructives involontaires, l'outil gcloud confirme 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, par exemple "test-instance", à l'aide de gcloud compute instances create test-instance. Vous serez invité à choisir la zone dans laquelle créer l'instance.

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

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. Elle est très utile lorsque vous créez un script. Si une entrée est requise, les valeurs par défaut sont utilisées. S'il n'y a pas de valeurs 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.

Si vous préférez ajuster la verbosité des journaux, appliquez l'option --verbosity avec un niveau approprié :"debug" (débogage), "info" (informations), "warning" (avertissements), "error" (erreurs), "critical" (critique) ou "none" (aucun).

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 imprimées dans une sortie standard. Pour produire des résultats plus pertinents, les options de format, de filtrage et de projection vous permettent d'affiner votre sortie.

Si vous souhaitez définir uniquement le format des résultats, utilisez l'option --format pour produire une version tabulée ou aplatie du résultat (pour un affichage interactif) ou une version exploitable 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.

Si vous souhaitez suivre un tutoriel interactif rapide afin de vous familiariser avec les fonctionnalités de filtre et de mise en forme, suivez le lien ci-dessous.

Ouvrir dans Cloud Shell

Étape suivante