在 Cloud Run 中建構及建立 Python 工作

在 Cloud Run 中建構及建立 Python 工作

瞭解如何建立簡單的 Cloud Run 作業，然後從來源部署，這會自動將程式碼封裝到容器映像檔中、將容器映像檔上傳至 Artifact Registry，然後部署至 Cloud Run。您也可以使用其他語言。

事前準備

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Make sure that you have the following role or roles on the project: Cloud Run Admin, Cloud Run Source Developer, Logs Viewer

Check for the roles

1. In the Google Cloud console, go to the IAM page.

   Go to IAM
2. Select the project.

3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

4. For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.

Grant the roles

1. In the Google Cloud console, go to the IAM page.

   前往「身分與存取權管理」頁面
2. 選取專案。
3. 按一下 「授予存取權」。

4. 在「New principals」(新增主體) 欄位中，輸入您的使用者 ID。 這通常是 Google 帳戶的電子郵件地址。

5. 在「Select a role」(選取角色) 清單中，選取角色。
6. 如要授予其他角色，請按一下 「新增其他角色」，然後新增每個其他角色。
7. 按一下 [Save]。

Install the Google Cloud CLI.

注意：如果您先前已安裝 gcloud CLI，請執行 gcloud components update，確認您使用的是最新版本。

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

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

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Make sure that you have the following role or roles on the project: Cloud Run Admin, Cloud Run Source Developer, Logs Viewer

Check for the roles

1. In the Google Cloud console, go to the IAM page.

   Go to IAM
2. Select the project.

3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

4. For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.

Grant the roles

1. In the Google Cloud console, go to the IAM page.

   前往「身分與存取權管理」頁面
2. 選取專案。
3. 按一下 「授予存取權」。

4. 在「New principals」(新增主體) 欄位中，輸入您的使用者 ID。 這通常是 Google 帳戶的電子郵件地址。

5. 在「Select a role」(選取角色) 清單中，選取角色。
6. 如要授予其他角色，請按一下 「新增其他角色」，然後新增每個其他角色。
7. 按一下 [Save]。

Install the Google Cloud CLI.

注意：如果您先前已安裝 gcloud CLI，請執行 gcloud components update，確認您使用的是最新版本。

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

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

gcloud init

1. 啟用 Cloud Run Admin API 和 Cloud Build API：

   gcloud services enable run.googleapis.com \
       cloudbuild.googleapis.com

   啟用 Cloud Run Admin API 後，系統會自動建立 Compute Engine 預設服務帳戶。

2. 請確認您已獲得服務身分的服務帳戶使用者角色。根據預設，服務身分是 Compute Engine 預設服務帳戶。

   授予角色

   如要授予服務身分資源的存取權，請使用 gcloud iam service-accounts add-iam-policy-binding 指令，並將醒目顯示的變數替換為適當的值：

         gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
             --member="PRINCIPAL" \
             --role="roles/iam.serviceAccountUser"
         

   更改下列內容：

   • SERVICE_ACCOUNT_EMAIL：您用來做為服務身分的服務帳戶電子郵件地址，例如：
     • Compute Engine 預設服務帳戶：[e-mail]
     • 您建立的服務帳戶：SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
   • PRINCIPAL：使用者 ID。這通常是 Google 帳戶的電子郵件地址。
3. 將下列 IAM 角色授予 Cloud Build 服務帳戶。

   按一下即可查看 Cloud Build 服務帳戶的必要角色

   除非您覆寫這項行為，否則 Cloud Build 會自動使用 Compute Engine 預設服務帳戶做為預設的 Cloud Build 服務帳戶，建構您的原始碼和 Cloud Run 資源。如要讓 Cloud Build 建構來源，請要求管理員將 Cloud Run Builder (roles/run.builder) 授予專案中的 Compute Engine 預設服務帳戶：

     gcloud projects add-iam-policy-binding PROJECT_ID \
         --member=serviceAccount:[e-mail] \
         --role=roles/run.builder
     

   請將 PROJECT_NUMBER 替換為專案編號，並將 PROJECT_ID 替換為專案 ID。 Google CloudGoogle Cloud如需如何找出專案 ID 和專案編號的詳細操作說明，請參閱「建立及管理專案」。

   將 Cloud Run 建構者角色授予 Compute Engine 預設服務帳戶後，需要幾分鐘才能傳播。

   注意：

   iam.automaticIamGrantsForDefaultServiceAccounts 機構政策限制 可防止系統自動將編輯者角色授予預設服務帳戶。如果您是在 2024 年 5 月 3 日後建立機構，系統預設會強制執行這項限制。

   強烈建議您強制執行這項限制，停用自動授予角色功能。如果停用自動角色授予功能，您必須決定要授予預設服務帳戶哪些角色，然後自行授予這些角色。

   如果預設服務帳戶已具備「編輯者」角色，建議您將「編輯者」角色替換為權限較少的角色。如要安全地修改服務帳戶的角色，請使用 政策模擬器查看變更的影響，然後授予及撤銷適當的角色。

4. 查看 Cloud Run 定價，或使用 Pricing Calculator 估算費用。

撰寫範例工作

如要以 Python 編寫工作，請按照下列步驟操作：

1. 建立名為 jobs 的新目錄，然後將目錄變更為該目錄：

   mkdir jobs
   cd jobs
   

2. 為實際工作程式碼建立 main.py 檔案。將下列範例行複製到檔案中：

   import json
   import os
   import random
   import sys
   import time
   
   # Retrieve Job-defined env vars
   TASK_INDEX = os.getenv("CLOUD_RUN_TASK_INDEX", 0)
   TASK_ATTEMPT = os.getenv("CLOUD_RUN_TASK_ATTEMPT", 0)
   # Retrieve User-defined env vars
   SLEEP_MS = os.getenv("SLEEP_MS", 0)
   FAIL_RATE = os.getenv("FAIL_RATE", 0)
   
   
   # Define main script
   def main(sleep_ms=0, fail_rate=0):
       """Program that simulates work using the sleep method and random failures.
   
       Args:
           sleep_ms: number of milliseconds to sleep
           fail_rate: rate of simulated errors
       """
       print(f"Starting Task #{TASK_INDEX}, Attempt #{TASK_ATTEMPT}...")
       # Simulate work by waiting for a specific amount of time
       time.sleep(float(sleep_ms) / 1000)  # Convert to seconds
   
       # Simulate errors
       random_failure(float(fail_rate))
   
       print(f"Completed Task #{TASK_INDEX}.")
   
   
   def random_failure(rate):
       """Throws an error based on fail rate
   
       Args:
           rate: a float between 0 and 1
       """
       if rate < 0 or rate > 1:
           # Return without retrying the Job Task
           print(
               f"Invalid FAIL_RATE env var value: {rate}. "
               + "Must be a float between 0 and 1 inclusive."
           )
           return
   
       random_failure = random.random()
       if random_failure < rate:
           raise Exception("Task failed.")
   
   
   # Start script
   if __name__ == "__main__":
       try:
           main(SLEEP_MS, FAIL_RATE)
       except Exception as err:
           message = (
               f"Task #{TASK_INDEX}, " + f"Attempt #{TASK_ATTEMPT} failed: {str(err)}"
           )
   
           print(json.dumps({"message": message, "severity": "ERROR"}))
           sys.exit(1)  # Retry Job Task by exiting the process

   使用者可以透過 Cloud Run 工作指定工作要執行的工作數量。這個程式碼範例說明如何使用內建的 CLOUD_RUN_TASK_INDEX 環境變數。每個工作都代表一個正在執行的容器副本。 請注意，工作通常會並行執行。如果每個工作都能獨立處理部分資料，使用多個工作就很有用。

   每項工作都會知道自己的索引，並儲存在 CLOUD_RUN_TASK_INDEX 環境變數中。內建的 CLOUD_RUN_TASK_COUNT 環境變數包含透過 --tasks 參數在工作執行時間提供的任務數量。

   程式碼也顯示如何使用內建的 CLOUD_RUN_TASK_ATTEMPT 環境變數重試工作。這個變數包含這項工作重試的次數，第一次嘗試時為 0，每次重試都會遞增 1，最多為 --max-retries。

   您也可以透過程式碼產生失敗，測試重試機制並產生錯誤記錄，瞭解錯誤記錄的樣貌。

3. 建立名為 Procfile 的文字檔 (不含副檔名)，並在當中加入下列內容：

   web: python3 main.py

程式碼已完成，可以封裝在容器中。

建構工作容器、傳送至 Artifact Registry，並部署至 Cloud Run

重要事項：本快速入門導覽課程假設您在用於快速入門導覽課程的專案中，具備擁有者或編輯者角色。否則，請參閱 Cloud Run Source Developer 角色，瞭解從來源部署 Cloud Run 資源所需的權限。

本快速入門導覽課程會使用從來源部署功能，建構容器、將容器上傳至 Artifact Registry，並將工作部署至 Cloud Run：

gcloud run jobs deploy job-quickstart \
    --source . \
    --tasks 50 \
    --set-env-vars SLEEP_MS=10000 \
    --set-env-vars FAIL_RATE=0.1 \
    --max-retries 5 \
    --region REGION \
    --project=PROJECT_ID

其中 PROJECT_ID 是您的專案 ID，REGION 則是您的區域，例如 europe-west1。請注意，您可以將各種參數變更為您想用於測試的值。SLEEP_MS 會模擬工作，並導致 X% 的工作失敗，方便您實驗平行處理和重試失敗工作。FAIL_RATE

在 Cloud Run 中執行工作

如要執行剛建立的工作，請按照下列指示操作：

gcloud run jobs execute job-quickstart --region REGION

將 REGION 替換為您在建立及部署工作時使用的區域，例如 europe-west1。

成功：您已使用 Cloud Run 中的 Python 執行階段建立及執行工作。

清除所用資源

如要避免系統向您的 Google Cloud 帳戶收取額外費用，請刪除您透過本快速入門導覽課程部署的所有資源。

刪除存放區

Cloud Run 只會針對作業的執行時間收費。不過，您可能仍須支付在 Artifact Registry 中儲存容器映像檔的費用。如要刪除 Artifact Registry 存放區，請按照 Artifact Registry 說明文件中的「刪除存放區」一節操作。

刪除工作

只有在執行工作時，Cloud Run 工作才會產生費用。如要刪除 Cloud Run 工作，請按照下列其中一個步驟操作：

控制台

如要刪除工作：

1. 前往 Google Cloud 控制台的 Cloud Run：

   前往 Cloud Run

2. 在工作清單中找出要刪除的工作，然後按一下核取方塊來選取。

3. 按一下 [Delete] (刪除)，這會終止所有進行中的工作執行作業和所有執行中的容器執行個體。

gcloud

如要刪除 Job，請執行下列指令：

gcloud run jobs delete JOB_NAME

將 JOB_NAME 改為工作名稱。

刪除測試專案

刪除 Google Cloud 專案後，系統就會停止對該專案中的所有資源收取費用。如要釋出專案中的所有 Google Cloud 資源，請按照下列步驟操作：

注意：刪除專案會造成以下結果：
• 專案中的所有內容都會遭到刪除。 如果您使用現有專案來進行本文中的工作，刪除專案將一併刪除其中已完成的所有工作。
• 自訂的專案 ID 會消失。當您之前建立這個專案時，可能建立了想要在日後使用的自訂專案 ID。如要保留使用該專案 ID 的網址 (例如 appspot.com 網址)，請刪除在該專案中選取的資源，而不是刪除整個專案。
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

後續步驟

如要進一步瞭解如何從程式碼來源建構容器並推送至存放區，請參閱：

• 開發 Cloud Run 服務
• 建構容器
• 在本機測試 Cloud Run 服務
• 透過原始碼部署