管理 SDK 配置

什么是配置?

配置是一组指定的 SDK 属性。这些属性是控制 gcloud 命令行工具和其他 SDK 工具行为的键值对。

配置中存储的常见属性包括默认 Google Compute Engine 地区、详尽程度、使用情况报告、项目 ID,以及活动用户或服务帐号。您可以通过配置,将这些及其他设置作为一个组进行定义并启用。

如果您有多个配置,可以选择在各个配置之间切换,或者使用特定配置运行命令(借助 --configuration 标志)。如需详细了解如何切换配置,请参阅下方有关激活配置的部分。

如需从命令行查看配置(以及可用属性的完整列表),请运行 gcloud topic configurations

默认配置

SDK 在一开始为您提供了名为 default 的单个配置。您可以通过运行 gcloud init 命令或直接运行 gcloud config set 来设置配置中的属性。

例如,要停用编写脚本提示,可运行以下命令:

gcloud config set disable_prompts true

多个配置

单个 default 配置适合许多用例。但是,您还可以创建其他配置并根据需要使用 gcloud config configurations activate 在这些配置之间切换。初始 default 配置没有什么特别之处;它只是为了方便您使用。您可以按照自己的想法为此配置以及其他任何配置指定名称。

如果您想要执行以下操作,建议您使用多个配置:

  • 使用多个项目:您可以为每个项目创建一个单独的配置,并根据需要在它们之间切换。
  • 使用多个授权帐号。
  • 执行通常具有独立性的任务:例如,您可以在一个项目中使用一种配置来处理 Google App Engine 应用,并在另一个项目中使用另一种配置来管理不相关的 Compute Engine 实例。

创建配置

要创建配置,请运行 gcloud config configurations create

gcloud config configurations create [NAME]

您必须在创建后激活新配置,然后才能使用新配置。

激活配置

如果您有多个配置,则在给定的某个时间,只能有一个配置处于活动状态。活动配置的属性会决定 SDK 工具的行为。

要激活新配置或切换到新的有效配置,请运行 gcloud config configurations activate

gcloud config configurations activate [NAME]

gcloud config list 将始终向您显示有效配置中的属性。

要更改单个命令调用的有效配置,您可以在任意 gcloud CLI 命令中使用 --configuration 标志:

gcloud auth list --configuration=[CONFIGURATION_NAME]

要更改当前终端中所有命令的有效配置,您可以将环境变量 CLOUDSDK_ACTIVE_CONFIG_NAME 设置为您要使用的配置的名称。

自动配置切换

为了帮助无缝地更改配置,您可以利用 direnvondir 等工具在切换工作目录时自动切换配置。实现此目的的一种方法是在项目根目录中的 .envrc 文件中设置必要的环境变量(如 CLOUDSDK_ACTIVE_CONFIG_NAME)。

列出配置

要列出 Cloud SDK 安装实例中的配置,请运行 gcloud config configurations list

gcloud config configurations list

gcloud CLI 会列出配置并显示哪个配置当前处于有效状态:

NAME         IS_ACTIVE     ACCOUNT            PROJECT               DEFAULT_ZONE  DEFAULT_REGION
default      False         user@gmail.com     example-project-1     us-east1-b    us-east1
project-1    False         user@gmail.com     example-project-2     us-east1-c    us-east1
project-2    True          user@gmail.com     example-project-3     us-east1-b    us-east1

设置配置属性

要设置和取消设置有效配置中的属性,请运行 gcloud config setgcloud config unset

gcloud config set project [PROJECT]
gcloud config unset disable_usage_reporting

查看配置属性

要查看配置中的属性,请运行 gcloud config configurations describe

gcloud config configurations describe [NAME]

或者,要查看有效配置中的属性,请运行以下命令:

gcloud config list

gcloud CLI 会显示配置属性:

is_active: false
name: default
properties:
  compute:
    region: us-east1
    zone: us-east1-b
  core:
    account: user@google.com
    project: example-project

删除配置

要删除配置,请运行 gcloud config configurations delete

gcloud config configurations delete [NAME]

您无法删除活动配置。如果需要在删除之前切换到另一个配置,请使用 gcloud config configurations activate

后续步骤