Memverifikasi aplikasi Anda setelah men-deploy-nya

Panduan memulai ini menunjukkan cara menggunakan Cloud Deploy untuk memverifikasi aplikasi yang di-deploy, sebagai bagian dari pipeline pengiriman.

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

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

    Anda juga dapat men-deploy verifikasi di 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.

    File konfigurasi Skaffold adalah tempat Anda mengonfigurasi container verifikasi deploy yang akan dijalankan setelah melakukan deployment.

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

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

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

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

    Setelah aplikasi di-deploy, verifikasi dijalankan sebagai fase peluncuran.

  5. Lihat hasil verifikasi di log Cloud Build, menggunakan halaman detail Peluncuran Cloud Deploy 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.

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

    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
  12. Jika sudah menginstal CLI, pastikan Anda menjalankan versi terbaru:

    gcloud components update
    

  13. 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)")-compute@developer.gserviceaccount.com \
          --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)")-compute@developer.gserviceaccount.com \
            --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)")-compute@developer.gserviceaccount.com \
            --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)")-compute@developer.gserviceaccount.com \
          --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
          --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-verification-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-verification-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 akan membuat file skaffold.yaml, yang mengidentifikasi manifes yang akan digunakan untuk men-deploy aplikasi contoh, dan juga mengidentifikasi penampung yang akan dijalankan setelah deployment (verifikasi deploy).

  1. Buka jendela terminal.

  2. Buat direktori baru dan navigasikan ke dalamnya.

    GKE

    mkdir deploy-verification-gke-quickstart
    cd deploy-verification-gke-quickstart
    

    Cloud Run

    mkdir deploy-verification-run-quickstart
    cd deploy-verification-run-quickstart
    
  3. Buat file bernama skaffold.yaml dengan konten berikut:

    GKE

    apiVersion: skaffold/v4beta7
    kind: Config
    manifests:
      rawYaml:
      - k8s-pod.yaml
    deploy:
      kubectl: {}
    verify:
    - name: verification-test
      container:
        name: verification-echo
        image: ubuntu
        command: ["/bin/sh"]
        args: ["-c", 'echo "Your test or tests would go here."' ]
    

    Cloud Run

    apiVersion: skaffold/v4beta7
    kind: Config
    manifests:
      rawYaml:
      - service.yaml
    deploy:
      cloudrun: {}
    verify:
    - name: verification-test
      container:
        name: verification-echo
        image: ubuntu
        command: ["/bin/sh"]
        args: ["-c", 'echo "Your test or tests would go here."' ]
    

    File ini mencakup stanza verify:, yang menentukan container dan perintah yang akan dijalankan setelah men-deploy aplikasi. Dalam hal ini, kita men-deploy container Ubuntu dan menjalankan perintah echo sederhana. Anda dapat melihat hasil perintah ini di log. Dalam skenario yang lebih realistis, Anda akan menjalankan pengujian terhadap aplikasi yang di-deploy.

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

Membuat target dan pipeline pengiriman Anda

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-verification-gke-quickstart, buat file baru: clouddeploy.yaml, dengan konten berikut:

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

    Cloud Run

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

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: deploy-verification-demo-app-run-1
    description: main application pipeline
    serialPipeline:
      stages:
      - targetId: verify-staging
        profiles: []
        strategy:
          standard:
            verify: true
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: verify-staging
    description: staging Run service
    run:
      location: projects/PROJECT_ID/locations/us-central1
    
  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, siap men-deploy aplikasi dan memverifikasi deployment tersebut.

  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.

    halaman pipeline pengiriman di Konsol Google Cloud, yang menampilkan pipeline Anda

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

Cloud Run

Jalankan perintah berikut dari direktori deploy-verification-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-verification-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.

Tugas verifikasi yang kita tentukan dalam konfigurasi Skaffold berjalan sebagai bagian dari peluncuran ini, setelah aplikasi di-deploy.

Lihat hasil di Konsol Google Cloud

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

Tugas verifikasi yang kami konfigurasi (misalnya tujuan) mencetak string ke log Cloud Build. Kita dapat melihat log tersebut untuk mengonfirmasi bahwa verifikasi bekerja seperti yang diharapkan.

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

    Buka halaman Pipeline pengiriman

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

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

    Visualisasi pipeline pengiriman yang menunjukkan keberhasilan

    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.

    peluncuran di konsol Google Cloud

    Verifikasi tercantum sebagai tugas.

  5. Klik Verifikasi

    Log pengoperasian tugas akan ditampilkan.

  6. Scroll ke bawah dalam daftar entri log untuk menemukan verification-test, lalu klik.

    Entri log yang menunjukkan output dari tugas Verifikasi

    Perhatikan textPayload. String tersebut adalah yang telah dikonfigurasi dalam stanza Verify dalam konfigurasi Skaffold Anda.

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

    Cloud Run

    gcloud run services delete my-verification-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