使用 gcloud CLI 创建工作流

使用 gcloud CLI 创建工作流

本快速入门向您展示了如何使用 Google Cloud CLI 创建、部署和执行第一个工作流。示例工作流会向公共 API 发送请求，然后返回 API 的响应。

如需查看所有 Workflows gcloud CLI 命令的列表， 请参阅 Workflows gcloud CLI 参考页面。

准备工作

您的组织定义的安全限制条件可能会导致您无法完成以下步骤。如需了解相关问题排查信息，请参阅 在受限的环境中开发应用 Google Cloud 。

登录您的 Google Cloud 账号。如果您是新手 Google Cloud， 请创建一个账号来评估我们的产品在 实际场景中的表现。新客户还可获享 $300 赠金，用于 运行、测试和部署工作负载。

安装 Google Cloud CLI。

如果您使用的是外部身份提供方 (IdP)，则必须先使用联合身份登录 gcloud CLI。

如需初始化 gcloud CLI，请运行以下命令：

gcloud init

创建或选择 Google Cloud 项目。

选择或创建项目所需角色

• 选择项目：选择项目不需要特定的 IAM 角色，您可以选择已被授予角色的任何项目。
• 创建项目：如需创建项目，您需要 Project Creator 角色 (roles/resourcemanager.projectCreator)，该角色包含 resourcemanager.projects.create 权限。了解如何授予 角色。

注意：如果您不打算保留在此过程中创建的 资源，请创建新的项目，而不要选择现有的项目。完成本教程介绍的步骤后，您可以 删除所创建的项目，并移除与该项目关联的所有资源。

• 创建 Google Cloud 项目：

  gcloud projects create PROJECT_ID

  将 PROJECT_ID 替换为您要创建的 Google Cloud 项目的名称。

• 选择您创建的 Google Cloud 项目：

  gcloud config set project PROJECT_ID

  将 PROJECT_ID 替换为您的 Google Cloud 项目名称。

如果您要使用现有项目来完成本指南， 请验证您是否拥有完成本指南所需的权限。如果您创建了新项目， 则您已拥有所需的权限。

验证是否已为您的 Google Cloud 项目启用结算功能。

启用 Workflows API：

启用 API 所需的角色

如需启用 API，您需要拥有 serviceusage.services.enable 权限。如果您 创建了项目，则您可能已通过 Owner 角色 (roles/owner) 拥有此权限。否则，您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获得此权限。 了解如何授予角色。

gcloud services enable workflows.googleapis.com

安装 Google Cloud CLI。

如果您使用的是外部身份提供方 (IdP)，则必须先使用联合身份登录 gcloud CLI。

如需初始化 gcloud CLI，请运行以下命令：

gcloud init

创建或选择 Google Cloud 项目。

选择或创建项目所需角色

• 选择项目：选择项目不需要特定的 IAM 角色，您可以选择已被授予角色的任何项目。
• 创建项目：如需创建项目，您需要 Project Creator 角色 (roles/resourcemanager.projectCreator)，该角色包含 resourcemanager.projects.create 权限。了解如何授予 角色。

注意：如果您不打算保留在此过程中创建的 资源，请创建新的项目，而不要选择现有的项目。完成本教程介绍的步骤后，您可以 删除所创建的项目，并移除与该项目关联的所有资源。

• 创建 Google Cloud 项目：

  gcloud projects create PROJECT_ID

  将 PROJECT_ID 替换为您要创建的 Google Cloud 项目的名称。

• 选择您创建的 Google Cloud 项目：

  gcloud config set project PROJECT_ID

  将 PROJECT_ID 替换为您的 Google Cloud 项目名称。

如果您要使用现有项目来完成本指南， 请验证您是否拥有完成本指南所需的权限。如果您创建了新项目， 则您已拥有所需的权限。

验证是否已为您的 Google Cloud 项目启用结算功能。

启用 Workflows API：

启用 API 所需的角色

如需启用 API，您需要拥有 serviceusage.services.enable 权限。如果您 创建了项目，则您可能已通过 Owner 角色 (roles/owner) 拥有此权限。否则，您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获得此权限。 了解如何授予角色。

gcloud services enable workflows.googleapis.com

1. 设置身份验证：

   1. 确保您拥有 Create Service Accounts IAM 角色 (roles/iam.serviceAccountCreator) 和 Project IAM Admin 角色 (roles/resourcemanager.projectIamAdmin)。了解如何授予角色。

   2. 创建服务帐号：

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      将 SERVICE_ACCOUNT_NAME 替换为服务帐号的名称。

   3. 向服务帐号授予 roles/logging.logWriter IAM 角色：

      gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=roles/logging.logWriter

      替换以下内容：

      • SERVICE_ACCOUNT_NAME：服务账号的名称
      • PROJECT_ID：您在其中创建服务帐号的项目的 ID
      注意：--role 标志会影响服务帐号可以访问项目中的哪些资源。您可以撤消这些角色或稍后授予其他角色。

如需详细了解服务帐号角色和权限，请参阅 授予工作流访问 Google Cloud 资源的权限。

所需的角色

如需获得完成本快速入门所需的权限，请让您的管理员为您授予项目的以下 IAM 角色：

• Service Account User (roles/iam.serviceAccountUser)
• Workflows Admin (roles/workflows.admin)

如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

您也可以通过自定义 角色或其他预定义 角色来获取所需的权限。

创建、部署和执行工作流

1. 在您的主目录中，创建一个名为 myFirstWorkflow.yaml 或 myFirstWorkflow.json 的新文件。

2. 将以下工作流复制并粘贴到新文件中，然后保存该文件：

   YAML

   main:
     params: [input]
     steps:
       - checkSearchTermInInput:
           switch:
             - condition: '${"searchTerm" in input}'
               assign:
                 - searchTerm: '${input.searchTerm}'
               next: readWikipedia
       - getLocation:
           call: sys.get_env
           args:
             name: GOOGLE_CLOUD_LOCATION
           result: location
       - setFromCallResult:
           assign:
             - searchTerm: '${text.split(location, "-")[0]}'
       - readWikipedia:
           call: http.get
           args:
             url: 'https://en.wikipedia.org/w/api.php'
             query:
               action: opensearch
               search: '${searchTerm}'
           result: wikiResult
       - returnOutput:
           return: '${wikiResult.body[1]}'

   JSON

   {
     "main": {
       "params": [
         "input"
       ],
       "steps": [
         {
           "checkSearchTermInInput": {
             "switch": [
               {
                 "condition": "${\"searchTerm\" in input}",
                 "assign": [
                   {
                     "searchTerm": "${input.searchTerm}"
                   }
                 ],
                 "next": "readWikipedia"
               }
             ]
           }
         },
         {
           "getLocation": {
             "call": "sys.get_env",
             "args": {
               "name": "GOOGLE_CLOUD_LOCATION"
             },
             "result": "location"
           }
         },
         {
           "setFromCallResult": {
             "assign": [
               {
                 "searchTerm": "${text.split(location, \"-\")[0]}"
               }
             ]
           }
         },
         {
           "readWikipedia": {
             "call": "http.get",
             "args": {
               "url": "https://en.wikipedia.org/w/api.php",
               "query": {
                 "action": "opensearch",
                 "search": "${searchTerm}"
               }
             },
             "result": "wikiResult"
           }
         },
         {
           "returnOutput": {
             "return": "${wikiResult.body[1]}"
           }
         }
       ]
     }
   }
   

   除非您输入自己的搜索字词，否则此工作流会使用您的 Google Cloud 位置构造搜索字词，并将其传递给 Wikipedia API。系统会返回相关 Wikipedia 文章的列表。

3. 部署工作流并将其与指定的服务帐号关联：

   gcloud workflows deploy myFirstWorkflow --source=myFirstWorkflow.EXTENSION \
       --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
   

   替换以下内容：

   • EXTENSION：工作流的文件扩展名；对于 YAML 版本，请使用 yaml；对于 JSON 版本，请使用 json
   • PROJECT_ID：您的项目 ID
   注意： 在生产环境中，我们强烈建议创建一个新的服务 账号，然后授予它最少的允许该服务 账号访问所需资源的角色。如需了解详情，请参阅 服务账号。如需查看 Workflows 角色列表，请参阅 工作流角色和权限。

4. 执行工作流：

   gcloud workflows run myFirstWorkflow \
       --data='SEARCH_TERM'
   

   将 SEARCH_TERM 替换为您的搜索字词；例如， {"searchTerm":"North"}。如果您输入 {}，您的 Google Cloud 位置会用于构造搜索字词。

   这将返回执行尝试的结果。输出类似于以下内容：

   argument: '{"searchTerm":"North"}'
   duration: 0.210616856s
   endTime: '2023-05-10T21:56:39.465899376Z'
   name: projects/734581694262/locations/us-central1/workflows/workflow-1/executions/eae31f11-a5c3-47e2-8014-05b400820a79
   result: '["North","North America","Northern Ireland","North Korea","North Macedonia","North
     Carolina","Northrop Grumman B-2 Spirit","Northrop F-5","Northern Cyprus","North
     Dakota"]'
   startTime: '2023-05-10T21:56:39.255282520Z'
   state: SUCCEEDED
   status:
     currentSteps:
     - routine: main
       step: returnOutput
   workflowRevisionId: 000001-ac2
   

您已部署并执行第一个工作流！

清理

为避免因本页面中使用的资源导致您的 Google Cloud 账号产生费用，请删除包含这些资源的 Google Cloud 项目。

1. 删除您创建的工作流：

   gcloud workflows delete myFirstWorkflow
   

2. 当系统询问您是否要继续时，请输入 y。

工作流已删除。

后续步骤

• 更新现有工作流

• 控制工作流中的执行顺序

• 工作流示例

• Workflows 语法参考文档