Présentation de l'outil de ligne de commande 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 de ligne de commande gcloud ?

L'interface de ligne de commande gcloud est le principal outil CLI pour créer et 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 la CLI gcloud pour créer et gérer les éléments suivants :

  • Instances de machines virtuelles et autres ressources Google Compute Engine
  • Instances Google Cloud SQL
  • Clusters Google Kubernetes Engine
  • Clusters et tâches Google Cloud Dataproc
  • Ensembles d'enregistrements et zones gérées Google Cloud DNS
  • Déploiements Google 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. Consultez la documentation de référence de la CLI gcloud pour en savoir plus sur les fonctions de cet outil.

Aide-mémoire de l'outil de ligne de commande gcloud

Pour une introduction rapide de l'outil de ligne de commande gcloud, une liste des commandes couramment utilisées et un aperçu de leur structure, reportez-vous à l'aide-mémoire de l'outil de ligne de commande gcloud.

La CLI gcloud et le SDK Cloud

La CLI gcloud fait partie du SDK Google Cloud. Vous devez télécharger et installer le SDK sur votre système et l'initialiser avant de pouvoir utiliser l'outil de ligne de commande gcloud.

Par défaut, le SDK n'installe que les commandes de CLI gcloud ayant atteint le niveau de version Disponibilité générale. Des fonctionnalités supplémentaires sont disponibles dans les composants du SDK nommés alpha et beta. Ces composants vous permettent d’utiliser la CLI gcloud pour travailler avec Google Cloud Bigtable, Google Cloud Dataflow et d’autres éléments de Cloud Platform à des niveaux de version moins stables que la Disponibilité générale.

Les versions de la CLI gcloud possèdent le même numéro de version que le SDK. Le SDK est actuellement en version 314.0.0. Vous pouvez télécharger et installer les versions précédentes du SDK à partir de l’archive des téléchargements.

Télécharger l'outil de ligne de commande gcloud

Vous pouvez télécharger la dernière version du SDK Cloud, qui comprend l'outil de ligne de commande gcloud, depuis la page de téléchargement.

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. 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 avec le SDK. 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 de ligne de commande 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 Cloud Platform 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 de la même manière que vous utiliseriez d'autres outils de ligne de commande. Vous pouvez également exécuter les commandes de CLI gcloud à partir de scripts et d'autres mécanismes d'automatisation, par exemple, avec Jenkins pour automatiser des tâches Cloud Platform.

Propriétés

Les propriétés de CLI gcloud sont des paramètres qui régissent le comportement de la CLI 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 d'écran plus fluide, l'outil de ligne de commande 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 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 CLI gcloud. Elle fonctionne globalement 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

La CLI gcloud fournit un ensemble d'indicateurs à l'échelle de la CLI gcloud qui régissent le comportement des commandes appel par appel. Les indicateurs remplacent les valeurs définies dans les propriétés du SDK.

Indicateurs et arguments positionnels

Bien que les indicateurs 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 permet de définir une entité sur laquelle une commande agit, tandis qu'un indicateur est requis 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 é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 empêcher les actions potentiellement destructives ou non souhaitées, la CLI 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 Google Compute Engine, par exemple "test-instance", à l'aide de la commande 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.

Remarque : La formulation des invites peut changer et ne doit pas faire l'objet de scripts.

Supprimer des invites, écrire sur le terminal et effectuer une journalisation

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 s'avère particulièrement pratique pour rédiger des scripts. Si une entrée est nécessaire, les valeurs par défaut sont utilisées. S'il n'en existe pas, 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 CLI gcloud renvoie une liste de ressources, celles-ci sont mises en forme et affichées sur la sortie standard. Pour produire des résultats plus significatifs, les indicateurs de format, de filtre et de projection permettent des ajustements.

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