使用 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 角色，只要您已獲授角色，即可選取任何專案。
建立專案：如要建立專案，您需要具備專案建立者角色 (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，您需要具備服務使用情形管理員 IAM 角色 (roles/serviceusage.serviceUsageAdmin)，其中包含 serviceusage.services.enable 權限。瞭解如何授予角色。

gcloud services enable workflows.googleapis.com

安裝 Google Cloud CLI。

若您採用的是外部識別資訊提供者 (IdP)，請先使用聯合身分登入 gcloud CLI。

執行下列指令，初始化 gcloud CLI：

gcloud init

建立或選取 Google Cloud 專案。

選取或建立專案所需的角色

選取專案：選取專案時，不需要具備特定 IAM 角色，只要您已獲授角色，即可選取任何專案。
建立專案：如要建立專案，您需要具備專案建立者角色 (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，您需要具備服務使用情形管理員 IAM 角色 (roles/serviceusage.serviceUsageAdmin)，其中包含 serviceusage.services.enable 權限。瞭解如何授予角色。

gcloud services enable workflows.googleapis.com

設定驗證方法：
1. 確認您具備「建立服務帳戶」身分與存取權管理角色 (roles/iam.serviceAccountCreator) 和「專案 IAM 管理員」角色 (roles/resourcemanager.projectIamAdmin)。瞭解如何授予角色。
2. 建立服務帳戶：
```
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
```
  將 SERVICE_ACCOUNT_NAME 換成服務帳戶的名稱。
3. 將 roles/logging.logWriter 身分與存取權管理角色授予服務帳戶：
```
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 角色：

服務帳戶使用者 (roles/iam.serviceAccountUser)
Workflows 管理員 (roles/workflows.admin)

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色，取得必要權限。

建立、部署及執行工作流程

在主目錄中，建立名為 myFirstWorkflow.yaml 或 myFirstWorkflow.json 的新檔案。

複製以下工作流程並貼到新檔案中，然後儲存檔案：

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。系統會傳回相關的維基百科文章清單。

部署工作流程，並與指定的服務帳戶建立關聯：
```
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 角色清單，請參閱「Workflows 角色和權限」。

執行工作流程：

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 專案。

刪除您建立的工作流程：

gcloud workflows delete myFirstWorkflow

系統詢問您是否要繼續時，請輸入 y。

工作流程已刪除。

使用 gcloud CLI 建立工作流程

事前準備

必要的角色

建立、部署及執行工作流程

YAML

JSON

清除所用資源

後續步驟