管理 SDK 属性

什么是属性?

属性是用于管理 gcloud CLI 和其他 SDK 工具的行为的设置。

属性可用于定义每个产品或每个服务的设置,例如 gcloud CLI 和其他 Cloud SDK 工具用于授权的帐号,或使用 Google Compute Engine 资源时要使用的默认区域,甚至还包括用于关闭 Cloud SDK 组件自动更新的选项。属性也可用于定义 gcloud 命令行工具偏好设置,比如 gcloud CLI 命令的详尽程度和提示配置。

属性和标志

gcloud CLI 支持一些全局标志和命令标志,这些标志与 SDK 属性具有相同的效果。例如,gcloud CLI 支持 --project 标志和 project 属性。属性允许您在执行各个命令时保持相同的设置,而标志对命令行为的影响将视调用而定。请注意,在同时设置两者时,标志的优先级高于属性。

配置

配置是一组指定的 SDK 属性。gcloud CLI 使用名为 default 的配置作为初始活跃配置;default 适用于大多数使用场景。但是,您也可以创建其他配置并根据需要在配置之间切换。

列出属性

如需列出活跃 配置 中的属性,请运行 gcloud config list

gcloud config list

gcloud CLI 会返回属性列表:

[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

设置属性

如需设置活跃配置中的属性,请运行 gcloud config set

gcloud config set project [PROJECT]

如需设置 core 属性部分之外的属性,您必须先指定相应部分,后跟一个正斜杠,然后再指定属性名称:

gcloud config set compute/zone us-east1-b

取消设置属性

如需取消设置活跃配置中的属性,请使用 gcloud config unset

gcloud config unset disable_usage_reporting

属性类型

当您查看属性列表时,SDK 属性会被整理为多个部分,相关的属性会组合在一起,方便您查看。

核心属性

core 部分包含 gcloud 命令的配置属性。

名称 说明
account gcloud CLI 和其他 SDK 工具用于授权的用户帐号或服务帐号。
custom_ca_certs_file 要使用的自定义 CA 证书文件的绝对路径。
disable_color 如果此属性设置为 True,系统将禁止 gcloud CLI 向终端输出彩色消息。
disable_file_logging 如果此属性设置为 True,则 gcloud CLI 不会将日志存储到文件中。 如果磁盘空间有限,此设置可能会很有用。
disable_prompts 如果此属性设置为 True,系统将禁止所有 gcloud CLI 命令的提示并采用默认答案。如果某个命令需要用户输入内容,并且不能使用默认值,gcloud CLI 将报告错误。 相当于全局 --quiet 标志。
disable_usage_reporting 如果此属性设置为 True,系统将禁止收集有关 SDK 使用情况的 匿名统计信息。您在安装 SDK 时设置此值,但可以随时更改。
log_http 如果此属性设置为 True,系统将允许向日志写入 HTTP 请求和响应。如果您希望在终端中看到这些消息,请使用 verbosity 属性或全局 --verbosity 标志来调整您的详尽程度设置。
max_log_days 删除之前日志文件的保留天数上限。如果该属性设置为 0,则系统会关闭日志垃圾回收并且不会删除日志文件。如果未设置,则默认值为 30 天。
pass_credentials_to_gsutil 如果此属性设置为 True,则系统会将配置的 Cloud SDK 身份验证传递给 gsutil。
project 当前 Cloud Platform 项目的 ID。您可以使用全局 --project 标志替换此值。
show_structured_logs 写入标准错误的 JSON 结构的日志消息的可见性和格式。如果此属性被停用,日志将默认采用 text 格式。 有效值包括 neveralwayslogterminal。如果未设置,则默认值为 never
trace_token Google 支持提供的令牌,用于路由服务请求的跟踪记录以调查问题。
user_output_enabled 允许在终端中将命令输出生成为标准输出和标准错误。如果此属性设置为 False,则系统将禁止输出。
verbosity gcloud CLI 命令的日志记录详尽程度。gcloud CLI 支持以下标准详尽程度:
  • debug
  • info
  • warning
  • error
  • critical
  • none
等同于使用全局 --verbosity 标志。

组件管理器属性

component_manager 部分包含 管理 SDK 组件 时使用的属性。

姓名 说明
component_manager/additional_repositories 附加存储库的逗号分隔列表(用于检查组件)。 此属性由 gcloud components repositories 命令组中的命令自动管理。
component_manager/disable_update_check 如果此属性为 True,则 SDK 不会自动检查更新。

App Engine 属性

app 部分包含用于指定 gcloud app deploy 命令行为的属性。

姓名 说明
app/cloud_build_timeout 在部署期间等待 Docker 构建完成的时间(以秒为单位)。现在,所有 Docker 构建都使用 Cloud Build API。
app/promote_by_default 如果为 True,则升级版本应在部署服务的新版本时接收该服务的所有流量。可以通过 --promote-by-default--no-promote-by-default 标志来覆盖此属性。
app/stop_previous_version 如果此属性为 True,则在部署新版本的应用时,系统将停止以前部署的版本。如果此属性为 False,则必须在部署前手动停止旧版本。
app/use_runtime_builders 如果已设置,请切换使用新的代码路径来使用可独立于客户端工具进行更新的预制运行时以构建应用程序。如果未设置,则使用每个运行时的默认路径。

Compute Engine 属性

compute 部分包含在 Google Compute Engine 资源上运行的 gcloud CLI 命令所使用的属性。

姓名 说明
compute/region 使用 Compute Engine 资源时要使用的默认区域。 如果 gcloud CLI 命令需要 --region 标志,但此标志并未提供,则系统会使用此值。
compute/zone 使用 Compute Engine 资源时要使用的默认地区。如果 gcloud CLI 命令需要 --zone 标志,但此标志并未提供,则系统会使用此值。

Kubernetes Engine 属性

container 部分包含在 Google Kubernetes Engine 集群上运行的 gcloud CLI 命令所使用的属性。

姓名 说明
container/cluster 要默认使用的集群的名称。

网络代理属性

proxy 部分包含与 gcloud 命令使用网络代理有关的属性。

姓名 说明
proxy/type 代理服务器的类型。受支持的代理类型包括:
  • http
  • http_no_tunnel
  • socks4
  • socks5
proxy/address 代理服务器的主机名或 IP 地址。
proxy/port 连接到代理服务器时使用的端口。
proxy/username 连接到代理服务器时使用的用户名(如果需要)。
proxy/password 连接到代理服务器时使用的密码(如果需要)。
proxy/rdns 如果此属性为 True(默认),则 DNS 查询不会在本地执行,而是交给代理进行解析。

后续步骤

  • 如需详细了解配置,请参阅 SDK 配置