Memvalidasi konfigurasi

Tutorial ini menunjukkan cara memvalidasi konfigurasi dengan Cloud Build saat menggunakan cluster edisi Google Kubernetes Engine (GKE) Enterprise. Penyiapan yang sama berfungsi di sistem CI/CD berbasis container lainnya, seperti CircleCI, dengan sedikit perubahan.

Sebaiknya validasi juga setiap perubahan konfigurasi di pipeline CI/CD selain memeriksa validitas konfigurasi Anda dengan menjalankan perintah nomos vet.

Tujuan

• Buat file konfigurasi Cloud Build yang menginstruksikan Config Sync untuk menggunakan nomos vet pada konfigurasi di repositori Anda.
• Buat pemicu Cloud Build agar konfigurasi Anda diperiksa setiap kali ada perubahan pada cabang pengembangan.

Biaya

Dalam dokumen ini, Anda menggunakan komponen Google Cloud yang dapat ditagih berikut:

• Sinkronisasi Konfigurasi (bagian dari GKE Enterprise)
• Cloud Build

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga. Pengguna baru Google Cloud mungkin memenuhi syarat untuk mendapatkan uji coba gratis.

Setelah menyelesaikan tugas yang dijelaskan dalam dokumen ini, Anda dapat menghindari penagihan berkelanjutan dengan menghapus resource yang Anda buat. Untuk mengetahui informasi selengkapnya, lihat Pembersihan.

Sebelum memulai

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

2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

3. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

4. Enable the Cloud Build API.

   Enable the API

5. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

6. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

7. Enable the Cloud Build API.

   Enable the API

8. Membuat atau memiliki akses ke cluster GKE Enterprise yang memenuhi persyaratan untuk Config Sync. Untuk mengetahui detail tentang cara membuat cluster tersebut, lihat Memulai Config Sync.

Memberikan izin akun layanan Cloud Build

Beri akun layanan Cloud Build izin untuk mengakses cluster GKE Enterprise Anda.

gcloud

Untuk menambahkan peran Kubernetes Engine Developer ke akun layanan Cloud Build, jalankan perintah berikut:

PROJECT_ID=$(gcloud config get-value project)
PROJECT_NUM=$(gcloud projects list --filter="$PROJECT_ID" --format="value(PROJECT_NUMBER)")
gcloud projects add-iam-policy-binding $PROJECT_ID \
    --member=serviceAccount:$[e-mail] \
    --role=roles/container.developer

Konsol

1. Buka halaman IAM di Konsol Google Cloud.

   Buka halaman IAM

2. Di kolom anggota, temukan baris yang berisi akun layanan Cloud Build:

   [e-mail]
   

3. Di baris tersebut, klik Edit utama.

4. Klik Add another role.

5. Di daftar Pilih peran, pilih Kubernetes Engine Developer, lalu klik Simpan.

Membuat konfigurasi Cloud Build

Buat file konfigurasi Cloud Build dan simpan di direktori utama repositori yang berisi file konfigurasi Anda (misalnya, my-repo/cloudbuild.yaml).

steps:
- name: 'gcr.io/cloud-builders/kubectl'
  args: ['config', 'current-context']
  volumes:
  - name: 'kube'
    path: '/kube'
  env:
  - 'KUBECONFIG=/kube/config'
  - 'CLOUDSDK_COMPUTE_ZONE=ZONE'
  - 'CLOUDSDK_CONTAINER_CLUSTER=CLUSTER_NAME'
  - 'CLOUDSDK_CONTAINER_USE_APPLICATION_DEFAULT_CREDENTIALS=true'
- name: 'bash'
  args: ['chmod', '444', '/kube/config']
  volumes:
  - name: 'kube'
    path: '/kube'
- name: 'gcr.io/config-management-release/nomos:stable'
  args: ['nomos', 'vet', '--path', '/workspace/POLICY_DIR']
  volumes:
  - name: 'kube'
    path: '/kube'
  env:
  - 'KUBECONFIG=/kube/config'
  timeout: 30s

Ganti kode berikut:

• ZONE: zona tempat cluster Anda berjalan
• CLUSTER_NAME: nama cluster Anda
• POLICY_DIR: jalur dalam repositori Git yang mewakili tingkat teratas repositori yang akan disinkronkan

Ada tiga langkah dalam konfigurasi ini:

1. Jalankan kubectl config current-context untuk membuat file kubeconfig yang diperlukan untuk melakukan autentikasi ke cluster GKE my-cluster. Pengguna root membuat file ini dengan izin terbatas.
2. Jalankan chmod 444 /kube/config agar file ini dapat dibaca di langkah berikutnya.
3. Jalankan nomos vet di repositori Git yang di-clone secara otomatis di /workspace. Jika Anda menggunakan repo tidak terstruktur, jalankan nomos vet --source-format=unstructured sebagai gantinya.

Membuat pemicu build

Contoh berikut membuat pemicu yang berjalan untuk setiap commit ke cabang master repositori Cloud Source Repositories.

1. Buka halaman Pemicu di Konsol Google Cloud.

   Buka halaman pemicu

2. Klik Connect repository.

3. Pilih GitHub (dicerminkan), lalu klik Continue.

4. Pilih repositori Anda, lalu klik Connect repository.

5. Klik Tambahkan pemicu.

6. Masukkan atau pilih entri yang sesuai di setiap kolom yang dijelaskan dalam tabel berikut:

   Kolom	Entri
   Acara	Kirim ke cabang
   Branch	^master$
   Konfigurasi	File konfigurasi Cloud Build (yaml atau json)
   Lokasi file konfigurasi Build Cloud	{i>/cloudbuild.yaml<i}

7. Klik Buat untuk menyimpan pemicu build Anda.

Menguji pemicu build

Uji penyiapan secara manual dengan menjalankan pemicu:

1. Buka halaman Pemicu di Konsol Google Cloud.

   Buka halaman pemicu

2. Temukan pemicu yang Anda buat, lalu klik Jalankan pemicu.

   Pesan "Build started on master branch" akan muncul.

3. Klik Tampilkan.

   Langkah Cloud Build muncul berwarna hijau jika disiapkan dengan benar.

Konfigurasi Cloud Build tidak valid

Pemicu tidak dapat dijalankan jika file konfigurasi Cloud Build tidak valid.

Untuk mengujinya, perbarui konfigurasi Cloud Build di repositori Anda dengan file berikut. Perhatikan indentasi yang tidak valid di baris 6:

steps:
- name: 'gcr.io/cloud-builders/kubectl'
  args: ['config', 'current-context']
  volumes:
  - name: 'kube'
  path: '/kube'
  env:
  - 'KUBECONFIG=/kube/config'
  - 'CLOUDSDK_COMPUTE_ZONE=ZONE'
  - 'CLOUDSDK_CONTAINER_CLUSTER=CLUSTER_NAME'
  - 'CLOUDSDK_CONTAINER_USE_APPLICATION_DEFAULT_CREDENTIALS=true'
- name: 'bash'
  args: ['chmod', '444', '/kube/config']
  volumes:
  - name: 'kube'
    path: '/kube'
- name: 'gcr.io/nomos-release/nomos:stable'
  args: ['nomos', 'vet', '--path', '/workspace/POLICY_DIR']
  volumes:
  - name: 'kube'
    path: '/kube'
  env:
  - 'KUBECONFIG=/kube/config'
  timeout: 30s

Jika menjalankan pemicu lagi secara manual, Anda akan menerima pesan error berikut karena path: di baris 6 tidak diindentasi dengan benar:

Failed to trigger build: failed unmarshalling build config cloudbuild.yaml:
unknown field "path" in cloudbuild_go_proto.BuildStep.

Untuk memperbaiki konfigurasi ini, indentasi path: di baris 6 ke tingkat yang sama dengan name: di baris 5. Untuk mengetahui informasi selengkapnya tentang struktur file konfigurasi Cloud Build, lihat Membuat konfigurasi Cloud Build dasar.

Pembersihan

Menghapus project

Perhatian: Menghapus project memiliki efek berikut:

• Semua hal dalam project akan dihapus. Jika menggunakan project yang sudah ada untuk tugas dalam dokumen ini, saat Anda menghapusnya, pekerjaan lain yang telah Anda lakukan dalam project tersebut juga akan terhapus.
• Project ID kustom hilang. Saat membuat project ini, Anda mungkin telah membuat project ID kustom yang ingin digunakan di masa mendatang. Untuk mempertahankan URL yang menggunakan project ID, seperti URL appspot.com, hapus resource yang dipilih di dalam project, bukan menghapus seluruh project.

Jika Anda berencana mempelajari berbagai arsitektur, tutorial, atau panduan memulai, menggunakan kembali project dapat membantu agar Anda tidak melampaui batas kuota project.

Menghapus project Google Cloud:

gcloud projects delete PROJECT_ID

Menghapus resource satu per satu

Untuk menghapus resource satu per satu, selesaikan langkah-langkah berikut:

1. Menghapus file konfigurasi Cloud Build.
2. Hapus pemicu Cloud Build yang Anda buat.
3. Hapus cluster yang Anda gunakan untuk tutorial ini.

Langkah selanjutnya

• Pelajari Cloud Build
• Menghentikan sinkronisasi konfigurasi untuk sementara