Men-deploy aplikasi ke Cloud Run menggunakan Cloud Deploy

Halaman ini menunjukkan cara menggunakan Cloud Deploy untuk mengirimkan contoh image aplikasi bernama hello ke urutan dua layanan Cloud Run atau dua tugas Cloud Run.

Dalam panduan memulai ini, Anda akan melakukan hal berikut:

  1. Membuat konfigurasi Skaffold

  2. Buat file konfigurasi untuk dua layanan Cloud Run atau dua tugas.

    File ini menentukan layanan atau tugas, dan menentukan image container (bawaan) yang akan di-deploy.

  3. Tentukan pipeline pengiriman Cloud Deploy dan target deployment, yang mengarah ke dua layanan atau dua tugas.

  4. Buat instance pipeline pengiriman dengan membuat rilis, yang otomatis di-deploy ke target pertama.

  5. Promosikan rilis ke target kedua.

  6. Lihat kedua peluncuran 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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

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

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

    Enable the APIs

  5. Install the Google Cloud CLI.
  6. To initialize the gcloud CLI, run the following command:

    gcloud init
  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

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

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

    Enable the APIs

  10. Install the Google Cloud CLI.
  11. To initialize the gcloud CLI, run the following command:

    gcloud init
  12. Jika Anda 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. 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. Berikan izin untuk men-deploy beban kerja ke Cloud Run kepada akun layanan eksekusi default actAs:

      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
      

    3. Tambahkan izin developer 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"
      

      Jika Anda mengalami masalah saat menambahkan salah satu peran ini, hubungi administrator project Anda.

Menyiapkan konfigurasi Skaffold

Cloud Deploy menggunakan Skaffold untuk memberikan detail tentang apa yang akan di-deploy dan cara men-deploynya dengan benar untuk target terpisah Anda.

Untuk memulai cepat ini, Anda akan membuat file skaffold.yaml, yang mengidentifikasi layanan Cloud Run atau definisi tugas yang akan digunakan untuk men-deploy aplikasi contoh.

  1. Buka jendela terminal.

  2. Buat direktori baru, beri nama deploy-run-quickstart, lalu buka direktori tersebut.

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

    Layanan

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

    Pekerjaan

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

    File ini adalah konfigurasi Skaffold minimal, yang mengidentifikasi layanan atau tugas Cloud Run Anda. Lihat referensi skaffold.yaml untuk mengetahui informasi selengkapnya tentang file ini.

Menyiapkan layanan atau tugas Cloud Run

Untuk panduan memulai ini, Anda akan membuat dua layanan Cloud Run yang berbeda atau dua tugas Cloud Run, dalam project yang sama. Cloud Deploy juga mendukung deployment di beberapa project. Selain itu, kita menggunakan profil Skaffold untuk memungkinkan adanya dua layanan atau tugas dalam project yang sama. Saat menggunakan project yang berbeda, Anda mungkin tidak perlu menggunakan profil Skaffold.

Layanan

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

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

    File ini menentukan layanan Cloud Run. Seperti yang tersirat dalam nama deploy-run-service-dev, ini adalah layanan dev Anda, dan sesuai dengan target pertama dalam progres pipeline pengiriman Anda.

  2. Buat file bernama run-service-prod.yaml dengan konten berikut:

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

    File ini menentukan layanan Cloud Run lain, dan seperti yang ditunjukkan oleh nama deploy-run-service-prod, ini adalah layanan prod Anda, dan sesuai dengan target kedua dalam progres pipeline pengiriman Anda.

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.

Pekerjaan

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

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: deploy-run-job-dev
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: my-app-image
    

    File ini menentukan tugas Cloud Run. Seperti yang tersirat dari nama deploy-run-job-dev, ini adalah tugas dev Anda, dan sesuai dengan target pertama dalam progres pipeline pengiriman Anda.

  2. Buat file bernama run-job-prod.yaml dengan konten berikut:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: deploy-run-job-prod
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: my-app-image
    

    File ini menentukan tugas Cloud Run lainnya. Seperti namanya, deploy-run-job-prod, ini adalah tugas prod Anda, dan sesuai dengan target kedua dalam progres pipeline pengiriman.

File ini adalah definisi tugas 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 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. Di direktori deploy-run-quickstart, buat file baru: clouddeploy.yaml, dengan konten berikut:

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: my-run-demo-app-1
    description: main application pipeline
    serialPipeline:
      stages:
      - targetId: run-qsdev
        profiles: [dev]
      - targetId: run-qsprod
        profiles: [prod]
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: run-qsdev
    description: Cloud Run development service
    run:
      location: projects/PROJECT_ID/locations/us-central1
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: run-qsprod
    description: Cloud Run production service
    run:
      location: projects/PROJECT_ID/locations/us-central1
    
  2. 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, dengan target, yang siap men-deploy aplikasi ke target pertama.

  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 Delivery pipelines

    Pipeline pengiriman yang baru saja Anda buat akan ditampilkan, dan dua target tersebut tercantum di kolom Targets.

    Pipeline pengiriman yang ditampilkan di konsol Google Cloud

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.

Jalankan perintah berikut dari direktori deploy-run-quickstart untuk membuat resource release yang mewakili image container yang akan di-deploy:

Layanan

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

Pekerjaan

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/job@sha256:d7c33651fbad911a9a0a0c16f2f9b3a79f0b9e3e89afb205603af706067feac5

Perhatikan flag --images=, yang Anda gunakan untuk mengganti placeholder (my-app-image) di definisi layanan atau tugas dengan gambar 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 pembuatan rilis.

Seperti semua rilis (kecuali jika menyertakan --disable-initial-rollout), Cloud Deploy juga otomatis membuat resource peluncuran. Aplikasi akan otomatis di-deploy ke target pertama dalam progres.

Mempromosikan rilis

  1. Dari halaman Delivery pipeline, klik pipeline my-run-demo-app-1.

    Buka halaman Delivery pipelines

    Halaman detail Pipeline pengiriman menampilkan representasi grafis dari progres pipeline pengiriman Anda. Dalam hal ini, hal ini menunjukkan bahwa rilis telah di-deploy ke target run-qsdev.

    visualisasi pipeline pengiriman di konsol Google Cloud

  2. Pada target pertama dalam visualisasi pipeline pengiriman, klik Promote.

    Dialog Promosikan rilis akan ditampilkan. Halaman ini menampilkan detail target yang Anda promosikan.

  3. Klik Promote.

    Rilis kini diantrekan untuk di-deploy ke run-qsprod. Setelah deployment selesai, visualisasi pipeline pengiriman akan menampilkannya sebagai di-deploy:

    visualisasi pipeline pengiriman di konsol Google Cloud, yang menampilkan rilis yang di-deploy ke produksi.

Melihat hasil di konsol Google Cloud

  1. Di konsol Google Cloud, buka halaman Pipeline pengiriman Cloud Deploy untuk melihat pipeline pengiriman my-run-demo-app-1.

    Buka halaman Delivery pipelines

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

    Visualisasi pipeline menunjukkan progres aplikasi melalui pipeline.

    visualisasi pipeline pengiriman di konsol Google Cloud

    Selain itu, rilis Anda tercantum di tab Rilis pada 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.

    peluncuran di konsol Google Cloud

Mengakses layanan Cloud Run

Secara default, Anda harus diautentikasi untuk mengakses layanan Cloud Run yang baru dibuat. Lihat Ringkasan autentikasi Cloud Run untuk mempelajari cara memberikan kredensial dan mengetahui konfigurasi Identity and Access Management yang diperlukan untuk mengakses layanan tanpa autentikasi. Hal ini tidak berlaku untuk tugas Cloud Run.

Pembersihan

Agar tidak menimbulkan biaya pada akun Google Cloud Anda untuk resource yang digunakan pada halaman ini, ikuti langkah-langkah berikut.

  1. Hapus layanan atau tugas Cloud Run deploy-qs-dev:

    Layanan

    gcloud run services delete deploy-run-service-dev --region=us-central1 --project=PROJECT_ID
    

    Pekerjaan

    gcloud run jobs delete deploy-run-job-dev --region=us-central1 --project=PROJECT_ID
    
  2. Hapus layanan deploy-qs-prod:

    Layanan

    gcloud run services delete deploy-run-service-prod --region=us-central1 --project=PROJECT_ID
    

    Pekerjaan

    gcloud run jobs delete deploy-run-job-prod --region=us-central1 --project=PROJECT_ID
    
  3. Hapus pipeline pengiriman, target, rilis, dan peluncuran:

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
    
  4. 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 quickstart ini.

Langkah selanjutnya