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 parameter value yang berbeda ke setiap manifes atau definisi layanan yang dirender, menggunakan tiga metode berbeda.

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

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

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

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

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

3. Tentukan target deployment dan pipeline pengiriman Cloud Deploy.

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

4. Tentukan parameter deploy di tiga tempat yang berbeda:

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

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

6. Lihat "peluncuran pengontrol" dan peluncuran turunan di Konsol Google Cloud.

Sebelum memulai

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. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

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

4. Aktifkan API Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.

   Mengaktifkan API

5. Install the Google Cloud CLI.

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

   gcloud init

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

7. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

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

9. Aktifkan API Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.

   Mengaktifkan API

10. Install the Google Cloud CLI.

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

    gcloud init

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

Jika sudah menginstal CLI, pastikan Anda menjalankan versi terbaru:

gcloud components update

12. 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-tama, 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 spesifik 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 menyertakan 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 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 jaringan dari internet publik. Secara default, cluster GKE dapat diakses secara eksternal.

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 harus di-deploy dan cara men-deploy-nya dengan benar untuk target Anda yang terpisah.

Dalam panduan memulai ini, Anda akan 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 navigasikan ke dalamnya.

   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 akan diminta untuk membuat file. Namun, Anda juga dapat meminta Cloud Deploy untuk membuatkannya, untuk aplikasi non-produksi 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 sederhana, yang diterapkan ke cluster untuk men-deploy aplikasi.

   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 sederhana, yang digunakan pada waktu deployment untuk membuat layanan Cloud Run.

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

Membuat target dan pipeline pengiriman Anda

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

1. Buat pipeline pengiriman dan definisi target Anda:

   GKE

   Dalam 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"
         matchTargetLabels:
           label1: label1
       - values:
           replicaCount: "3"
         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

   Dalam 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"
         matchTargetLabels:
           label1: label1
       - values:
           minInstances: "3"
         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 ke 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 konsol Google Cloud, buka halaman Delivery pipelines Cloud Deploy untuk melihat daftar pipeline pengiriman yang tersedia.

   Buka halaman Pipeline pengiriman

   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 target multi-target dan dua target turunan) dalam file clouddeploy.yaml Anda.

   

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

Membuat rilis

Rilis adalah resource Cloud Deploy pusat yang mewakili perubahan yang sedang 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 merepresentasikan 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"

Cloud Run

Jalankan perintah berikut dari direktori deploy-run-parallel-quickstart untuk membuat resource release yang merepresentasikan 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:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc \
   --deploy-parameters="git-sha=f787cac"

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

Lihat hasil di Konsol Google Cloud

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

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

   Buka halaman Pipeline pengiriman

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

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

   

   Dan rilis Anda akan dicantumkan di tab Rilis di bagian Detail pipeline pengiriman.

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

   Peluncuran Anda akan muncul di bagian Peluncuran. Anda dapat mengklik peluncuran untuk melihat detailnya, termasuk log deployment.

   

4. Di bagian Detail rilis, pilih tab Artefak.

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

   GKE

   

   Cloud Run

   

   Selain parameter dan nilai, tabel menunjukkan target penerapan setiap parameter.

5. Di kolom Release inspector, klik View headers 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 akun Google Cloud Anda tidak dikenakan biaya untuk resource yang digunakan pada halaman ini, ikuti langkah-langkah berikut.

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 peluncuran:

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

3. Hapus bucket Cloud Storage yang dibuat Cloud Deploy.

   Salah satunya 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 selanjutnya

• Pelajari lebih lanjut cara menggunakan parameter deploy.

• Baca selengkapnya tentang cara men-deploy ke beberapa target secara bersamaan.

• Pelajari lebih lanjut Cloud Deploy.

• Pelajari dasar-dasar men-deploy aplikasi.

• Coba panduan Cloud Deploy.

• Pelajari cara mengelola manifes.

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