Menjalankan hook sebelum dan setelah men-deploy

Menjalankan hook sebelum dan setelah men-deploy

Panduan memulai ini menunjukkan cara menjalankan hook deployment—program arbitrer yang akan dijalankan sebelum atau setelah Anda men-deploy menggunakan Cloud Deploy.

Dalam panduan memulai ini, Anda akan melakukan hal berikut:

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

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

2. Menentukan target deployment dan pipeline pengiriman Cloud Deploy.

   Konfigurasi pipeline pengiriman mencakup definisi hook deployment, sebagai tasks.

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

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

   File konfigurasi Skaffold adalah tempat Anda mengidentifikasi manifes yang ingin di-deploy dengan Cloud Deploy.

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

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

5. Melihat hasil hook pra-deployment dan pasca-deployment di log Cloud Build, menggunakan halaman Detail peluncuran Cloud Deploy 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 satu cluster: deploy-hooks-cluster, dengan setelan default. Endpoint Kubernetes API cluster harus dapat dijangkau oleh jaringan dari internet publik. Cluster GKE dapat diakses secara eksternal secara default.

gcloud container clusters create-auto deploy-hooks-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

Membuat target dan pipeline pengiriman

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

1. Buka jendela terminal.

2. Buat direktori baru dan buka direktori tersebut.

   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 definisi target dan pipeline pengiriman:

   GKE

   Di 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:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a predeploy action"' ]
           postdeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a 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

   Di 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:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a predeploy action"' ]
           postdeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a 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.

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, yang siap men-deploy aplikasi dan menjalankan tugas pra-deployment dan pasca-deployment.

5. 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 Anda buat akan ditampilkan, dengan satu target yang tercantum di kolom Targets.

   

Membuat file konfigurasi Skaffold dan manifes aplikasi

Cloud Deploy menggunakan Skaffold untuk mengidentifikasi manifes yang digunakan untuk men-deploy aplikasi contoh ke target Anda.

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

   GKE

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

   Cloud Run

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

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

2. 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 dasar, 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-hooks-run-service
   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.

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 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-hooks-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=deploy-hooks-demo-app-gke-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-hooks-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=deploy-hooks-demo-app-run-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.

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

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

Melihat hasil di Google Cloud konsol

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

Hook pra-deployment dan pasca-deployment yang kami konfigurasi (untuk tujuan contoh) mencetak string ke log Cloud Build. Kita dapat melihat log tersebut untuk mengonfirmasi bahwa hook berfungsi seperti yang diharapkan.

1. Di Google Cloud konsol, 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 Delivery pipelines

2. Klik nama pipeline pengiriman Anda ("deploy-hooks-demo-app-gke-1" atau "deploy-hooks-demo-app-run-1").

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

   

   Rilis Anda tercantum di tab Releases di bagian Delivery pipeline details.

3. Klik tab Rollouts, di bagian Delivery pipeline details.

4. Klik nama peluncuran untuk melihat detail peluncuran.

   

   Predeploy dan Postdeploy tercantum sebagai tugas.

5. Klik Predeploy

   Log eksekusi tugas akan ditampilkan.

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

   

   Perhatikan textPayload. String tersebut adalah yang dikonfigurasi di predeploy-action di pipeline Pengiriman Anda.

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

   

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

   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.

• Pelajari dasar-dasar men-deploy aplikasi.

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