定義及使用自訂目標類型

本快速入門導覽課程說明如何使用 Cloud Deploy 建立自訂目標類型,然後部署至該類型的自訂目標。

在本快速入門導覽課程中,您將執行以下操作:

  1. 建立 Skaffold 設定。

    您可以在 Skaffold 設定檔中設定目標的行為。這項設定會參照容器映像檔和殼層指令,以便在這些映像檔上執行,這些是轉譯和部署作業的動作。

  2. 定義自訂目標類型,以及參照該類型的目標。

  3. 定義 Cloud Deploy 推送管道。

    這個管道只包含一個階段,且只使用一個目標。在該階段中,您會參照所設定的目標。

  4. 建立版本,系統會自動建立發布作業,進而執行自訂轉譯和部署作業。

    在這個版本和推行期間,系統會執行您在 Skaffold 設定中定義的轉譯和部署作業。

  5. 查看自訂作業的結果。這包括上傳至 Cloud Storage 的算繪設定檔、寫入該檔案的字串,以及包含作業狀態的結果檔案。

事前準備

  1. 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.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

    Enable the APIs

  5. Install the Google Cloud CLI.

  6. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  7. To initialize the gcloud CLI, run the following command:

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

    Go to project selector

  9. Make sure that billing is enabled for your Google Cloud project.

  10. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

    Enable the APIs

  11. Install the Google Cloud CLI.

  12. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  13. To initialize the gcloud CLI, run the following command:

    gcloud init
  14. 如果您已安裝 Google Cloud CLI,請確認您執行的是最新版本:

    gcloud components update
    
  15. 請確認預設 Compute Engine 服務帳戶具備足夠的權限。

    服務帳戶可能已具備必要權限。如果專案已停用為預設服務帳戶自動授予角色的功能,則適用這些步驟。

    1. 首先新增 clouddeploy.jobRunner 角色:
      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
          --role="roles/clouddeploy.jobRunner"
      
    2. 為特定執行階段新增開發人員角色。
    3. 新增 iam.serviceAccountUser 角色,其中包含要部署至執行階段的 actAs 權限:
      gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
          --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
          --role="roles/iam.serviceAccountUser" \
          --project=PROJECT_ID
      

準備 Skaffold 設定

Cloud Deploy 會使用 Skaffold 提供詳細資訊,說明要部署哪些內容,以及如何將這些內容部署至目標

在本快速入門導覽課程中,您將建立 skaffold.yaml 檔案,其中定義了代表自訂目標類型的轉譯和部署作業的自訂動作。

請注意,這個快速入門手冊中提供的自訂動作實際上並不會將任何應用程式部署至執行階段。轉譯和部署動作都會將結果檔案上傳至 Cloud Storage,以履行 Cloud Deploy 與使用者定義的轉譯和部署作業之間的客製目標合約。

  1. 開啟終端機視窗。

  2. 建立新目錄並前往該目錄。

    mkdir custom-target-quickstart
    cd custom-target-quickstart
    
  3. 建立名為 skaffold.yaml 的檔案,並在當中加入下列內容:

    apiVersion: skaffold/v4beta7
    kind: Config
    customActions:
    - name: custom-render
      containers:
      - name: render
        image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:484e8266c1cfc84b283bc6d4eec1f6b61223115178cce76fb59f77b223f26e8e
        command: ['/bin/bash']
        args:
          - '-c'
          - |-
            echo "Sample manifest rendered content" > manifest.txt
            gcloud storage cp manifest.txt $CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt
            echo {\"resultStatus\": \"SUCCEEDED\", \"manifestFile\": \"$CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt\"} > results.json
            gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
    - name: custom-deploy
      containers:
      - name: deploy
        image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:484e8266c1cfc84b283bc6d4eec1f6b61223115178cce76fb59f77b223f26e8e
        command: ['/bin/bash']
        args:
          - '-c'
          - |-
            echo {\"resultStatus\": \"SUCCEEDED\"} > results.json
            gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
    

    這個檔案包含 customActions: 節,定義自訂轉譯動作和自訂部署動作。每個自訂動作都會參照要執行的容器映像檔,以及要在該容器中執行的指令。

    如要進一步瞭解這個設定檔,請參閱 skaffold.yaml 參考資料

建立推送管道、自訂目標類型和目標

您可以在單一檔案或個別檔案中定義提交管道、自訂目標類型和目標。在本快速入門導覽課程中,您會建立包含所有這三種內容的單一檔案。

  1. 在 custom-target-quickstart 目錄中,建立名為 clouddeploy.yaml 的新檔案,並在其中加入下列內容:

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: custom-targets-pipeline
    serialPipeline:
      stages:
      - targetId: sample-env
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: sample-env
    customTarget:
      customTargetType: basic-custom-target
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: CustomTargetType
    metadata:
      name: basic-custom-target
    customActions:
      renderAction: custom-render
      deployAction: custom-deploy
    
  2. 使用 Cloud Deploy 服務註冊管道和目標:

    gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
    

    您現在有一個含有一個目標的推送管道。這是使用自訂目標類型的目標,而且這個管道不會將應用程式部署至執行階段。

  3. 確認管道和目標:

    在 Google Cloud 控制台中,前往 Cloud Deploy 的「Delivery pipelines」(推送管道) 頁面,查看可用的推送管道清單。

    開啟「Delivery pipelines」頁面

    系統會顯示您剛建立的推送管道,並在「目標」欄中列出一個目標。

     Google Cloud 控制台的「Delivery pipeline」頁面,顯示 pipeline

建立版本

版本是代表待部署變更的集中式 Cloud Deploy 資源。發布管道會定義該版本的生命週期。如要進一步瞭解這個生命週期,請參閱 Cloud Deploy 服務架構

custom-target-quickstart 目錄執行下列指令,建立代表要部署的自訂動作的 release 資源:

gcloud deploy releases create test-release-001 \
  --project=PROJECT_ID \
  --region=us-central1 \
  --delivery-pipeline=custom-targets-pipeline

如同所有版本 (除非包含 --disable-initial-rollout),Cloud Deploy 也會自動建立rollout 資源。並執行該推播作業的所有階段,包括算繪和部署。

在 Google Cloud 控制台中查看結果

幾分鐘後,部署作業就會完成。在本例中,由於這兩個自訂動作是用來將字串回應至檔案,並將檔案上傳至 Cloud Storage 的指令,因此不會將任何內容部署至任何目標執行階段。

不過,您可以查看該檔案和檔案中的字串:

  1. 在 Google Cloud 控制台中,前往 Cloud Deploy 的「Delivery pipelines」(推送管道) 頁面,查看推送管道 (custom-targets-pipeline)。

    開啟「Delivery pipelines」頁面

  2. 按一下推送管道名稱 (custom-targets-pipeline)。

    管道示意圖會顯示應用程式的部署狀態。由於管道中只有一個階段,因此視覺化資訊只會顯示一個節點。

    顯示成功的推送管道圖表

    你的版本會列在「發布管道詳細資料」下方的「版本」分頁中。

  3. 按一下版本名稱。

    系統會顯示「Release details」(發布詳細資料) 頁面。

  4. 按一下「Artifacts」分頁標籤。

  5. 在「目標構件」下方,按一下「查看構件」連結。

    系統會顯示已轉譯的資訊清單檔案。在這種情況下,檔案是您在 skaffold.yaml 設定檔中定義的自訂轉譯動作輸出內容,其中包含「Sample manifest rendered content」字串。

    自訂轉譯動作的輸出內容

  6. 找出這個版本建立的 Cloud Storage 值區。

    開啟 Cloud Storage 瀏覽器頁面

    系統會顯示「Buckets」頁面,其中列出為此版本建立的兩個值區。一個值區包含提交管道設定檔和轉譯的 skaffold.yaml。另一個則包含自訂動作設定為建立的輸出檔案。

  7. 按一下名稱開頭為 us-central1.deploy-artifacts 的值區...

    Cloud Storage 值區清單

  8. 按一下名稱開頭為 custom-targets-pipeline- 的資料夾,然後按一下 test-release-001 資料夾。

  9. 按一下名稱為您所選推播名稱的資料夾,該資料夾應為 test-release-001-to-sample-env-0001

  10. 按一下顯示的資料夾 (即 UUID),然後點選 custom-output 資料夾。

  11. 按一下 results.json,然後點選「Authenticated URL」欄位中的超連結網址。

    這個檔案包含您在 skaffold.yaml 中,將做為 custom-deploy 動作輸出的字串:

    部署自訂動作的輸出內容

清除所用資源

如要避免系統向您的 Google Cloud 帳戶收取您在本頁所用資源的費用,請按照下列步驟操作。

  1. 刪除推送管道、目標、版本和推出項目:

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
    
  2. 刪除 Cloud Deploy 建立的兩個 Cloud Storage 值區。

    開啟 Cloud Storage 瀏覽器頁面

大功告成,您已經完成本快速入門導覽課程!

後續步驟