Menentukan dan menggunakan jenis target kustom

Menentukan dan menggunakan jenis target kustom

Panduan memulai ini menunjukkan cara menggunakan Cloud Deploy untuk membuat jenis target kustom, lalu men-deploy ke target kustom dari jenis tersebut.

Dalam panduan memulai ini, Anda akan melakukan hal berikut:

1. Tentukan jenis target kustom, tempat Anda akan mengonfigurasi perilaku target. Konfigurasi ini mereferensikan image container dan perintah shell untuk dijalankan pada image tersebut, yang merupakan tindakan untuk operasi render dan deployment.

2. Tentukan target yang mereferensikan jenis target kustom.

3. Tentukan pipeline pengiriman Cloud Deploy Anda.

   Pipeline ini hanya mencakup satu tahap dan hanya menggunakan satu target. Pada tahap tersebut, Anda akan mereferensikan target yang dikonfigurasi.

4. Buat konfigurasi Skaffold, yang diperlukan oleh rilis.

5. Buat rilis, yang secara otomatis membuat peluncuran, sehingga operasi rendering dan deployment kustom dilakukan.

   Sebagai bagian dari rilis dan peluncuran ini, operasi render dan deployment yang ditentukan dalam konfigurasi jenis target kustom Anda akan dijalankan.

6. Lihat hasil operasi kustom. Hal ini mencakup file konfigurasi yang dirender dan diupload ke Cloud Storage, serta string yang ditulis ke file tersebut, dan file hasil yang mencakup status operasi.

Sebelum memulai

Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
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.
Aktifkan Cloud Deploy API, Cloud Build API, GKE API, Cloud Run API, dan Cloud Storage API.
Peran yang diperlukan untuk mengaktifkan API
Untuk mengaktifkan API, Anda memerlukan peran IAM Service Usage Admin (roles/serviceusage.serviceUsageAdmin), yang berisi izin serviceusage.services.enable. Pelajari cara memberikan peran.
Aktifkan API
Instal Google Cloud CLI.
Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.
Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:
gcloud init
Catatan: Anda dapat menjalankan gcloud CLI di konsol Google Cloud tanpa menginstal Google Cloud CLI. Untuk menjalankan gcloud CLI di konsol Google Cloud , gunakan Cloud Shell.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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.

Aktifkan Cloud Deploy API, Cloud Build API, GKE API, Cloud Run API, dan Cloud Storage API.

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan peran IAM Service Usage Admin (roles/serviceusage.serviceUsageAdmin), yang berisi izin serviceusage.services.enable. Pelajari cara memberikan peran.

Aktifkan API

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

Catatan: Anda dapat menjalankan gcloud CLI di konsol Google Cloud tanpa menginstal Google Cloud CLI. Untuk menjalankan gcloud CLI di konsol Google Cloud , gunakan Cloud Shell.

Jika Anda sudah menginstal Google Cloud CLI, pastikan Anda menjalankan versi terbaru:

gcloud components update

1. Pastikan akun layanan Compute Engine default memiliki izin yang memadai.

   Akun layanan mungkin sudah memiliki izin yang diperlukan. Langkah-langkah ini disertakan untuk project yang menonaktifkan pemberian peran otomatis untuk akun layanan default.

1. Pertama, tambahkan peran clouddeploy.jobRunner:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/clouddeploy.jobRunner"
   

2. Tambahkan peran developer untuk runtime tertentu.
3. Tambahkan peran iam.serviceAccountUser, yang mencakup izin actAs untuk men-deploy ke runtime:

   gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/iam.serviceAccountUser" \
       --project=PROJECT_ID
   

Membuat pipeline pengiriman, jenis target kustom, dan target

Anda dapat menentukan pipeline pengiriman, jenis target kustom, dan target dalam satu file atau dalam file terpisah. Dalam panduan memulai ini, Anda akan membuat satu file dengan ketiga jenis tersebut.

1. Buka jendela terminal.

2. Buat direktori baru dan buka direktori tersebut.

   mkdir custom-target-quickstart
   cd custom-target-quickstart
   

3. Di direktori custom-target-quickstart, buat file baru, clouddeploy.yaml, dengan konten berikut:

   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
   tasks:
     render:
       type: 'container'
       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
     deploy:
       type: 'container'
       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
   

   Definisi jenis target kustom mencakup tasks stanza, yang menentukan tugas render dan tugas deployment. Setiap tugas ini merujuk ke image container yang akan dijalankan, dan perintah yang akan dijalankan di container tersebut.

   Catatan: Jenis target kustom dan target disertakan dengan pipeline pengiriman dalam file ini, tetapi Anda dapat menentukannya dalam file terpisah atau beberapa file terpisah.

4. Daftarkan pipeline dan target Anda dengan layanan Cloud Deploy:

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

   Sekarang Anda memiliki pipeline pengiriman, dengan satu target. Ini adalah target Anda menggunakan jenis target kustom, dan pipeline ini tidak men-deploy aplikasi ke runtime.

5. Konfirmasi pipeline dan target Anda:

   Di konsol Google Cloud , buka halaman Cloud Deploy Delivery pipelines untuk melihat daftar pipeline pengiriman yang tersedia.

   Buka halaman Delivery pipelines

   Pipeline pengiriman yang baru saja Anda buat akan ditampilkan, dengan satu target yang tercantum di kolom Target.

   

Membuat file konfigurasi Skaffold

Rilis dalam panduan memulai ini memerlukan file konfigurasi Skaffold, tetapi file ini tidak memerlukan konfigurasi yang berarti.

1. Buat file bernama skaffold.yaml dengan konten berikut:

   apiVersion: skaffold/v4beta7
   kind: Config
   

Membuat rilis

Rilis adalah resource Cloud Deploy pusat yang merepresentasikan perubahan yang di-deploy. Pipeline pengiriman menentukan siklus proses rilis tersebut. Lihat Arsitektur layanan Cloud Deploy untuk mengetahui detail tentang siklus proses tersebut.

Jalankan perintah berikut dari direktori custom-target-quickstart untuk membuat resource release yang merepresentasikan tindakan kustom yang akan di-deploy:

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

Seperti semua rilis (kecuali jika menyertakan --disable-initial-rollout), Cloud Deploy juga otomatis membuat resource rollout. Semua fase peluncuran tersebut dijalankan, termasuk rendering dan deployment.

Melihat hasil di konsol Google Cloud

Setelah beberapa menit, deployment Anda akan selesai. Dalam kasus ini, karena dua tindakan kustom adalah perintah untuk mengulang string ke dalam file dan mengupload file ke Cloud Storage, tidak ada yang di-deploy ke runtime target mana pun.

Namun, Anda dapat melihat file dan string dalam file tersebut:

1. Di konsol Google Cloud , buka halaman Delivery pipelines Cloud Deploy untuk melihat delivery pipeline Anda (custom-targets-pipeline).

   Buka halaman Delivery pipelines

2. Klik nama pipeline pengiriman Anda (custom-targets-pipeline).

   Visualisasi pipeline menampilkan status deployment aplikasi. Karena hanya ada satu tahap dalam pipeline, visualisasi hanya menampilkan satu node.

   

   Rilis Anda juga tercantum di tab Rilis di bagian Detail pipeline pengiriman.

3. Klik nama rilis.

   Halaman Release details akan ditampilkan.

4. Klik tab Artefak.

5. Di bagian Target artifacts, klik link VIEW ARTIFACTS.

   File manifes yang dirender akan ditampilkan. Dalam hal ini, file adalah output dari tindakan render kustom yang Anda tentukan dalam konfigurasi jenis target kustom, yang berisi string "Sample manifest rendered content".

   

6. Temukan bucket Cloud Storage yang dibuat oleh rilis ini.

   Buka halaman browser Cloud Storage

   Halaman Buckets ditampilkan, yang menunjukkan dua bucket yang dibuat untuk rilis ini. Satu bucket berisi file konfigurasi pipeline pengiriman dan skaffold.yaml yang dirender. Yang lainnya mencakup file output yang dikonfigurasi untuk dibuat oleh tindakan kustom kita.

7. Klik bucket yang namanya diawali dengan us-central1.deploy-artifacts...

   

8. Klik folder yang namanya diawali dengan custom-targets-pipeline-, lalu klik folder test-release-001.

9. Klik folder yang namanya adalah nama peluncuran Anda, yang seharusnya adalah test-release-001-to-sample-env-0001.

10. Klik folder yang ditampilkan, yang merupakan UUID, lalu klik folder custom-output.

11. Klik results.json, lalu klik URL yang memiliki hyperlink di kolom URL yang Diautentikasi.

    File ini berisi string yang Anda konfigurasi sebagai output dari tindakan custom-deploy, dalam definisi jenis target kustom Anda:

    

Catatan: Anda juga dapat melihat hasil rendering di bucket Cloud Storage, tetapi lebih cepat menggunakan pemeriksa rilis, seperti yang ditunjukkan dalam langkah pertama prosedur ini.

Pembersihan

Agar akun Google Cloud Anda tidak dikenai biaya untuk resource yang digunakan pada halaman ini, ikuti langkah-langkah berikut.

1. Hapus pipeline pengiriman, target, rilis, dan peluncuran:

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

2. Hapus kedua bucket Cloud Storage yang dibuat oleh Cloud Deploy.

   Buka halaman browser Cloud Storage

Selesai, Anda telah menyelesaikan panduan memulai ini.

Langkah berikutnya

• Pelajari target kustom lebih lanjut.

• Lihat contoh jenis target kustom yang tersedia.

• Pelajari Cloud Deploy lebih lanjut.

• Pelajari dasar-dasar men-deploy aplikasi.

• Coba panduan Cloud Deploy.