建立工作

控制台

如要建立新工作，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「Cloud Run jobs」(Cloud Run 工作) 頁面：

   前往「Cloud Run jobs」(Cloud Run 工作)

2. 按一下「Deploy container」(部署容器)，顯示「Create job」(建立工作) 表單。

3. 在表單中，指定含有工作程式碼的容器映像檔，或從先前部署的容器清單中選取。

4. 系統會根據容器映像檔自動產生工作名稱。您可以視需要在表單上編輯工作名稱。提交表單後，就無法編輯工作名稱。

5. 在「Region」(區域) 欄位中， 選取工作所在的區域。區域選取器會醒目顯示碳影響最低的區域。

6. 指定要在工作中執行的任務數量。所有任務都必須成功，工作才會成功。根據預設，工作會並行執行。

7. 按一下「容器、網路、安全性」，設定其他工作屬性。

8. 在「Edit container」(編輯容器) 部分，視需要在適當的分頁中進行下列設定：

   • 容器設定
   • CPU 上限
   • 記憶體上限
   • 密鑰
   • 環境變數
   • 標籤
   • 服務帳戶
   • Cloud SQL 連線
   • 虛擬私人雲端連線能力

9. 在「Task capacity」(工作容量) 部分，指定下列項目：

   1. 在「Task timeout」(工作逾時) 欄位中，指定工作可執行的時間長度上限 (以秒為單位)，最多 168 小時 (7 天)。使用 GPU 的工作，逾時時間上限為 12 小時。每項工作都必須在這段時間內完成。預設值為 10 分鐘。

   2. 在「Number of retries per failed task」(每項失敗任務的重試次數) 欄位中，指定任務失敗時的重試次數。預設為重試 3 次。

10. 在「Parallelism」(平行處理) 下方，如果因工作存取的資源有擴充限制，而需要設定較低的限制，請選取「Run as many tasks concurrently as possible」(同時執行盡可能多的工作)，或選取「Limit the maximum number of concurrent tasks」(限制並行工作的數量上限)，並在「Custom parallelism limit」(自訂平行處理限制) 欄位中指定並行工作的數量。

11. 完成工作設定後，按一下「Create」(建立)，在 Cloud Run 中建立工作。

12. 如要執行工作，請參閱「執行工作」或「依排程執行工作」。

gcloud

如要使用指令列，您必須先設定 gcloud CLI。

如要建立新工作，請按照下列步驟操作：

1. 執行下列指令：

   gcloud run jobs create JOB --image IMAGE_URL OPTIONS

   或者，您也可以使用 deploy 指令：

   gcloud run jobs deploy JOB --image IMAGE_URL OPTIONS

   更改下列內容：

   • JOB：Cloud Run 工作名稱。
   • IMAGE_URL：容器映像檔的參照，例如 us-docker.pkg.dev/cloudrun/container/job:latest。

   • OPTIONS (選用)：下列任一選項：

     選項	說明
     --tasks	可接受大於或等於 1 的整數。預設為 1，上限為 10,000。每項工作都會提供環境變數 CLOUD_RUN_TASK_INDEX (值介於 0 和工作數量減 1 之間)，以及 CLOUD_RUN_TASK_COUNT (工作數量)
     --max-retries	失敗工作的重試次數。一旦失敗的工作數量超過這個上限，整個工作就會標示為「失敗」。舉例來說，如果設為 1，失敗的工作會重試一次，總共嘗試兩次。預設值為 3。可接受 0 到 10 之間的整數。
     --task-timeout	接受「2s」等時間長度。預設為 10 分鐘，最長 168 小時 (7 天)。使用 GPU 的工作，逾時時間上限為 12 小時。
     --parallelism	可並行執行的任務數量上限。根據預設，系統會盡快並行啟動工作。如要瞭解值範圍，請參閱「平行處理」。
     --execute-now	如果設定，工作建立後會立即啟動工作執行作業。等同於先呼叫 gcloud run jobs create，再呼叫 gcloud run jobs execute。

     除了上述選項外，您也可以指定更多設定，例如環境變數或記憶體限制。

     如需建立工作時可用的完整選項清單，請參閱 gcloud run jobs create 指令列說明文件。

2. 等待工作建立完成。成功完成後，您會看到成功訊息。

3. 如要執行工作，請參閱「執行工作」或「依排程執行工作」。

YAML

您可以將工作規格儲存在 YAML 檔案中，然後使用 gcloud CLI 部署。

1. 建立新的 job.yaml 檔案，並加入以下內容：

   apiVersion: run.googleapis.com/v1
   kind: Job
   metadata:
     name: JOB
   spec:
     template:
       spec:
         template:
           spec:
             containers:
             - image: IMAGE_URL

   更改下列內容：

   • JOB：Cloud Run 工作名稱。
   • IMAGE_URL：容器映像檔的參照，例如 us-docker.pkg.dev/cloudrun/container/job:latest。

   您也可以指定更多設定，例如環境變數或記憶體限制。

2. 執行下列指令，部署新工作：

   gcloud run jobs replace job.yaml

Terraform

如要瞭解如何套用或移除 Terraform 設定，請參閱「基本 Terraform 指令」。

resource "google_cloud_run_v2_job" "default" {
  name     = "cloud-run-job"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    template {
      containers {
        image = "us-docker.pkg.dev/cloudrun/container/job:latest"
      }
    }
  }
}

用戶端程式庫

如要透過程式碼建立工作，請按照下列步驟操作：

• Go
• Java
• Node.js
• Python
• Ruby
• PHP
• .NET

REST API

如要建立工作，請向 Cloud Run Admin API jobs 端點傳送 POST HTTP 要求。

例如，使用 curl：

curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -X POST \
  -d '{template: {template: {containers: [{image: "IMAGE_URL"}]}}}' \
  https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs?jobId=JOB

更改下列內容：

• ACCESS_TOKEN：帳戶的有效存取權杖，該帳戶必須具備建立工作的 IAM 權限。舉例來說，如果您已登入 gcloud，可以使用 gcloud auth print-access-token 擷取存取權杖。在 Cloud Run 容器執行個體中，您可以使用容器執行個體中繼資料伺服器擷取存取權杖。
• IMAGE_URL：容器映像檔的參照，例如 us-docker.pkg.dev/cloudrun/container/job:latest。
• PROJECT_ID： Google Cloud 專案 ID。
• REGION：工作的 Google Cloud 區域。
• JOB：要建立的工作名稱。

控制台

如要更新現有工作，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「Cloud Run jobs」(Cloud Run 工作) 頁面：

   前往「Cloud Run jobs」(Cloud Run 工作)

2. 按一下工作，顯示「Job details」(工作詳細資料) 頁面。

3. 按一下「查看及編輯工作設定」。

4. 選用：視需要變更工作中的任務數量。

5. 選用：按一下「容器、網路、安全性」，更新其他工作屬性：

   • 容器設定
   • CPU 上限
   • 記憶體上限
   • 密鑰
   • 環境變數
   • 標籤
   • 服務帳戶
   • Cloud SQL 連線
   • 虛擬私人雲端連線能力

6. 在「Task capacity」(工作容量) 部分，指定下列項目：

   1. 在「Task timeout」(工作逾時) 欄位中，指定工作可執行的時間長度上限 (以秒為單位)，最多 168 小時 (7 天)。使用 GPU 的工作，逾時時間上限為 12 小時。每項工作都必須在這段時間內完成。預設值為 10 分鐘。

   2. 在「Number of retries per failed task」(每項失敗任務的重試次數) 欄位中，指定任務失敗時的重試次數。預設為重試 3 次。

7. 在「Parallelism」(平行處理) 下方，如果因工作存取的資源有擴充限制，而需要設定較低的限制，請選取「Run as many tasks concurrently as possible」(同時執行盡可能多的工作)，或選取「Limit the maximum number of concurrent tasks」(限制同時執行的工作數量上限)，並在「Custom parallelism limit」(自訂平行處理限制) 欄位中指定同時執行的工作數量。

8. 完成工作設定後，請按一下「Update」(更新)，在 Cloud Run 中修改工作，並等待工作建立完成。

9. 如要執行工作，請參閱「執行工作」或「依排程執行工作」。

gcloud

1. 在 Google Cloud 控制台啟用 Cloud Shell。

   啟用 Cloud Shell

   Google Cloud 控制台底部會開啟 Cloud Shell 工作階段，並顯示指令列提示。Cloud Shell 是已安裝 Google Cloud CLI 的殼層環境，並已設定適用於您目前專案的值。工作階段可能要幾秒鐘的時間才能初始化。

2. 請執行下列指令：

   gcloud run jobs update JOB

   更改下列內容：

   • JOB：Cloud Run 工作名稱。

   • OPTIONS (選用)：使用下列選項：

     選項	說明
     --tasks	可接受等於或大於 1 的整數。預設為 1，上限為 10,000。每項工作都會提供環境變數 CLOUD_RUN_TASK_INDEX (值介於 0 和工作數量減 1 之間)，以及 CLOUD_RUN_TASK_COUNT (工作數量)
     --max-retries	失敗工作的重試次數。一旦失敗的工作數量超過這個上限，整個工作就會標示為「失敗」。舉例來說，如果設為 1，失敗的工作會重試一次，總共嘗試兩次。預設值為 3。可接受 0 到 10 之間的整數。
     --task-timeout	接受「2s」等時間長度。預設為 10 分鐘，最長 168 小時 (7 天)。
     --parallelism	可並行執行的任務數量上限。根據預設，系統會盡快並行啟動工作。如要瞭解值範圍，請參閱「平行處理」。

   除了上述選項，您還可以設定其他選用設定：

   • 容器設定
   • CPU 上限
   • 記憶體上限
   • 密鑰
   • 環境變數
   • 標籤
   • 服務帳戶
   • Cloud SQL 連線
   • 虛擬私有雲連線

   如需建立工作時可用的完整選項清單，請參閱 gcloud run jobs create 指令列說明文件。

3. 等待工作更新完成。成功完成後，系統會顯示類似以下的成功訊息：

   Job [JOB] has been successfully updated.
   View details about this job by running `gcloud run jobs describe JOB`.
   See logs for this execution at: https://console.cloud.google.com/logs/viewer?project=PROJECT_ID&resource=cloud_run_revision/service_name/JOB

4. 如要執行工作，請參閱「執行工作」或「依排程執行工作」。

YAML

1. 如要下載或查看現有工作的設定，請執行下列指令，將結果儲存至 YAML 檔案：

   gcloud run jobs describe JOB --format export > job.yaml

2. 視需要修改任何 spec.template 子項屬性，然後執行下列指令重新部署：

   gcloud run jobs replace job.yaml

   gcloud run jobs replace 指令預設會使用 job.yaml 檔案 (如有)。

3. 如要執行工作，請參閱「執行工作」或「依排程執行工作」。

Terraform

使用 terraform apply 指令，在 main.tf 檔案中變更工作設定。如需詳細的 Terraform 操作說明，請參閱：

• 平行處理
• 重試次數上限
• 逾時

詳情請參閱 terraform apply 指令列選項。

用戶端程式庫

如要透過程式碼更新現有工作，請按照下列步驟操作：

• Go
• Java
• Node.js
• Python
• Ruby
• PHP
• .NET

REST API

如要更新工作，請向 Cloud Run Admin API jobs 端點傳送 PATCH HTTP 要求。

例如，使用 curl：

curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -X PATCH \
  -d '{template: {template: {containers: [{image: "IMAGE_URL"}]}}}' \
  https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs/JOB

更改下列內容：

• ACCESS_TOKEN：帳戶的有效存取權杖，該帳戶必須具備更新工作的 IAM 權限。舉例來說，如果您已登入 gcloud，可以使用 gcloud auth print-access-token 擷取存取權杖。在 Cloud Run 容器執行個體中，您可以使用容器執行個體中繼資料伺服器擷取存取權杖。
• IMAGE_URL：容器映像檔的參照，例如 us-docker.pkg.dev/cloudrun/container/job:latest。
• PROJECT_ID： Google Cloud 專案 ID。
• REGION：工作的 Google Cloud 區域。
• JOB：要更新的工作名稱。

控制台

1. 前往 Google Cloud 控制台的「Cloud Run jobs」(Cloud Run 工作) 頁面：

   前往「Cloud Run jobs」(Cloud Run 工作)

2. 如要部署至現有工作，請按一下「Jobs」(工作)。在工作清單中找到工作，然後按一下開啟。然後按一下「View and edit configuration」(查看及編輯設定)，顯示編輯工作表單。

3. 如要建立新工作，請按一下「Deploy container」(部署容器)。提供容器映像檔網址和工作名稱。

4. 按一下「容器、網路、安全性」

5. 在「Edit container」(編輯容器) 資訊卡中，視需要設定主要工作容器。

6. 按一下「Add container」(新增容器)，然後設定要與主要工作容器一併新增的邊車容器。如果 sidecar 依附於服務中的其他容器，請在「Container start-up order」(容器啟動順序) 下拉式選單中指明。為要部署的每個邊車容器重複這個步驟。

7. 按一下「Create」(建立) 建立新服務，或按一下「Update」(更新) 更新現有工作，然後等待部署作業完成。

gcloud

1. 在 Google Cloud 控制台啟用 Cloud Shell。

   啟用 Cloud Shell

   Google Cloud 控制台底部會開啟 Cloud Shell 工作階段，並顯示指令列提示。Cloud Shell 是已安裝 Google Cloud CLI 的殼層環境，並已設定適用於您目前專案的值。工作階段可能要幾秒鐘的時間才能初始化。

2. 如要將多個容器部署至工作，請執行下列指令：

   gcloud run jobs create JOB \
    --container JOB_CONTAINER_NAME \
    --image='IMAGE_URL' \
    --container SIDECAR_CONTAINER_NAME \
    --image='SIDECAR_IMAGE'

   更改下列內容：

   • JOB：Cloud Run 工作名稱。
   • JOB_CONTAINER_NAME：主要工作容器的名稱。
   • IMAGE_URL：容器映像檔的參照，例如 us-docker.pkg.dev/cloudrun/container/job:latest。
   • SIDECAR_CONTAINER_NAME：邊車容器的名稱，例如 sidecar。
   • SIDECAR_IMAGE：邊車容器映像檔的參照。

   如要在 deploy 指令中設定每個容器，請在 container 參數後方提供每個容器的設定，例如：

   gcloud run jobs create JOB \
     --container CONTAINER_1_NAME \
     --image='IMAGE_URL' \
     --set-env-vars=KEY=VALUE \
     --container SIDECAR_CONTAINER_NAME \
     --image='SIDECAR_IMAGE' \
     --set-env-vars=KEY_N=VALUE_N

3. 等待工作部署作業完成。成功完成後，系統會顯示成功訊息。

YAML

1. 如果您要建立新工作，請略過這個步驟。如要更新現有工作，請下載其 YAML 設定：

   gcloud run jobs describe JOB --format export > job.yaml

2. 更新 containers: 屬性：

   apiVersion: run.googleapis.com/v1
   kind: Job
   metadata:
     name: JOB
   spec:
     template:
       spec:
         containers:
         - image: IMAGE_URL
         - image: SIDECAR_IMAGE
   

   更改下列內容：

   • JOB：Cloud Run 工作名稱。
   • IMAGE_URL：容器映像檔的參照，例如 us-docker.pkg.dev/cloudrun/container/job:latest。
   • SIDECAR_IMAGE：sidecar 容器映像檔的參照。

3. 使用下列指令建立或更新工作：

   gcloud run jobs replace job.yaml

   gcloud run jobs replace 指令預設會使用 job.yaml 檔案 (如有)。

Terraform

如要瞭解如何套用或移除 Terraform 設定，請參閱「基本 Terraform 指令」。

resource "google_cloud_run_v2_job" "default" {
  name     = "JOB"
  location = "europe-west1"

  template {
    template {
      containers {
        name = "CONTAINER_NAME"
        image = "IMAGE_URL"
      }
      containers {
        name = "SIDECAR_CONTAINER_NAME"
        image = "SIDECAR_IMAGE_URL"
      }
    }
  }
}

更改下列內容：

• JOB：Cloud Run 工作名稱。
• CONTAINER_NAME：容器名稱。
• IMAGE_URL：容器映像檔的參照，例如 us-docker.pkg.dev/cloudrun/container/job:latest。
• SIDECAR_CONTAINER_NAME：邊車容器的名稱。
• SIDECAR_IMAGE_URL：邊車容器映像檔的參照。