Mengotomatiskan promosi rilis dan kemajuan peluncuran di Cloud Deploy

Mengotomatiskan promosi rilis dan kemajuan peluncuran di Cloud Deploy

Halaman ini menunjukkan cara menggunakan Cloud Deploy untuk mempromosikan rilis ke target secara otomatis dan memajukan peluncuran ke fase berikutnya.

Dalam panduan memulai ini, Anda akan melakukan hal berikut:

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

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

3. Menentukan target deployment dan pipeline pengiriman Cloud Deploy.

   Pipeline akan di-deploy ke dua target: dev dan staging. Target staging menggunakan strategi deployment canary.

4. Menentukan dua aturan otomatisasi:

   • Otomatisasi untuk mempromosikan rilis ke target staging setelah peluncuran berhasil ke dev.

   • Otomatisasi untuk memajukan peluncuran ke fase stable setelah fase canary-25 berhasil diselesaikan.

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

6. Melihat pipeline pengiriman dan rilis di Google Cloud konsol.

   Karena promosi otomatis, rilis ini dipromosikan ke staging secara otomatis.

   Karena target staging menggunakan strategi deployment canary, dan ini adalah deployment pertama ke runtime tersebut, fase canary-25 akan dilewati. Lihat Mengapa fase terkadang dilewati untuk memahami lebih lanjut alasan fase canary dilewati pada saat pertama kali.

   Karena kemajuan fase otomatis, peluncuran akan dimajukan ke fase stable.

Sebelum memulai

Login ke akun Anda. Google Cloud 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 clouddeploy.releaser:

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

   3. Tambahkan peran developer untuk runtime tertentu.
   • 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"
     

   4. Tambahkan peran iam.serviceAccountUser, yang mencakup izin actAs untuk akun layanan default agar dapat di-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
      

   5. Tambahkan peran iam.serviceAccountUser, termasuk izin actAs untuk Anda sendiri, agar dapat menggunakan akun layanan default:

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

      Dalam hal ini, YOUR_EMAIL_ADDRESS adalah alamat email yang Anda gunakan untuk mengakses Google Cloud.

Membuat lingkungan runtime

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

Untuk GKE, buat dua cluster: automation-quickstart-cluster-dev dan automation-quickstart-cluster-staging, dengan setelan default. Endpoint Kubernetes API cluster harus dapat dijangkau jaringan dari internet publik. Cluster GKE dapat diakses secara eksternal secara default.

gcloud container clusters create-auto automation-quickstart-cluster-dev \
                 --project=PROJECT_ID \
                 --region=us-central1 \
                 && gcloud container clusters create-auto automation-quickstart-cluster-staging \
                 --project=PROJECT_ID \
                 --region=us-central1

Mendapatkan nomor project.

Anda memerlukan nomor project untuk mengidentifikasi akun layanan default. Hal ini diperlukan untuk mengonfigurasi resource otomatisasi.

1. Jalankan perintah berikut untuk mendapatkan nomor project Anda:

   gcloud projects describe PROJECT_ID --format="value(projectNumber)"
   

2. Salin nomor project dari output command line, lalu tempelkan di sini.

   Anda tidak perlu menjalankan ini sebagai perintah. Menempelkannya di sini akan mengisi referensi akun layanan dalam konfigurasi otomatisasi nanti dalam panduan memulai ini.

   PROJECT_NUMBER
   

Menyiapkan konfigurasi Skaffold dan manifes aplikasi

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 aplikasi yang akan digunakan untuk men-deploy aplikasi contoh.

1. Buka jendela terminal.

2. Buat direktori baru dan buka direktori tersebut.

   GKE

   mkdir deploy-automation-gke-quickstart
   cd deploy-automation-gke-quickstart
   

   Cloud Run

   mkdir deploy-automation-run-quickstart
   cd deploy-automation-run-quickstart
   

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

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata:
     name: gke-automation
   manifests:
     rawYaml:
     - k8s-deployment.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata:
     name: run-automation
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-dev.yaml
   - name: staging
     manifests:
       rawYaml:
       - run-staging.yaml
   deploy:
     cloudrun: {}
   

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

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

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

   GKE

   Buat file bernama k8s-deployment.yaml, dengan konten berikut:

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
     labels:
       app: my-app
     namespace: default
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
       spec:
         containers:
         - name: nginx
           image: my-app-image
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: my-service
     namespace: default
   spec:
     selector:
       app: my-app
     ports:
       - protocol: TCP
         port: 80
   

   File ini adalah manifes Kubernetes sederhana, 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.

   Cloud Run

   1. Buat file bernama run-dev.yaml, dengan konten berikut:

      apiVersion: serving.knative.dev/v1
      kind: Service
      metadata:
        name: my-automation-run-service-dev
      spec:
        template:
          spec:
            containers:
            - image: my-app-image
      

   2. Buat file bernama run-staging.yaml, dengan konten berikut:

      apiVersion: serving.knative.dev/v1
      kind: Service
      metadata:
        name: my-automation-run-service-staging
      spec:
        template:
          spec:
            containers:
            - image: my-app-image
      

   File ini adalah definisi layanan Cloud Run sederhana, 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.

Membuat pipeline pengiriman, target, dan otomatisasi

Anda dapat menentukan pipeline pengiriman dan target dalam satu file atau dalam file terpisah. Anda juga dapat menentukan tindakan otomatisasi dalam file terpisah. Panduan memulai ini menggunakan satu file untuk pipeline, target, dan otomatisasi.

1. Buat pipeline pengiriman, definisi target, dan tindakan otomatisasi:

   GKE

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-automation-demo-app-1
   description: Automation demonstration pipeline
   serialPipeline:
     stages:
     - targetId: automation-quickstart-dev
     - targetId: automation-quickstart-staging
       profiles: []
       strategy:
         canary:
           runtimeConfig:
             kubernetes:
               serviceNetworking:
                 service: "my-service"
                 deployment: "my-deployment"
           canaryDeployment:
             percentages: [25]
             verify: false
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-dev
   description: Dev cluster to demonstrate deploy automation
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-dev
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-staging
   description: Staging cluster to demonstrate deploy automation
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-staging
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/promote
   description: promotes a release
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-dev
   rules:
   - promoteReleaseRule:
       id: "promote-release"
       wait: 1m
       destinationTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       id: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

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

   Cloud Run

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-automation-demo-app-1
   description: Automation demonstration pipeline
   serialPipeline:
     stages:
     - targetId: automation-quickstart-dev
       profiles: [dev]
     - targetId: automation-quickstart-staging
       profiles: [staging]
       strategy:
         canary:
           runtimeConfig:
             cloudRun:
               automaticTrafficControl: true
           canaryDeployment:
             percentages: [25]
             verify: false
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-dev
   description: Dev cluster to demonstrate deploy automation
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-staging
   description: Staging cluster to demonstrate deploy automation
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/promote
   description: Promotes a release to the next target
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-dev
   rules:
   - promoteReleaseRule:
       id: "promote-release"
       wait: 1m
       destinationTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       id: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

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

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

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

   Kini 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 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 dua target yang tercantum di kolom Targets.

   

4. Klik nama pipeline untuk membuka visualisasi dan detail pipeline pengiriman.

5. Pilih tab Automations, di bagian Delivery pipeline details.

   Dua otomatisasi yang Anda buat akan 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-automation-gke-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-automation-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

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-automation-run-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-automation-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

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.

Secara default, saat Anda membuat rilis, peluncuran akan dibuat secara otomatis untuk target pertama dalam pipeline Anda.

Karena panduan memulai ini menyertakan dua otomatisasi, dua hal akan terjadi secara otomatis:

• Setelah deployment berhasil di target pertama, rilis akan otomatis dipromosikan ke target kedua.

  Ada waktu tunggu satu menit pada otomatisasi promosi.

• Di target kedua, tempat canary 25% dikonfigurasi, otomatisasi kedua akan memajukan peluncuran dari canary-25 ke stable.

  Untuk rilis pertama ini, fase canary-25 akan dilewati, karena tidak ada versi aplikasi yang sudah ada untuk dibandingkan dengan canary. Dan peluncuran akan otomatis dimajukan ke stable.

  Ada penundaan satu menit pada otomatisasi lanjutan.

Setelah semuanya selesai, aplikasi akan berhasil di-deploy ke kedua target tanpa Anda harus melakukan apa pun lebih lanjut.

Jika ingin mengetahui lebih lanjut cara menjalankan strategi deployment canary, Anda dapat mencoba panduan memulai canary.

Melihat hasil di Google Cloud konsol

Anda dapat melihat hasilnya, termasuk menjalankan otomatisasi, di Google Cloud konsol.

1. Buka halaman Cloud Deploy Delivery pipelines untuk melihat pipeline pengiriman Anda.

   Buka halaman Delivery pipelines

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

   Visualisasi pipeline menunjukkan status deployment aplikasi. Jika waktu yang cukup telah berlalu, kedua target akan berwarna hijau.

   

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

3. Klik tab Automation runs.

   Ada dua entri, satu untuk setiap dua otomatisasi yang Anda buat. Anda dapat mengklik salah satu untuk melihat detail otomatisasi tersebut.

   

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 automation-quickstart-cluster-dev --region=us-central1 --project=PROJECT_ID \
   && gcloud container clusters delete automation-quickstart-cluster-staging --region=us-west1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-automation-run-service-dev --region=us-central1 --project=PROJECT_ID \
   && gcloud run services delete my-automation-run-service-staging --region=us-central1 --project=PROJECT_ID
   

2. Hapus pipeline pengiriman, target, otomatisasi, 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.

   Satu 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 Cloud Deploy lebih lanjut.

• Coba otomatisasi lainnya.

• Pelajari dasar-dasar men-deploy aplikasi.

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