编写 gcloud CLI 命令脚本

除了从命令行运行 Google Cloud CLI 命令之外,您还可以通过脚本或其他自动化方法运行这些命令,例如使用 Jenkins 驱动 Google Cloud 任务自动化。

gcloud CLI 附带多种工具,例如过滤、格式设置和 --quiet 标志,可让您有效处理输出和自动执行任务。

使用 gcloud CLI 编写脚本的基础知识

如需查看有关使用 gcloud CLI 构建基本脚本的分步指南,请参阅此博文:使用 gcloud 编写脚本:自动执行 Google Cloud 任务的新手指南

授权

使用 gcloud CLI 编写脚本时,您需要考虑授权方法。gcloud CLI 提供了两个选项:

  • 用户帐号授权
  • 服务帐号授权

如果您要在单台机器上运行脚本或其他自动化功能,建议您使用用户帐号授权。

如需授予访问权限并执行其他常见的 gcloud CLI 设置步骤,请执行以下操作:

gcloud init

如果您要在生产环境中的多台机器上部署脚本或其他自动化功能,建议您使用服务帐号授权。如果您要在 Compute Engine 虚拟机实例(其中所有用户都有 root 访问权限)上运行 gcloud CLI 命令,我们同样建议您使用服务帐号授权。

如需使用服务帐号授权,请使用现有服务帐号或在“服务帐号”页面上创建新帐号:

转到“服务帐号”页面

如需创建并下载 JSON 格式的关联私钥,请从服务帐号的操作菜单中选择 Manage Keys

如需运行授权,请运行 gcloud auth activate-service-account

gcloud auth activate-service-account --key-file [KEY_FILE]

您可以使用 gcloud compute ssh(负责处理身份验证)通过 SSH 连接到您的虚拟机实例。您可以使用 gcloud compute config-ssh 配置 SSH 配置文件。

如需详细了解如何为 gcloud CLI 工具授权,请参阅为 gcloud CLI 授权

停用提示

某些 gcloud CLI 命令是交互式命令,这些命令会提示用户确认操作,或请求对已输入命令的进行额外的输入。

在大多数情况下,当您通过脚本或其他自动化功能运行命令时,并不希望看到提示。您可以停用 gcloud CLI 命令中的提示,方法是将配置中的 disable_prompts 属性设置为 True,或者使用全局 --quiet-q 标志。需要额外的确认或输入时,大多数交互式命令都具有默认值。如果提示被停用,系统将使用这些默认值。

例如:

gcloud debug targets list --quiet

过滤输出和设置输出格式

为了使用 gcloud CLI 编写脚本,必须具有可预测的输出;这就是 --filter--format 标志的作用。这些命令可确保在您使用 gcloud CLI 运行命令时,它会生成符合您格式(例如 json、yaml、csv 和文本)和过滤条件(前缀为 'test',创建年份在 2015 年之后)规范的输出。

如果您希望学习有关如何改用过滤标志和格式设置标志的互动式教程,请使用以下按钮启动该教程:

在 Cloud Shell 中打开

以下示例展示了使用 gcloud CLI 命令进行格式设置和过滤的常见用途:

列出在地区 us-central1-a 中创建的实例:

gcloud compute instances list --filter="zone:us-central1-a"

以 JSON 格式列出标签与特定值匹配的项目(例如,label.env 为“test”,label.version 为“alpha”):

gcloud projects list --format="json" \
  --filter="labels.env=test AND labels.version=alpha"

列出使用本地时区指定了创建日期和时间的项目:

gcloud projects list \
  --format="table(name, project_id, createTime.date(tz=LOCAL))"

以表格式列出在特定日期后创建的项目:

gcloud projects list \
  --format="table(projectNumber,projectId,createTime)" \
  --filter="createTime.date('%Y-%m-%d', Z)='2016-05-11'"

请注意,在最后一个示例中,使用了键上的投影。设置日期格式后,过滤条件将应用于 createTime 键。

列出区域配额的嵌套表:

gcloud compute regions describe us-central1 \
  --format="table(quotas:format='table(metric,limit,usage)')"

以 CSV 格式打印全球配额的展开列表:

gcloud compute project-info describe --flatten='quotas[]' \
  --format='csv(quotas.metric,quotas.limit,quotas.usage)'

以表格式列出计算实例资源(带有装饰框和标题,按名称排序):

gcloud compute instances list \
  --format='table[box,title=Instances](name:sort=1,zone:label=zone,status)'

列出已通过项目身份验证的用户电子邮件地址:

gcloud info --format='value(config.account)'

如需查看 gcloud CLI filtersformatsprojections 标志内置的输出配置功能的更多示例,请参阅这篇博文,了解过滤和格式设置

最佳做法

如果您希望脚本或其他自动化功能根据 gcloud CLI 命令的输出有条件地执行操作,请遵循以下规则:

  • 依赖于命令退出状态

    如果退出状态不为零,表明发生了错误,并且输出可能不完整(除非命令文档另有说明)。 例如,某个本应创建多个资源的命令可能只创建几个资源并在标准输出中列出,然后以非零状态退出。 或者,您可以使用 show_structured_logs 属性来解析错误日志。如需了解详情,请运行 gcloud config

  • 请勿依赖标准错误中显示的消息

    这些消息的措辞可能会在未来的 gcloud CLI 版本中发生变化,并破坏您的自动化功能。

  • 请勿依赖标准输出中显示的消息的原始输出

    任何命令的默认输出都可能会在未来版本中发生更改。为了最大程度降低这些更改造成的影响,您可以使用 --format 标志,通过以下某种方法设置输出的格式:--format=json|yaml|csv|text|list,从而指定要返回的值。如需查看更多选项,请运行 gcloud topic formats

    您可以使用 projections 修改 --format 的默认输出。为了提高粒度,请使用 --filter 标志基于表达式返回值的子集。然后,您可以针对这些返回的值编写脚本。

    要查看为输出设置格式以及过滤输出的示例,请参阅以下章节。

示例脚本

利用格式和过滤功能,您可以将 gcloud CLI 命令组合到脚本中,以便轻松提取嵌入的信息。

列出所有项目和服务帐号的密钥

以下示例脚本按以下方式列出与您的所有项目关联的密钥:

  • 迭代您的项目
  • 对于每个项目,获取关联的服务帐号
  • 获取每个服务帐号的关联密钥

Bash

#!/bin/bash
for project in  $(gcloud projects list --format="value(projectId)")
do
  echo "ProjectId:  $project"
  for robot in $(gcloud iam service-accounts list --project $project --format="value(email)")
   do
     echo "    -> Robot $robot"
     for key in $(gcloud iam service-accounts keys list --iam-account $robot --project $project --format="value(name.basename())")
        do
          echo "        $key"
     done
   done
done

Windows PowerShell

或者以 Windows PowerShell 的形式:

foreach ($project in gcloud projects list --format="value(projectId)")
{
  Write-Host "ProjectId: $project"
  foreach ($robot in  gcloud iam service-accounts list --project $project --format="value(email)")
  {
      Write-Host "    -> Robot $robot"
      foreach ($key in gcloud iam service-accounts keys list --iam-account $robot --project $project --format="value(name.basename())")
      {
        Write-Host "        $key"
      }
  }
}

解析输出以进行处理

以下示例演示了如何解析输出以进行处理。具体而言,示例脚本将服务帐号信息写入数组,并将 CSV 格式的多值 serviceAccounts.scope() 字段中的值隔离:

#!/bin/bash
for scopesInfo in $(
    gcloud compute instances list --filter=name:instance-1 \
        --format="csv[no-heading](name,id,serviceAccounts[].email.list(),
                      serviceAccounts[].scopes[].map().list(separator=;))")
do
      IFS=',' read -r -a scopesInfoArray<<< "$scopesInfo"
      NAME="${scopesInfoArray[0]}"
      ID="${scopesInfoArray[1]}"
      EMAIL="${scopesInfoArray[2]}"
      SCOPES_LIST="${scopesInfoArray[3]}"

      echo "NAME: $NAME, ID: $ID, EMAIL: $EMAIL"
      echo ""
      IFS=';' read -r -a scopeListArray<<< "$SCOPES_LIST"
      for SCOPE in  "${scopeListArray[@]}"
      do
        echo "  SCOPE: $SCOPE"
      done
done