Aide-mémoire sur l'outil gcloud

Aide-mémoire gcloud

Liste de commandes go-to pour l'outil de ligne de commande gcloud, l'outil de ligne de commande principal de Google Cloud.

(Également inclus: une présentation d'introduction, des commandes de compréhension, ainsi qu'un fichier PDF imprimable.)

Aide-mémoire

Premiers pas

Faites vos premiers pas avec l'outil gcloud.

Aide

Le SDK Cloud est là pour vous aider.

  • gcloud help : recherche des termes spécifiques dans l'outil gcloud.
  • gcloud feedback: envoyer des commentaires à l'équipe SDK Cloud
  • 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 le SDK Cloud ; personnalisez votre configuration à l'aide de propriétés.

Identifiants

Accorder et révoquer l'autorisation sur le SDK Cloud

Projets

Gérer les règles d'accès au projet

IAM

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

Docker et Google Kubernetes Engine (GKE)

Gérer des applications en conteneur 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

Introduction rapide à l'outil gcloud.

Installation du SDK Cloud

Installez le SDK Cloud en suivant ces instructions d'installation.

Options, arguments et autres ajouts exceptionnels

Les arguments peuvent être des arguments positionnels ou des options.

  • 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 : dans ce cas, la valeur par défaut est utilisée si l'option n'est pas définie.

Options globales

Certaines options sont disponibles tout au long de l'expérience de l'outil gcloud, 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

Exploitez tout le potentiel de vos résultats grâce aux options de filtre, de format, de limite et de tri.

Pour les instances Compute Engine avec le préfixe us et non le 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 la liste de 10 instances Compute Engine avec une étiquette my-label (de n'importe quelle valeur):

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

Comprendre les commandes

les modèles sous-jacents aux commandes de l'outil gcloud ; pour faciliter la découverte des commandes.

Recherche des commandes de l'outil gcloud

L'outil gcloud est une arborescence ; les nœuds non-feuilles sont des groupes de commande et les nœuds feuille 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 utilisent le format suivant :

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

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.

Flags

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.