Menggunakan parameter deploy

Menggunakan parameter deploy

Halaman ini menunjukkan cara menggunakan Cloud Deploy untuk mengirimkan aplikasi contoh ke dua target secara bersamaan (deployment paralel), sambil meneruskan nilai parameter yang berbeda ke setiap manifes atau definisi layanan yang dirender, menggunakan tiga metode yang berbeda.

Dalam panduan memulai ini, Anda akan melakukan hal-hal berikut:

1. Membuat dua cluster GKE atau dua layanan Cloud Run.

   Anda juga dapat menggunakan cluster terlampir GKE, tetapi panduan memulai ini hanya menggunakan GKE dan Cloud Run.

2. Membuat konfigurasi Skaffold dan manifes Kubernetes atau definisi layanan Cloud Run.

   Manifes atau definisi layanan akan sama untuk kedua target turunan, tetapi pada waktu deployment manifes atau definisi layanan yang dirender untuk setiap target turunan akan memiliki nilai yang berbeda untuk parameter tertentu yang dikonfigurasi dalam panduan memulai ini.

3. Menentukan pipeline pengiriman dan target deployment Cloud Deploy.

   Pipeline ini akan memiliki satu multi-target, yang mereferensikan dua target turunan, untuk mengirimkan aplikasi Anda ke dua cluster atau dua layanan.

4. Menentukan parameter deployment di tiga tempat yang berbeda:

   • Dalam progres pipeline
   • Pada target turunan
   • Pada command line, saat membuat rilis

5. Membuat instance pipeline pengiriman dengan membuat rilis, yang otomatis di-deploy ke dua target secara paralel.

6. Melihat "rollout pengontrol" dan rollout turunan di Google Cloud konsol.

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.
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
Enable the APIs
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 Google Cloud konsol tanpa menginstal Google Cloud CLI. Untuk menjalankan gcloud CLI di konsol, gunakan Cloud Shell. Google Cloud

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.

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

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

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 Google Cloud konsol tanpa menginstal Google Cloud CLI. Untuk menjalankan gcloud CLI di konsol, gunakan Cloud Shell. Google Cloud

Jika Anda sudah menginstal 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 Anda.
   • Untuk GKE:

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

   • Untuk Cloud Run:

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

   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 lingkungan runtime

Jika Anda men-deploy ke Cloud Run, Anda dapat melewati perintah ini.

Untuk GKE, buat dua cluster: deploy-params-cluster-prod1 dan deploy-params-cluster-prod2, dengan setelan default. Endpoint Kubernetes API cluster harus dapat dijangkau melalui jaringan dari internet publik. Cluster GKE dapat diakses secara eksternal secara default.

gcloud container clusters create-auto deploy-params-cluster-prod1 \
                 --project=PROJECT_ID \
                 --region=us-central1 \
                 && gcloud container clusters create-auto deploy-params-cluster-prod2 \
                 --project=PROJECT_ID \
                 --region=us-west1

Menyiapkan konfigurasi dan manifes Skaffold

Cloud Deploy menggunakan Skaffold untuk memberikan detail tentang apa yang akan di-deploy dan cara men-deploy-nya dengan benar untuk target terpisah Anda.

Dalam panduan memulai ini, Anda membuat file skaffold.yaml, yang mengidentifikasi manifes Kubernetes atau definisi layanan Cloud Run yang akan digunakan untuk men-deploy aplikasi contoh.

1. Buka jendela terminal.

2. Buat direktori baru dan buka direktori tersebut.

   GKE

   mkdir deploy-params-gke-quickstart
   cd deploy-params-gke-quickstart
   

   Cloud Run

   mkdir deploy-params-run-quickstart
   cd deploy-params-run-quickstart
   

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

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - kubernetes.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   

   File ini adalah konfigurasi Skaffold minimal. Untuk panduan memulai ini, Anda membuat file. Namun, Anda juga dapat meminta Cloud Deploy membuatkannya untuk Anda, untuk aplikasi non-produksi yang sederhana.

   Lihat referensi skaffold.yaml untuk mengetahui informasi selengkapnya tentang file ini.

4. Buat definisi untuk aplikasi Anda—definisi layanan untuk Cloud Run atau manifes Kubernetes untuk GKE.

   GKE

   Buat file bernama kubernetes.yaml, dengan konten berikut:

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
   spec:
     replicas: 1 # from-param: ${replicaCount}
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
         annotations:
           commit: defaultShaValue # from-param: ${git-sha}
       spec:
         containers:
         - name: nginx
           image: my-app-image
           env:
           - name: envvar1
             value: default1 # from-param: ${application_env1}
           - name: envvar2
             value: default2 # from-param: ${application_env2}
   

   File ini adalah manifes Kubernetes , yang diterapkan ke cluster untuk men-deploy aplikasi. Image container yang akan di-deploy ditetapkan di sini sebagai placeholder, my-app-image, yang diganti dengan image tertentu saat Anda membuat rilis.

   Cloud Run

   Buat file bernama service.yaml, dengan konten berikut:

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: my-parallel-run-service
   spec:
     autoscaling.knative.dev/minScale: 1 # from-param: ${minInstances}
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         annotations:
           commit: defaultShaValue # from-param: ${git-sha}
       spec:
         containers:
         - image: my-app-image
           env:
           - name: envvar1
             value: defaultValue1 # from-param: ${application_env1}
           - name: envvar2
             value: defaultValue2 # from-param: ${application_env2}
   

   File ini adalah definisi layanan Cloud Run dasar, yang digunakan untuk men-deploy aplikasi. Image container yang akan di-deploy ditetapkan di sini sebagai placeholder, my-app-image, yang diganti dengan image tertentu saat Anda membuat rilis.

Catatan: Jika Anda ingin menggunakan manifes yang berbeda per target, baca artikel ini tentang mengelola manifes untuk mengetahui lebih lanjut cara menggunakan profil Skaffold.

Membuat pipeline pengiriman dan target

Anda dapat menentukan pipeline dan target dalam satu file atau dalam file terpisah. Dalam panduan memulai ini, kita akan membuat satu file.

1. Buat definisi pipeline pengiriman dan target:

   GKE

   Di direktori deploy-params-gke-quickstart, buat file baru: clouddeploy.yaml, dengan konten berikut:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-params-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: params-prod-multi
       deployParameters:
       - values:
           replicaCount: "2"
         # Apply the deploy parameter replicaCount: "2" to the target with this label
         matchTargetLabels:
           label1: label1
       - values:
           replicaCount: "3"
         # Apply the deploy parameter replicaCount: "3" to the target with this label
         matchTargetLabels:
           label2: label2
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-multi
   description: production clusters
   multiTarget:
     targetIds: [params-prod-a, params-prod-b]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-a
     labels:
       label1: label1
   description: production cluster 1
   deployParameters:
     application_env1: "sampleValue1"
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-params-cluster-prod1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-b
     labels:
       label2: label2
   description: production cluster 2
   deployParameters:
     application_env2: "sampleValue2"
   gke:
     cluster: projects/PROJECT_ID/locations/us-west1/clusters/deploy-params-cluster-prod2
   

   Catatan: Dalam file ini, target disertakan dengan pipeline pengiriman, tetapi Anda dapat menentukan target dalam file terpisah atau beberapa file terpisah.

   Cloud Run

   Di direktori deploy-params-run-quickstart, buat file baru: clouddeploy.yaml, dengan konten berikut:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-params-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: params-prod-multi
       deployParameters:
       - values:
           minInstances: "2"
         # Apply the deploy parameter minInstances: "2" to the target with this label
         matchTargetLabels:
           label1: label1
       - values:
           minInstances: "3"
         # Apply the deploy parameter minInstances: "3" to the target with this label
         matchTargetLabels:
           label2: label2
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-multi
   description: production clusters
   multiTarget:
     targetIds: [params-prod-a, params-prod-b]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-a
     labels:
       label1: label1
   description: production cluster 1
   deployParameters:
     application_env1: "sampleValue1"
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-b
     labels:
       label2: label2
   description: production cluster 2
   deployParameters:
     application_env2: "sampleValue2"
   run:
     location: projects/PROJECT_ID/locations/us-west1
   

   Catatan: Dalam file ini, target disertakan dengan pipeline pengiriman, tetapi Anda dapat menentukan target dalam file terpisah atau beberapa file terpisah.

2. 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, dengan satu multi-target yang terdiri dari dua target GKE atau Cloud Run, yang siap men-deploy aplikasi Anda.

3. Konfirmasi pipeline dan target Anda:

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

   Buka halaman Delivery pipelines

   Pipeline pengiriman yang baru saja Anda buat akan ditampilkan. Perhatikan bahwa ada satu target yang tercantum di kolom Targets meskipun Anda mengonfigurasi tiga target (satu multi-target dan dua target turunan) dalam file clouddeploy.yaml.

   

   Perhatikan bahwa satu-satunya target yang tercantum adalah multi-target params-prod-multi. Target turunan tidak ditampilkan.

Membuat rilis

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

GKE

Jalankan perintah berikut dari direktori deploy-gke-parallel-quickstart untuk membuat resource release yang mewakili image container yang akan di-deploy:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-params-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa \
   --deploy-parameters="git-sha=f787cac"

Perhatikan flag, --images= yang Anda gunakan untuk mengganti placeholder (my-app-image) dalam manifes dengan image tertentu yang memenuhi syarat SHA. Google merekomendasikan agar Anda membuat template manifes dengan cara ini, dan menggunakan nama image yang memenuhi syarat SHA saat membuat rilis.

Cloud Run

Jalankan perintah berikut dari direktori deploy-run-parallel-quickstart untuk membuat resource release yang mewakili image container yang akan di-deploy:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-params-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a \
   --deploy-parameters="git-sha=f787cac"

Perhatikan flag --images=, yang Anda gunakan untuk mengganti placeholder (my-app-image) dalam definisi layanan dengan image tertentu yang memenuhi syarat SHA. Google merekomendasikan agar Anda membuat template definisi layanan dan tugas dengan cara ini, dan menggunakan nama image yang memenuhi syarat SHA saat membuat rilis.

Seperti biasa, saat Anda membuat rilis, rollout akan dibuat secara otomatis untuk target pertama dalam pipeline Anda (kecuali jika target tertentu ditentukan menggunakan --to-target=). Dalam panduan memulai ini, target ini adalah multi-target, sehingga rollout adalah "rollout pengontrol" untuk dua target turunan, dan tidak ada target berikutnya dalam pipeline pengiriman. Artinya, aplikasi Anda di-deploy di mana saja setelah pembuatan rollout.

Melihat hasil di Google Cloud konsol

Setelah Anda membuat rilis, dan rollout pengontrol serta rollout turunan dibuat, rollout turunan tersebut kini di-deploy (atau sedang dalam proses di-deploy) ke cluster GKE atau layanan Cloud Run masing-masing.

1. Di Google Cloud konsol, buka halaman Delivery pipelines Cloud Deploy untuk melihat pipeline pengiriman my-parallel-demo-app-1.

   Buka halaman Delivery pipelines

2. Klik nama pipeline pengiriman "my-parallel-demo-app-1".

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

   

   Dan rilis Anda tercantum di tab Releases di bagian Delivery pipeline details.

3. Klik nama rilis, test-release-001.

   Rollout Anda akan muncul di bagian Rollouts. Anda dapat mengklik rollout untuk melihat detailnya, termasuk log deployment.

   

4. Di bagian Release details, pilih tab Artifacts.

   Tabel Deploy parameters mencantumkan semua parameter yang Anda konfigurasi dalam manifes dan nilai yang Anda berikan untuk parameter tersebut:

   GKE

   

   Cloud Run

   

   Selain parameter dan nilai, tabel ini juga menunjukkan target yang berlaku untuk setiap parameter.

5. Di kolom Release inspector, klik View artifacts untuk salah satu target.

6. Klik Show diff, lalu pilih params-prod-a untuk satu target, dan params-prod-b untuk target lainnya.

   Perbedaan akan ditampilkan, yang membandingkan manifes yang dirender dari kedua target, termasuk nilai yang Anda tentukan:

   GKE

   

   Cloud Run

   

Pembersihan

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

1. Hapus cluster GKE atau layanan Cloud Run:

   GKE

   gcloud container clusters delete deploy-params-cluster-prod1 --region=us-central1 --project=PROJECT_ID \
   && gcloud container clusters delete deploy-params-cluster-prod2 --region=us-west1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-parallel-run-service --region=us-central1 --project=PROJECT_ID \
   && gcloud run services delete my-parallel-run-service --region=us-west1 --project=PROJECT_ID
   

2. Hapus pipeline pengiriman, multi-target, target turunan, rilis, dan rollout:

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

3. Hapus bucket Cloud Storage yang dibuat Cloud Deploy.

   Satu bucket diakhiri dengan _clouddeploy, dan yang lainnya adalah [region].deploy-artifacts.[project].appspot.com.

   Buka halaman browser Cloud Storage

Selesai. Anda telah menyelesaikan panduan memulai ini.

Langkah berikutnya

• Pelajari lebih lanjut cara menggunakan parameter deployment.

• Baca lebih lanjut cara men-deploy ke beberapa target secara bersamaan.

• Pelajari lebih lanjut Cloud Deploy.

• Pelajari dasar-dasar men-deploy aplikasi.

• Pelajari cara mengelola manifes.

• Pelajari cara menggabungkan Google Cloud alat CI/CD untuk mengembangkan dan mengirimkan software secara efektif ke GKE.