Aide-mémoire de la gcloud CLI

Liste des commandes d'accès à la Google Cloud CLI, l'outil de ligne de commande principal pour Google Cloud

(Également inclus : introduction, comprendre les commandes et document PDF imprimable.)

Aide-mémoire

Comment en profiter ?

Lancez-vous avec gcloud CLI.

Aide

gcloud CLI se fera un plaisir de vous aider.

  • gcloud help: recherchez des termes spécifiques dans la documentation de référence de la gcloud CLI.
  • gcloud feedback: envoyer des commentaires à l'équipe de gcloud CLI.
  • gcloud topic : documents d'aide supplémentaires sur des sujets autres que les commandes, tels que l'accessibilité, le filtrage et la mise en forme.

Personnalisation

Personnalisez la gcloud CLI ; personnalisez votre configuration avec des propriétés.

Autorisation et identifiants

Accordez et révoquez l'autorisation d'accès à la gcloud CLI, et gérez les identifiants.

Projets

Gérer les règles d'accès aux projets

IAM

Configurer les préférences et les comptes de service IAM (Identity and Access Management)

Docker et Google Kubernetes Engine (GKE)

Gérez des applications conteneurisées sur Kubernetes

Machines virtuelles et Compute Engine

Créez, exécutez et gérez des VM sur l'infrastructure Google Cloud.

Plate-forme sans serveur et App Engine

Créez des applications hautement évolutives sur une plate-forme sans serveur entièrement gérée

Divers

Commandes pouvant être utiles

Introduction

Présentation rapide de gcloud CLI.

Installer Google Cloud CLI

Installez la Google Cloud CLI en suivant ces instructions d'installation.

Options, arguments et autres ajouts exceptionnels

Les arguments peuvent être des indicateurs ou des arguments positionnels:

  • Arguments positionnels : définis après le nom de la commande. Ils doivent respecter l'ordre des arguments positionnels.

  • Options : définies après les arguments de position. L'ordre des options n'a pas d'importance.

    Une option peut être l'un des deux éléments suivants :

    • Paire nom/valeur (--foo=bar), ou
    • Booléen (--force/no-force).

    Les options peuvent également être du type suivant :

    • Obligatoire
    • Facultatif:si aucun indicateur facultatif n'est défini, la valeur par défaut est utilisée.

Options globales

Certains indicateurs sont disponibles dans l'interface de gcloud CLI, par exemple:

  • --help : en cas de doute, permet d'afficher une aide détaillée sur une commande.
  • --project : si vous utilisez un projet autre que le projet actuel.
  • --quiet : désactive des invites interactives (et applique des valeurs par défaut pour les entrées).
  • --verbosity : peut définir des niveaux de détail dans les champs debug, info, warning, error, critical et none.
  • --version : affiche les informations de version de l'outil gcloud.
  • --format : définit les formats de résultats config, csv, default, diff, disable, flattened, get, json, list, multi, none, object, table, text, valueou yaml.

Nettoyer les résultats

Extrayez des résultats plus précis grâce aux options de filtre, de format, de limite et de tri.

Pour les instances Compute Engine associées au préfixe us et non au type de machine f1-micro :

gcloud compute instances list --filter="zone ~ ^us AND -machineType:f1-micro"

Pour obtenir la liste des projets créés à partir du 15 janvier 2018, triés du plus ancien au plus récent, présentés sous forme de table comprenant les numéros de projet, les ID de projet et les colonnes de date de création indiquant des dates et des heures dans le fuseau horaire local :

gcloud projects list --format="table(projectNumber,projectId,createTime.date(tz=LOCAL))"
--filter="createTime>=2018-01-15T12:00:00" --sort-by=createTime

Pour obtenir une liste de dix instances Compute Engine associées au libellé my-label (de n'importe quelle valeur) :

gcloud compute instances list --filter="labels.my-label:*" --limit=10

Comprendre les commandes

Modèles sous-jacents pour les commandes de gcloud CLI, pour faciliter l'auto-découverte des commandes

Rechercher les commandes de gcloud CLI

La gcloud CLI est une arborescence. Les nœuds non-feuilles sont des groupes de commandes, et les nœuds feuilles sont des commandes. (En outre, la saisie semi-automatique via la touche de tabulation fonctionne pour les commandes et les ressources !)

La plupart des commandes gcloud suivent le format suivant:

gcloud + release level (optional) + component + entity + operation + positional args + flags

Par exemple : gcloud + compute + instances + create + example-instance-1 + --zone=us-central1-a

Niveau de version

Le niveau de version fait référence à l'état de publication de la commande.

Exemple : alpha pour les commandes alpha, beta pour les commandes en version bêta, pas de niveau de version nécessaire pour les commandes disponibles à tous les utilisateurs.

Composant

Le composant fait référence aux différents services Google Cloud.

Exemple : compute pour Compute Engine, app pour App Engine, etc.

Entité

Le terme Entité désigne la forme plurielle d'un élément ou d'un ensemble d'éléments sous un composant.

Exemple : disks, firewalls, images, instances, regions, zones pour le calcul

Opération

L'opération fait référence à la forme de verbe impérative de l'opération à effectuer sur l'entité.

Exemple : Les opérations courantes sont describe, list, create/update, delete/clear, import, export, copy, remove, add, reset, restart, restore, run et deploy.

Arguments positionnels

Les arguments positionnels désignent les arguments requis, spécifiques à la commande, pour exécuter la commande.

Exemple : <INSTANCE_NAMES> est l'argument positionnel requis pour gcloud compute instances create.

Options

Les options font référence aux arguments supplémentaires, --flag-name(=value), transmis à la commande après les arguments positionnels.

Exemple : --machine-type=<MACHINE_TYPE> et --preemptible sont des options facultatives pour gcloud compute instances create.