Menjalankan hook sebelum dan sesudah men-deploy

Menjalankan hook sebelum dan sesudah men-deploy

Panduan memulai ini menunjukkan cara menjalankan hook deploy, yaitu program arbitrer yang akan dijalankan sebelum atau sesudah Anda melakukan deployment menggunakan Cloud Deploy.

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

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

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

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

   File konfigurasi Skaffold adalah tempat Anda mengonfigurasi hook deploy untuk dijalankan. Anda mengidentifikasi container yang akan dijalankan sebelum men-deploy, dan container yang akan dijalankan setelah deployment.

3. Tentukan pipeline pengiriman Cloud Deploy dan target deployment Anda.

   Dalam konfigurasi pipeline pengiriman, Anda akan mereferensikan hook deploy yang ditentukan dalam skaffold.yaml, untuk menjalankan hook tersebut.

   Pipeline ini hanya menyertakan satu tahap dan hanya menggunakan satu target.

4. Buat rilis, yang otomatis di-deploy ke target.

   Salah satu hook dijalankan sebelum aplikasi di-deploy, dan hook lainnya dijalankan setelahnya.

5. Lihat hasil hook pra-dan pasca-deployment di log Cloud Build, menggunakan halaman detail Peluncuran Cloud Deploy di Konsol Google Cloud.

Sebelum memulai

1. 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.

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. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

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

   Enable the APIs

5. Menginstal Google Cloud CLI.

6. Untuk initialize 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.

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. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

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

   Enable the APIs

10. Menginstal Google Cloud CLI.

11. Untuk initialize 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 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 satu cluster: deploy-hooks-cluster, 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-hooks-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

Menyiapkan konfigurasi dan manifes aplikasi Skaffold

Cloud Deploy menggunakan Skaffold untuk memberikan detail tentang apa yang harus di-deploy dan cara men-deploy-nya ke target Anda.

Dalam panduan memulai ini, Anda membuat file skaffold.yaml, yang mengidentifikasi manifes yang akan digunakan untuk men-deploy aplikasi contoh, dan juga mengidentifikasi container yang akan dijalankan sebelum dan sesudah deployment (hook deploy).

1. Buka jendela terminal.

2. Buat direktori baru dan navigasikan ke dalamnya.

   GKE

   mkdir deploy-hooks-gke-quickstart
   cd deploy-hooks-gke-quickstart
   

   Cloud Run

   mkdir deploy-hooks-run-quickstart
   cd deploy-hooks-run-quickstart
   

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

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - k8s-pod.yaml
   deploy:
     kubectl: {}
   customActions:
   - name: predeploy-action
     containers:
     - name: predeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a predeploy action"' ]
   - name: postdeploy-action
     containers:
     - name: postdeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a postdeploy action"' ]
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   customActions:
   - name: predeploy-action
     containers:
     - name: predeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a predeploy action"' ]
   - name: postdeploy-action
     containers:
     - name: postdeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a postdeploy action"' ]
   

   File ini menyertakan stanza customActions:. Ini menentukan container yang akan dijalankan sebelum dan sesudah deployment, yaitu hook.

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

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

   GKE

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

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-hooks-pod
   spec:
     containers:
     - name: nginx
       image: my-app-image
   

   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-hooks-run-service
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   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 dapat menentukan pipeline dan target Anda dalam satu file atau dalam file terpisah. Dalam panduan memulai ini, Anda akan membuat satu file.

1. Buat pipeline pengiriman dan definisi target Anda:

   GKE

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-gke-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             actions: ["predeploy-action"]
           postdeploy:
             actions: ["postdeploy-action"]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: hooks staging cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-hooks-cluster
   

   Cloud Run

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-run-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             actions: ["predeploy-action"]
           postdeploy:
             actions: ["postdeploy-action"]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: staging Run service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

   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 pengiriman, dengan satu target, yang siap untuk men-deploy aplikasi serta menjalankan tugas pra-deployment dan pasca-deployment.

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, dengan satu target tercantum di kolom Targets.

   

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-hooks-gke-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=deploy-hooks-demo-app-gke-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Cloud Run

Jalankan perintah berikut dari direktori deploy-hooks-run-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=deploy-hooks-demo-app-run-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc

Seperti semua rilis (kecuali jika menyertakan --disable-initial-rollout), Cloud Deploy juga secara otomatis membuat resource peluncuran. Aplikasi secara otomatis di-deploy ke satu target yang dikonfigurasi untuk pipeline pengiriman ini.

Selain itu, tugas pra-deployment akan berjalan sebelum aplikasi di-deploy, dan tugas pasca-deployment akan berjalan setelahnya.

Lihat hasil di Konsol Google Cloud

Setelah beberapa menit, rilis Anda akan di-deploy ke runtime target.

Hook pra-dan pasca-deployment yang kami konfigurasi (misalnya tujuan) mencetak string ke log Cloud Build. Kita dapat melihat log tersebut untuk mengonfirmasi bahwa {i>hook<i} bekerja seperti yang diharapkan.

1. Di konsol Google Cloud, buka halaman Delivery pipelines Cloud Deploy untuk melihat pipeline pengiriman Anda ("deploy-hooks-demo-app-gke-1" atau "deploy-hooks-demo-app-run-1").

   Buka halaman Pipeline pengiriman

2. Klik nama pipeline pengiriman Anda ("deploy-hooks-demo-app-gke-1" atau "deploy-hooks-demo-app-run-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 tab Peluncuran, di bagian Detail pipeline pengiriman.

4. Klik nama peluncuran untuk melihat detail peluncuran.

   

   Predeploy dan Postdeploy tercantum sebagai tugas.

5. Klik Pra-deploy

   Log pengoperasian tugas akan ditampilkan.

6. Scroll ke bawah dalam daftar entri log untuk menemukan predeploy-echo, lalu klik.

   

   Perhatikan textPayload. String tersebut adalah yang telah dikonfigurasi di predeploy-action dalam konfigurasi Skaffold Anda.

7. Klik tugas Postdeploy, lalu cari entri log postdeploy-echo.

   

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-hooks-cluster --region=us-central1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-hooks-run-service --region=us-central1 --project=PROJECT_ID
   

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

• Pelajari dasar-dasar men-deploy aplikasi.

• Coba panduan Cloud Deploy.

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