Men-deploy alur kerja dari repositori Git menggunakan Cloud Build

Anda dapat menggunakan pemicu Cloud Build untuk otomatis memulai build dan men-deploy alur kerja dari repositori Git. Anda dapat mengonfigurasi pemicu untuk men-deploy alur kerja Anda berdasarkan setiap perubahan pada repositori sumber, atau men-deploy alur kerja hanya jika perubahan tersebut cocok dengan kriteria tertentu.

Pendekatan ini dapat membantu Anda mengelola siklus proses deployment. Misalnya, Anda dapat men-deploy perubahan ke alur kerja di lingkungan staging, menjalankan pengujian terhadap lingkungan tersebut, lalu secara bertahap meluncurkan perubahan ini ke lingkungan produksi.

Sebelum memulai

Petunjuk ini mengasumsikan bahwa Anda memiliki peran Cloud Build Editor (roles/cloudbuild.builds.editor) di Google Cloud project Anda sehingga Anda dapat membuat pemicu. Anda juga memerlukan alur kerja di repositori sumber seperti GitHub atau Bitbucket.

Konsol

1. Aktifkan Cloud Build dan Workflows API.

   Aktifkan API

2. Berikan peran Workflows Admin (roles/workflows.admin) ke akun layanan Cloud Build:

   1. Di Google Cloud konsol, buka halaman IAM.

      Buka IAM

   2. Pilih project Anda.

   3. Di baris untuk akun layanan Cloud Build ([e-mail]), klik Edit principal.

   4. Klik Add another role.

   5. Di daftar Role, pilih peran Workflows Admin.

   6. Klik Save.

3. Berikan peran Service Account User (roles/iam.serviceAccountUser) di akun layanan default Compute Engine ke akun layanan Cloud Build. Jika Anda telah mengaktifkan Compute Engine API, akun layanan default Compute Engine adalah [e-mail].

   Perhatian: Menetapkan peran Service Account User secara tidak langsung memberikan peran yang terkait dengan akun layanan default kepada pengguna. Misalnya, jika akun layanan default memiliki peran Editor, pengguna kemudian dapat "bertindak sebagai" Editor. Untuk meminimalkan dampak penetapan peran ini, sebaiknya konfigurasi akun layanan default sesuai dengan prinsip hak istimewa terendah. Untuk mengetahui informasi selengkapnya, lihat Menonaktifkan pemberian peran otomatis ke akun layanan default.

   1. Di Google Cloud konsol, buka halaman Service Accounts.

      Buka Akun Layanan

   2. Pilih project Anda.

   3. Klik alamat email akun layanan default Compute Engine ([e-mail]).

   4. Klik tab Permissions.

   5. Klik tombol Grant access.

   6. Untuk menambahkan principal baru, masukkan alamat email akun layanan Anda (SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com).

   7. Di daftar Select a role, pilih peran Service Accounts > Service Account User.

   8. Klik Save.

gcloud

1. Aktifkan Cloud Build dan Workflows API.

   gcloud services enable cloudbuild.googleapis.com \
     workflows.googleapis.com
   

2. Berikan peran Workflows Admin (roles/workflows.admin) ke akun layanan Cloud Build:

   PROJECT_NUMBER=$(gcloud projects describe PROJECT_ID --format='value(projectNumber)')
   gcloud projects add-iam-policy-binding PROJECT_ID \
     --member=serviceAccount:$[e-mail] \
     --role=roles/workflows.admin
   

   Ganti PROJECT_ID dengan ID project Anda. Google Cloud

3. Berikan peran Service Account User (roles/iam.serviceAccountUser) di akun layanan default Compute Engine ke akun layanan Cloud Build. Jika Anda telah mengaktifkan Compute Engine API, akun layanan default Compute Engine adalah [e-mail].

   Perhatian: Menetapkan peran Service Account User secara tidak langsung memberikan peran yang terkait dengan akun layanan default kepada pengguna. Misalnya, jika akun layanan default memiliki peran Editor, pengguna kemudian dapat "bertindak sebagai" Editor. Untuk meminimalkan dampak penetapan peran ini, sebaiknya konfigurasi akun layanan default sesuai dengan prinsip hak istimewa terendah. Untuk mengetahui informasi selengkapnya, lihat Menonaktifkan pemberian peran otomatis ke akun layanan default.

   gcloud iam service-accounts add-iam-policy-binding \
     $[e-mail] \
     --member=serviceAccount:$[e-mail] \
     --role=roles/iam.serviceAccountUser
   

Menghubungkan ke repositori sumber

Anda harus menghubungkan Cloud Build ke repositori sumber agar Cloud Build dapat mengotomatiskan build sebagai respons terhadap peristiwa yang terjadi di repositori.

Selesaikan langkah-langkah berikut untuk terhubung ke GitHub atau Bitbucket:

1. Di Google Cloud konsol, buka halaman Triggers Cloud Build:

   Buka Pemicu

2. Jika perlu, pilih project Anda, lalu klik Open.

3. Dari daftar Region, pilih region tempat Anda ingin membuat pemicu.

   Catatan: Jika Anda memilih global sebagai region, pool default akan digunakan untuk menjalankan build Anda; jika tidak, pool pribadi di region pemicu Anda akan digunakan. Anda harus menentukan pool pribadi di file konfigurasi build atau melalui argumen build.

4. Klik Connect repository.

5. Pilih repositori sumber tempat Anda menyimpan kode sumber.

   Misalnya: GitHub (Cloud Build GitHub App)

6. Klik Continue.

7. Lakukan autentikasi ke repositori sumber Anda dengan nama pengguna dan sandi Anda.

   Jika Anda login ke GitHub, Anda akan diminta untuk memberi otorisasi ke Aplikasi Google Cloud Build GitHub agar dapat mengakses akun GitHub Anda untuk melanjutkan.

8. Dari daftar repositori yang tersedia, pilih repositori yang diinginkan, lalu klik OK.

   Untuk repositori eksternal seperti GitHub dan Bitbucket, Anda harus memiliki izin tingkat pemilik untuk Google Cloud project tempat Anda bekerja.

9. Baca pernyataan penafian dan pilih kotak centang di sampingnya untuk menunjukkan bahwa Anda menyetujui persyaratan tersebut.

10. Klik Connect.

11. Untuk melanjutkan pembuatan pemicu build guna mengotomatiskan build untuk kode sumber di repositori, klik Create a trigger. Jika tidak, klik Done.

Membuat file konfigurasi Cloud Build

File konfigurasi build menentukan kolom yang diperlukan saat menggunakan pemicu build untuk memulai build. Buat file konfigurasi di direktori root project Anda dan tulis menggunakan YAML atau JSON.

Misalnya, file konfigurasi berikut men-deploy dan menjalankan alur kerja pengujian, lalu menggunakan skrip untuk memeriksa output. Jika pengujian lulus, alur kerja akan di-deploy:

steps:
# Deploy the test workflow with the commit sha
- id: 'deploy-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  args: ['workflows', 'deploy', '$_WORKFLOW_NAME-$BRANCH_NAME-$SHORT_SHA', '--source', 'gitops/workflow.yaml']

# Run the test workflow and capture the output
- id: 'run-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  entrypoint: 'bash'
  args: ['-c', 'gcloud workflows run $_WORKFLOW_NAME-$BRANCH_NAME-$SHORT_SHA > /workspace/testoutput.log']

# Delete the test workflow
- id: 'delete-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  args: ['workflows', 'delete', '$_WORKFLOW_NAME-$BRANCH_NAME-$SHORT_SHA', '--quiet']

# Check the test output
- id: 'check-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  entrypoint: 'bash'
  args: ['gitops/test-$BRANCH_NAME.sh']

# Deploy the workflow
- id: 'deploy-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  args: ['workflows', 'deploy', '$_WORKFLOW_NAME-$BRANCH_NAME', '--source', 'gitops/workflow.yaml']

Variabel substitusi $BRANCH_NAME dan $SHORT_SHA diisi oleh Cloud Build saat build dipicu dari repositori Git. Variabel tersebut masing-masing mewakili nama cabang Anda, dan tujuh karakter pertama ID commit yang terkait dengan build Anda.

Variabel substitusi $_WORKFLOW_NAME memungkinkan Anda menggunakan kembali file konfigurasi dengan nilai variabel yang berbeda. Anda dapat menentukan nilainya saat membuat pemicu build.

Untuk mengetahui informasi selengkapnya, lihat Membuat file konfigurasi build.

Membuat pemicu build

Anda dapat mengotomatiskan deployment alur kerja dengan membuat pemicu Cloud Build.

Untuk membuat pemicu build untuk file konfigurasi di bagian sebelumnya:

1. Di Google Cloud konsol, buka halaman Cloud Build Triggers:

   Buka Pemicu

2. Klik Create trigger.

3. Di kolom Name, masukkan nama pemicu Anda.

4. Untuk Event, pilih peristiwa untuk memanggil pemicu Anda.

   Misalnya: Push to a branch

5. Untuk Source, pilih repositori Anda, dan nama cabang atau tag yang akan memulai pemicu Anda. Anda dapat menggunakan ekspresi reguler untuk menentukan kecocokan dengan cabang atau tag.

   Misalnya: GoogleCloudPlatform/workflows-demos (repositori) dan ^main$|^staging$ (cocok dengan cabang main dan staging)

6. Luaskan bagian Show included and ignored files filters dan tentukan alur kerja Anda sebagai file yang disertakan sehingga saat diubah, build akan dipanggil.

   Misalnya: gitops/workflow.yaml

7. Untuk Configuration, pilih Cloud Build configuration file (YAML or JSON) sebagai jenisnya, dan Repository sebagai lokasinya.

8. Di kolom Cloud Build configuration file location , tentukan lokasi file Anda.

   Misalnya: gitops/cloudbuild.yaml

9. Secara opsional, untuk menambahkan variabel substitusi, klik Add variable dan tentukan kombinasi kunci dan nilai.

   Misalnya: _WORKFLOW_NAME (variabel) dan workflows-gitops (nilai)

10. Untuk menyimpan pemicu build Anda, klik Create.

Saat ada perubahan yang dikirim ke alur kerja di cabang repositori Git yang ditentukan, Cloud Build akan otomatis dipicu untuk men-deploy alur kerja.

Untuk mengetahui informasi selengkapnya, lihat Membuat dan mengelola pemicu build.

Menguji pemicu build

Anda dapat menguji pemicu build dan file konfigurasi dari bagian sebelumnya.

1. Di cabang staging repositori Git, edit workflow.yaml, dan ubah Hello World menjadi Bye World:

   main:
     steps:
       - init:
           assign:
             - message: "Hello World"
       - returnResult:
           return: ${message}

2. Commit dan kirim perubahan ke cabang staging.

   git add workflow.yaml
   git commit -m "Update workflow.yaml in staging"
   git push
   

   Pemicu Cloud Build berjalan dan memulai build.

3. Untuk mengonfirmasi keberhasilan build, di Google Cloud konsol, buka halaman Build history:

   Buka Histori build

   Setelah build selesai, Cloud Build akan memberikan status keseluruhan untuk build dan untuk setiap langkah build. Untuk mengetahui informasi selengkapnya, lihat Melihat hasil build.

4. Untuk mengonfirmasi bahwa alur kerja staging telah di-deploy, di Google Cloud konsol, buka halaman Workflows:

   Buka Workflows

   Anda akan melihat alur kerja bernama workflows-gitops-staging tercantum.

5. Untuk men-deploy alur kerja staging ke produksi, gabungkan cabang staging ke cabang main:

   git checkout main
   git merge staging
   git push
   

   Perhatikan bahwa karena test-main.sh mengharapkan Hello World dalam output alur kerja, build akan gagal:

   RESULT_EXPECTED="result: '\"Hello World\"'"
   RESULT_ACTUAL=$(grep "result: " $FILE)
   if [[ $RESULT_EXPECTED == $RESULT_ACTUAL ]]; then
     echo "Result test passed"
   else
     echo "Result test failed. Expected: $RESULT_EXPECTED Actual: $RESULT_ACTUAL"; exit 1;
   fi

6. Untuk berhasil men-deploy alur kerja produksi, di cabang staging, edit workflow.yaml lagi dan ubah string kembali ke Hello World.

7. Commit dan kirim perubahan ke cabang staging, lalu gabungkan cabang staging ke cabang main.

8. Untuk mengonfirmasi bahwa alur kerja produksi telah di-deploy, di Google Cloud konsol, buka halaman Workflows:

   Buka Workflows

   Anda akan melihat alur kerja bernama workflows-gitops-main tercantum.

Langkah berikutnya

• Pelajari Cloud Build lebih lanjut.
• Pelajari cara memecahkan masalah error build.
• Pelajari cara memecahkan masalah Workflows.