Men-deploy aplikasi ke Cloud Run menggunakan Cloud Deploy

Halaman ini menunjukkan cara menggunakan Cloud Deploy untuk mengirimkan image aplikasi contoh 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 dan target deployment Cloud Deploy, 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

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

    Go to project selector

  • Jika Anda menggunakan project yang sudah ada untuk panduan ini, pastikan Anda memiliki izin yang diperlukan untuk menyelesaikan panduan ini. Jika berhasil membuat project baru, berarti Anda sudah memiliki izin yang diperlukan.

  • Verify that billing is enabled for your Google Cloud project.

  • Enable the Cloud Deploy, Cloud Build, 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

  • Install the 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
  • 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.

    Go to project selector

  • Jika Anda menggunakan project yang sudah ada untuk panduan ini, pastikan Anda memiliki izin yang diperlukan untuk menyelesaikan panduan ini. Jika berhasil membuat project baru, berarti Anda sudah memiliki izin yang diperlukan.

  • Verify that billing is enabled for your Google Cloud project.

  • Enable the Cloud Deploy, Cloud Build, 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

  • Install the 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
  • Peran yang diperlukan

    Untuk mendapatkan izin yang diperlukan guna membuat pipeline pengiriman dan rilis Cloud Deploy, minta administrator untuk memberi Anda peran IAM Cloud Deploy Job Runner (roles/clouddeploy.jobrunner) di project Anda.

    Untuk memastikan bahwa akun layanan Cloud Deploy memiliki izin yang diperlukan untuk menjalankan operasi Cloud Deploy dan men-deploy ke Cloud Run, minta administrator untuk memberikan peran IAM berikut kepada akun layanan Cloud Deploy di project Anda:

    Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

    Administrator Anda mungkin juga dapat memberikan izin yang diperlukan kepada akun layanan Cloud Deploy melalui peran khusus atau peran bawaan lainnya.

    Menyiapkan konfigurasi Skaffold

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

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

    1. Buka jendela terminal.

    2. Buat direktori baru, bernama 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 atau dua tugas Cloud Run yang berbeda, dalam project yang sama. Cloud Deploy juga mendukung deployment di beberapa project. Selain itu, kita menggunakan profil Skaffold untuk memungkinkan dua layanan atau tugas dalam project yang sama. Jika 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 penayangan 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 lainnya, dan seperti yang tersirat dari 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, 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 dalam namanya, deploy-run-job-dev adalah tugas dev Anda, dan sesuai dengan target pertama dalam progres pipeline penayangan 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 yang tersirat dalam nama deploy-run-job-prod, ini adalah tugas prod Anda, dan sesuai dengan target kedua dalam progres pipeline pengiriman Anda.

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

    3. Konfirmasi pipeline dan target Anda:

      Di konsol Google Cloud , 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, dan kedua target akan dicantumkan di kolom Targets.

      Pipeline pengiriman ditampilkan di konsol Google Cloud

    Membuat rilis

    Rilis adalah resource Cloud Deploy pusat yang merepresentasikan 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 merepresentasikan 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:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a
    

    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:8eb3f5e72586de6375abe95aa67511c57c61d35fb37d5670e4d68624a68ef916
    

    Perhatikan flag --images=, yang Anda gunakan untuk mengganti placeholder (my-app-image) dalam definisi layanan atau tugas dengan gambar spesifik 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 rollout. Aplikasi akan otomatis di-deploy ke target pertama dalam progres.

    Mempromosikan rilis

    1. Dari halaman Delivery pipelines, 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, terlihat bahwa rilis di-deploy ke target run-qsdev.

      visualisasi pipeline pengiriman di konsol Google Cloud

    2. Pada target pertama dalam visualisasi pipeline penayangan, klik Promosikan.

      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 menunjukkannya 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 Cloud Deploy Delivery pipelines untuk melihat pipeline pengiriman my-run-demo-app-1.

      Buka halaman Delivery pipelines

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

      Visualisasi pipeline menunjukkan progres aplikasi melalui pipeline.

      visualisasi pipeline penayangan di konsol Google Cloud

      Rilis Anda akan tercantum di tab Rilis di 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 akun Google Cloud Anda tidak dikenai biaya 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.

      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 berikutnya