gcloud compute

L'outil de ligne de commande gcloud permet de gérer les ressources Compute Engine à l'aide du groupe de commandes gcloud compute. gcloud compute est une alternative à l'utilisation de l'API Compute Engine.

L'outil gcloud fait partie du SDK Cloud. Cet outil de ligne de commande unifié intègre des fonctionnalités telles que la saisie semi-automatique des instructions, la mise à jour sur place, une aide associée à la ligne de commande, des formats de sortie lisibles et analysables, ainsi que l'intégration au SDK Cloud.

Si vous n'avez jamais utilisé Compute Engine, commencez par consulter le guide de démarrage rapide pour Linux ou le guide de démarrage rapide pour Windows.

Avant de commencer

  • Si vous souhaitez exécuter gcloud compute dans une invite de commande, installez, mettez à jour et initialisez le SDK Cloud.
  • Si vous n'avez pas d'invite de commande à votre disposition, essayez d'utiliser gcloud compute dans Cloud Shell. Cloud Shell est automatiquement installé, mis à jour et initialisé avec la dernière version du SDK Cloud.

Propriétés par défaut

Lorsque vous créez une instance de machine virtuelle, Compute Engine configure une VM à l'aide des propriétés par défaut du serveur de métadonnées. Vous pouvez vérifier les propriétés par défaut de votre VM en exécutant la commande suivante :

gcloud compute project-info describe --project PROJECT_ID

Remplacez PROJECT_ID par l'ID du projet.

Projet par défaut

Si vous définissez un projet par défaut lorsque vous configurez et initialisez le SDK Cloud, toutes les commandes gcloud compute utilisent cet ID de projet par défaut.

Vous pouvez remplacer l'ID de projet par défaut en utilisant l'une des méthodes suivantes :

  • Exécuter chaque commande gcloud compute avec l'option --project

  • Définir la variable d'environnement CLOUDSDK_CORE_PROJECT

    Linux et macOS

    Utilisez la commande export pour définir la variable d'environnement du projet.

    export CLOUDSDK_CORE_PROJECT=PROJECT_ID

    Remplacez PROJECT_ID par l'ID du projet que vous souhaitez utiliser par défaut.

    Annuler la définition des variables d'environnement du projet

    Si vous devez annuler la définition des variables d'environnement de votre projet, utilisez les commandes unset suivantes :

    unset CLOUDSDK_CORE_PROJECT

    Windows

    Utilisez la commande set pour définir la variable d'environnement du projet.

    set CLOUDSDK_CORE_PROJECT=PROJECT_ID

    Remplacez PROJECT_ID par l'ID du projet que vous souhaitez utiliser par défaut.

    Annuler la définition des variables d'environnement du projet

    Si vous devez annuler la définition des variables d'environnement de votre projet, utilisez la commande suivante :

    set CLOUDSDK_CORE_PROJECT=

Si vous ne définissez pas de projet par défaut ou de variable d'environnement, vous devez inclure une option --project dans chaque commande gcloud compute que vous exécutez.

Région et zone par défaut

Certaines commandes gcloud compute nécessitent les options --region ou --zone. Au lieu de spécifier ces options à chaque fois que vous exécutez des commandes, vous pouvez définir une région et une zone par défaut pour votre projet. Si vous ne définissez pas de région ni de zone par défaut, et que vous exécutez une commande dépendant de la région ou de la zone, l'outil de ligne de commande gcloud peut vous demander de fournir une option --region ou --zone, ou bien renvoyer une erreur.

Vous pouvez définir la région et la zone par défaut de trois manières :

  • Dans le serveur de métadonnées. La région et la zone par défaut définies dans le serveur de métadonnées sont appliquées à votre client local lorsque vous exécutez gcloud init.
  • Dans votre client local. La région et la zone par défaut définies dans votre client local remplacent celles définies dans le serveur de métadonnées.
  • Dans les variables d'environnement. La région et la zone par défaut définies dans les variables d'environnement remplacent celles définies dans votre client local et dans le serveur de métadonnées.

Vous pouvez remplacer la région et la zone par défaut dans le serveur de métadonnées, dans votre client local ou dans les variables d'environnement en fournissant les options --region et --zone lorsque vous exécutez des commandes.

Afficher la région et la zone par défaut

Pour afficher votre région et votre zone par défaut, exécutez les commandes suivantes :

gcloud config get-value compute/region
gcloud config get-value compute/zone

Si le résultat est (unset), aucune région ni aucune zone par défaut n'est définie.

Afficher les régions et les zones disponibles

Vous pouvez afficher la liste des régions et des zones en exécutant les commandes suivantes :

gcloud compute regions list
gcloud compute zones list

Définir la région et la zone par défaut dans le serveur de métadonnées

La région et la zone par défaut définies dans le serveur de métadonnées s'appliquent à toutes les configurations de votre projet. Pour définir la région et la zone par défaut dans le serveur de métadonnées, procédez comme suit :

  1. Définissez la région et la zone par défaut :

    gcloud compute project-info add-metadata \
   --metadata google-compute-default-region=REGION,google-compute-default-zone=ZONE

    Exemple :

    gcloud compute project-info add-metadata \
   --metadata google-compute-default-region=europe-west1,google-compute-default-zone=europe-west1-b

  2. Initialisez la modification dans votre client local :

    gcloud init

Vous pouvez remplacer la région et la zone par défaut définies dans le serveur de métadonnées. Pour ce faire, définissez la région et la zone par défaut dans votre client local, définissez-les dans les variables d'environnement, ou incluez l'option --zone ou --region dans vos commandes.

Annuler la définition de la région et de la zone par défaut dans le serveur de métadonnées

Pour annuler la définition de la région et de la zone par défaut dans le serveur de métadonnées, procédez comme suit :

  1. Annulez la définition des métadonnées :

    gcloud compute project-info remove-metadata \
   --keys=google-compute-default-region,google-compute-default-zone

  2. Initialisez la modification dans votre client local :

    gcloud init

Définir la région et la zone par défaut dans votre client local

La région et la zone par défaut définies dans votre client local remplacent celles définies dans le serveur de métadonnées.

Pour définir la région et la zone par défaut dans votre client local, exécutez les commandes suivantes :

gcloud config set compute/region REGION

gcloud config set compute/zone ZONE

Annuler la définition de la région et de la zone par défaut dans votre client local

Pour annuler la définition de la région ou de la zone par défaut dans votre client local, exécutez les commandes suivantes :

gcloud config unset compute/zone

gcloud config unset compute/region

Vous pouvez remplacer la région et la zone par défaut définies dans votre client local. Pour ce faire, définissez la région et la zone par défaut dans les variables d'environnement, ou incluez l'option --zone ou --region dans vos commandes.

Définir la région et la zone par défaut dans les variables d'environnement

La région et la zone par défaut définies dans les variables d'environnement remplacent celles définies dans votre client local et dans le serveur de métadonnées.

Linux et macOS

Exécutez la commande export pour définir les variables de région et de zone.

export CLOUDSDK_COMPUTE_REGION=REGION

export CLOUDSDK_COMPUTE_ZONE=ZONE

Pour rendre ces variables d'environnement permanentes, incluez ces commandes dans votre fichier ~/.bashrc, puis redémarrez votre terminal.

Windows

Exécutez la commande set pour définir les variables de région et de zone.

set CLOUDSDK_COMPUTE_REGION=REGION

set CLOUDSDK_COMPUTE_ZONE=ZONE

Vous pouvez remplacer les variables d'environnement en incluant l'option --zone ou --region dans vos commandes.

Annuler la définition de la région et de la zone par défaut dans les variables d'environnement

Exécutez les commandes suivantes pour annuler la définition de la région et de la zone par défaut dans les variables d'environnement.

Linux et macOS

Pour annuler la définition de vos variables d'environnement de région et de zone, exécutez les commandes unset suivantes :

unset CLOUDSDK_COMPUTE_REGION

unset CLOUDSDK_COMPUTE_ZONE

Windows

Pour annuler la définition de vos variables d'environnement de région et de zone, exécutez les commandes suivantes :

set CLOUDSDK_COMPUTE_REGION=

set CLOUDSDK_COMPUTE_ZONE=

Ignorer la zone par défaut à l'aide d'options

Utilisez l'option --zone pour ignorer la zone par défaut définie dans le serveur de métadonnées, votre client local et les variables d'environnement.

Exemple :

gcloud compute instances create example-instance \
    --zone=ZONE

Configurations

gcloud topic configurations est une fonctionnalité avancée qui vous permet d'influencer le comportement de l'outil gcloud. Pour la plupart des utilisateurs, l'utilisation des configurations par défaut suffit.

Les configurations peuvent être utiles pour les utilisateurs qui souhaitent réaliser les opérations suivantes :

  • Travailler sur plusieurs projets. Vous pouvez créer une configuration distincte pour chaque projet.
  • Utiliser plusieurs comptes. Par exemple, un compte utilisateur et un compte de service.
  • Effectuer diverses tâches indépendantes (travailler sur une application App Engine au sein d'un projet, administrer un cluster Compute Engine dans la zone us-central-1a, gérer les configurations réseau pour la région asia-east-1, etc.).

Pour basculer entre les configurations, exécutez la commande suivante :

gcloud config configurations activate CONFIGURATION_NAME

Pour en savoir plus sur la gestion des configurations, consultez la page gcloud config configurations.

Étape suivante