Gérer les propriétés du SDK

Qu'est-ce qu'une propriété ?

Les propriétés sont des paramètres qui régissent le comportement de la CLI gcloud et des autres outils du SDK.

Les propriétés peuvent être utilisées pour définir des paramètres au niveau d'un produit ou d'un service, par exemple le compte utilisé par la CLI gcloud et les autres outils du SDK Cloud pour les autorisations, la région par défaut à utiliser pour exploiter des ressources Google Compute Engine, ou même l’option permettant de désactiver les mises à jour automatiques des composants du SDK Cloud. Les propriétés peuvent également être utilisées pour définir les préférences de l'outil de ligne de commande gcloud, telles que le niveau de détail et la configuration des invites pour les commandes de CLI gcloud.

Propriétés et indicateurs

La CLI gcloud accepte des indicateurs globaux et des indicateurs de commande qui ont le même effet que les propriétés du SDK. Par exemple, la CLI gcloud accepte aussi bien l'indicateur --project que la propriété project. Les propriétés permettent de conserver les mêmes paramètres lors de l'exécution des commandes, tandis que les indicateurs affectent le comportement des commandes appel par appel. Notez que les indicateurs remplacent les propriétés lorsque les deux sont définis.

Configurations

Une configuration est un ensemble nommé de propriétés du SDK. La CLI gcloud utilise une configuration appelée default comme configuration active initiale. default convient à la plupart des cas d'utilisation. Cependant, vous pouvez également créer des configurations supplémentaires et basculer entre elles selon vos besoins.

Répertorier les propriétés

Pour répertorier les propriétés de la configuration active, exécutez gcloud config list :

gcloud config list

La CLI gcloud renvoie la liste des propriétés :

[compute]
region = us-east1
zone = us-east1-d
[core]
account = user@google.com
disable_usage_reporting = False
project = example-project
[metrics]
command_name = gcloud.config.list

Définir des propriétés

Pour définir une propriété dans la configuration active, exécutez gcloud config set :

gcloud config set project [PROJECT]

Pour définir des propriétés qui ne figurent pas dans la section des propriétés core, vous devez spécifier la section suivie d'une barre oblique avant le nom de la propriété :

gcloud config set compute/zone us-east1-b

Annuler la définition de propriétés

Pour annuler la définition d'une propriété dans la configuration active, utilisez gcloud config unset :

gcloud config unset disable_usage_reporting

Types de propriétés

Les propriétés du SDK sont organisées en sections qui regroupent les propriétés associées pour plus de commodité lorsque vous consultez les listes de propriétés.

Propriétés principales

La section core contient les propriétés de configuration pour la commande gcloud.

Nom Description
account Compte utilisateur ou compte de service utilisé par la CLI gcloud et les autres outils du SDK pour les autorisations.
disable_color Si la valeur est True, empêche la CLI gcloud d’afficher des messages en couleur sur le terminal.
disable_prompts Si la valeur est True, supprime les invites pour toutes les commandes de CLI gcloud et applique la réponse par défaut. Si une commande nécessite une saisie utilisateur et qu'une valeur par défaut ne peut pas être utilisée, la CLI gcloud signale une erreur. Équivaut à l'indicateur global --quiet.
disable_usage_reporting Si la valeur est True, désactive la collecte des statistiques anonymes sur l'utilisation du SDK. Vous définissez cette valeur à l'installation du SDK, mais vous pouvez la modifier à tout moment.
log_http Si la valeur est True, active l'écriture des requêtes HTTP et des réponses dans les journaux. Si vous souhaitez voir ces messages sur votre terminal, ajustez votre paramètre de verbosité à l'aide de la propriété verbosity ou de l'indicateur global --verbosity.
project ID du projet Cloud Platform actuel. Vous pouvez remplacer cette valeur à l'aide de l'indicateur global --project.
trace_token Jeton fourni par l'assistance Google pour acheminer les traces des requêtes de service afin d'examiner les problèmes.
user_output_enabled Permet l'affichage du résultat de la commande sur la sortie standard et l'erreur standard dans le terminal. Si la valeur est False, le résultat est supprimé.
verbosity Niveau de détail appliqué à la journalisation des commandes de CLI gcloud. La CLI gcloud accepte les niveaux de verbosité standards suivants :
  • debug
  • info
  • warning
  • error
  • critical
  • none
Équivaut à l'utilisation de l'indicateur global --verbosity.

Propriétés du gestionnaire de composants

La section component_manager contient les propriétés utilisées pour la gestion des composants du SDK.

Nom Description
component_manager/additional_repositories Liste des dépôts supplémentaires, séparés par des virgules, dans lesquels rechercher les composants. Cette propriété est gérée automatiquement par les commandes dans le groupe de commandes gcloud components repositories.
component_manager/disable_update_check Si la valeur est True, le SDK ne recherche pas automatiquement les mises à jour.

Propriétés App Engine

La section app contient les propriétés qui spécifient le comportement de la commande gcloud app deploy.

Nom Description
app/stop_previous_version Si la valeur est True, arrête la version précédemment déployée lors du déploiement d'une nouvelle version de l'application. Si la valeur est False, l'ancienne version doit être arrêtée manuellement avant le déploiement.

Propriétés Compute Engine

La section compute contient les propriétés utilisées par les commandes de CLI gcloud appliquées aux ressources Google Compute Engine.

Nom Description
compute/region Région par défaut à utiliser avec les ressources Compute Engine. Si l'indicateur --region est requis par une commande de CLI gcloud mais n'est pas fourni, cette valeur est utilisée.
compute/zone Zone par défaut à utiliser avec les ressources Compute Engine. Si l'indicateur --zone est requis par une commande de CLI gcloud mais n'est pas fourni, cette valeur est utilisée.

Propriétés Kubernetes Engine

La section container contient les propriétés utilisées par les commandes de CLI gcloud appliquées aux clusters Google Kubernetes Engine.

Nom Description
container/cluster Nom du cluster à utiliser par défaut.

Propriétés des proxys réseau

La section proxy contient les propriétés liées à l'utilisation des proxys réseau par la commande gcloud.

Nom Description
proxy/type Type de serveur proxy. Les types de proxys compatibles sont les suivants :
  • http
  • http_no_tunnel
  • socks4
  • socks5
proxy/address Nom d'hôte ou adresse IP du serveur proxy.
proxy/port Port à utiliser pendant la connexion au serveur proxy.
proxy/username Nom d'utilisateur à employer lors de la connexion au serveur proxy, si nécessaire.
proxy/password Mot de passe à utiliser lors de la connexion au serveur proxy, si nécessaire.
proxy/rdns Si la valeur est True (valeur par défaut), les requêtes DNS ne sont pas exécutées localement, mais transmises au proxy pour résolution.

Étape suivante

Cette page vous a-t-elle été utile ? Évaluez-la :

Envoyer des commentaires concernant…

Documentation du SDK Cloud