Une configuration est un ensemble nommé de propriétés de la CLI Distributed Cloud. Ces propriétés sont des paires clé-valeur, organisées en sections, qui régissent le comportement de la CLI gdcloud.
Les propriétés généralement stockées dans les configurations incluent l'URL de la console de l'organisation et l'ID du projet. Les configurations permettent de définir et d'activer ces paramètres et d'autres en tant que groupe.
Les configurations sont stockées dans votre répertoire de configuration utilisateur, généralement ~/.config/gdcloud sous macOS et Linux. Notez également que le répertoire de configuration doit être activé en écriture.
Si vous disposez de plusieurs configurations, vous pouvez choisir de basculer de l'une à l'autre, ou d'exécuter des commandes avec une configuration spécifique à l'aide de l'indicateur --configuration. Pour en savoir plus sur le changement de configuration, consultez la section Activer une configuration.
Pour en savoir plus sur les configurations depuis la ligne de commande et obtenir une liste complète des propriétés disponibles ainsi que des sections où elles se trouvent, exécutez la commande gdcloud topic
configurations.
Configuration par défaut
La CLI gdcloud crée initialement une configuration unique nommée default. Vous pouvez définir des propriétés dans votre configuration en exécutant la commande gdcloud
init ou en exécutant directement gdcloud config set.
Configurations multiples
La configuration unique default convient à de nombreux cas d'utilisation. Vous pouvez toutefois créer des configurations supplémentaires et basculer entre elles selon vos besoins à l'aide de gdcloud config configurations activate. La configuration initiale default est créée à des fins de commodité et n'est pas obligatoire. Vous pouvez nommer cette configuration et toute configuration supplémentaire comme vous le souhaitez.
Les configurations multiples sont utiles dans les contextes suivants :
- Utiliser plusieurs projets : vous pouvez créer une configuration distincte pour chaque projet et basculer entre les configurations selon les besoins.
- Utilisez plusieurs URL de la console d'administration.
- Effectuer des tâches généralement indépendantes : vous pouvez, par exemple, utiliser une configuration pour travailler sur le service A dans un projet et gérer un service B non lié dans un autre projet.
Créer une configuration
Pour créer une configuration, exécutez la commande suivante :
gdcloud config configurations create NAME
Vous devez activer la nouvelle configuration après sa création pour pouvoir l'utiliser.
Activer une configuration
Une seule de vos multiples configurations peut être active à un moment donné. La configuration active est celle dont les propriétés vont régir le comportement de la CLI gdcloud.
Pour activer une nouvelle configuration ou basculer vers une nouvelle configuration active, exécutez :
gdcloud config configurations activate NAME
gdcloud config list vous indique toujours les propriétés de la configuration active.
Pour changer de configuration active pour un appel de commande individuel, appliquez l'option --configuration pour n'importe quelle commande de CLI gdcloud :
gdcloud auth print-identity-token --configuration=CONFIGURATION
Lister les configurations
Pour répertorier les configurations de votre gdcloud CLI, exécutez la commande suivante :
gdcloud config configurations list
La CLI gdcloud répertorie les configurations et indique celle qui est active :
NAME ISACTIVE PROPERTIES.CORE.PROJECT PROPERTIES.CORE.ORGANIZATIONCONSOLEURL
default False example-project-default https://console.default-org.example.com
config-project-1 False example-project-1 https://console.org-1.example.com
config-project-2 False example-project-2 https://console.org-2.example.com
Définir les propriétés de configuration
Pour définir les propriétés de la configuration active ou annuler leur définition, exécutez :
gdcloud config set project PROJECT
Afficher les propriétés de configuration
Pour afficher les propriétés d'une configuration, exécutez :
gdcloud config configurations describe NAME
La CLI gdcloud affiche les propriétés de configuration :
is_active: false
name: default
properties:
accessibility:
screen_reader: "false"
auth:
login_config_cert_path: /tmp/root-web-tls-ca.cert
core:
organization_console_url: https://console.example.com
project: example-project
Pour afficher les propriétés de la configuration active, exécutez la commande suivante :
gdcloud config list
Supprimer une configuration
Pour supprimer une configuration, exécutez la commande suivante :
gdcloud config configurations delete NAME
Vous ne pouvez pas supprimer une configuration active. Pour passer à une autre configuration avant la suppression, utilisez gdcloud config configurations activate si nécessaire.