Menggunakan Config Sync dengan Kustomize dan Helm

Dalam tutorial ini, Anda akan menambahkan konfigurasi Kustomize yang mereferensikan chart Helm ke repositori, lalu menggunakan Config Sync untuk menyinkronkan cluster ke repositori.

Istilah Utama: Kustomize adalah alat mandiri, dan fitur dalam alat command line kubectl, untuk menyesuaikan file YAML objek Kubernetes. Config Sync dapat otomatis merender konfigurasi Kustomize yang disimpan dalam sumber kebenaran tidak terstruktur. Untuk mengetahui informasi selengkapnya tentang penggunaan Config Sync dengan Kustomize, lihat Mengonfigurasi Kubernetes dengan Kustomize.

Saat Anda menggunakan Config Sync, konfigurasi Kustomize dan chart Helm yang Anda tempatkan di repositori Git akan otomatis dirender. Rendering otomatis memberikan manfaat berikut:

• Anda tidak lagi memerlukan pipeline hidrasi eksternal. Tanpa rendering otomatis, Anda harus merender konfigurasi secara manual menggunakan Kustomize dan Helm di workstation, atau menyiapkan langkah untuk memicu proses hidrasi di sistem CI. Dengan rendering otomatis, Config Sync menangani eksekusi.

• Biaya pemeliharaan Anda berkurang. Tanpa rendering otomatis, Anda harus memelihara satu repositori Git dengan konfigurasi Kustomize dan chart Helm asli, serta repositori Git lainnya dengan output yang dihasilkan oleh hidrasi eksternal. Kemudian, Anda harus mengonfigurasi Config Sync untuk melakukan sinkronisasi dari repositori Git dengan output yang dirender. Dengan rendering otomatis, Anda hanya perlu memelihara satu repositori dengan konfigurasi asli.

• Alur kerja pengembangan Anda disederhanakan. Tanpa rendering otomatis, perubahan yang dilakukan pada konfigurasi asli Anda harus ditinjau dua kali sebelum digabungkan; sekali di repositori asli dan sekali lagi di repositori yang dirender. Dengan rendering otomatis, konfigurasi yang dirender dihasilkan oleh Config Sync, dan Anda hanya perlu meninjau perubahan pada konfigurasi asli.

Catatan: Config Sync mendukung semua konfigurasi Kustomize native, kecuali plugin Kustomize kustom. Config Sync tidak mendukung pengambilan basis jarak jauh Kustomize dari repositori pribadi. Plugin Kustomize tidak didukung karena masalah keamanan.

Tujuan

• Mengonfigurasi repositori Anda dengan konfigurasi Kustomize yang mereferensikan chart Helm siap pakai untuk cert-manager. cert-manager adalah alat untuk Kubernetes yang membantu Anda mengelola sertifikat.
• Melihat pratinjau dan memvalidasi konfigurasi yang Anda buat.
• Menggunakan Config Sync untuk otomatis merender chart dan menyinkronkan cluster ke repositori.
• Memastikan penginstalan berhasil.

Biaya

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

• Google Kubernetes Engine

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga.

Pengguna baru mungkin memenuhi syarat untuk mendapatkan uji coba gratis. Google Cloud

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

Sebelum memulai

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

   Peran yang diperlukan untuk memilih atau membuat project

   • Memilih project: Memilih project tidak memerlukan peran IAM tertentu Anda dapat memilih project mana pun yang telah diberi peran.
   • Membuat project: Untuk membuat project, Anda memerlukan peran Pembuat Project (roles/resourcemanager.projectCreator), yang berisi izin resourcemanager.projects.create. Pelajari cara memberikan peran.
   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

2. Pastikan penagihan diaktifkan untuk Google Cloud project Anda.

3. Buat, atau pastikan Anda memiliki akses ke, cluster yang memenuhi persyaratan untuk Config Sync dan menggunakan setelan Config Sync berikut:
   • Menggunakan repositori tidak terstruktur.
   • API RootSync dan RepoSync diaktifkan.
   • spec.override.enableShellInRendering ditetapkan ke true agar Config Sync dapat mengambil basis jarak jauh dari repositori publik dalam proses rendering.
4. Daftarkan cluster Anda ke fleet.
5. Instal alat command line nomos. Jika Anda sudah menginstal alat nomos, pastikan Anda mengupgrade-nya ke versi 1.9.0 atau yang lebih baru.
6. Instal Helm.

Sebaiknya Anda juga memiliki pemahaman tentang Git, Kustomize, dan Helm.

Mengonfigurasi repositori

Tugas berikut menunjukkan cara menyiapkan repositori Git dengan konfigurasi yang menggabungkan konfigurasi Kustomize dengan chart Helm:

1. Buat, atau pastikan Anda memiliki akses ke, repositori Git. Karena repositori Anda menggunakan Kustomize dan Helm, repositori ini harus berupa repositori tidak terstruktur.

2. Di root repositori Git Anda, buat file bernama kustomization.yaml dan tempelkan kode berikut ke dalamnya:

   # ./kustomization.yaml
   resources:
   - base
   
   patches:
   - path: ignore-deployment-mutation-patch.yaml
     target:
       kind: Deployment
   

   File ini adalah overlay Kustomize yang mengarah ke basis Kustomize. Overlay ini mencakup patch untuk basis chart Helm yang menambahkan anotasi client.lifecycle.config.k8s.io/mutation: ignore ke semua objek Deployment. Anotasi ini menyebabkan Config Sync mengabaikan perubahan yang bertentangan pada objek ini di cluster setelah Anda membuatnya.

3. Di repositori Git Anda, buat direktori bernama base:

   mkdir base
   

4. Di direktori base, buat file lain bernama kustomization.yaml dan tempelkan kode berikut ke dalamnya:

   # ./base/kustomization.yaml
   helmCharts:
   - name: cert-manager
     repo: https://charts.jetstack.io
     version: v1.5.3
     releaseName: my-cert-manager
     namespace: cert-manager
   

   File ini adalah basis Kustomize, yang merender chart Helm jarak jauh.

5. Kembali ke root repositori Git Anda, buat file bernama ignore-deployment-mutation-patch.yaml dan tempelkan kode berikut ke dalamnya:

   # ./ignore-deployment-mutation-patch.yaml
   apiVersion: apps/v1
   kind: Deployment
   metadata:
    name: any
    annotations:
      client.lifecycle.config.k8s.io/mutation: ignore
   

   File ini adalah patch yang diterapkan ke chart Helm dasar. File ini menambahkan anotasi client.lifecycle.config.k8s.io/mutation: ignore ke semua Deployment di direktori dasar.

6. Lakukan perubahan pada repositori Anda:

   git add .
   git commit -m 'Set up manifests.'
   git push
   

Repositori contoh memiliki contoh tampilan repositori tersebut.

Melihat pratinjau dan memvalidasi konfigurasi yang dirender

Sebelum Config Sync merender konfigurasi dan menyinkronkannya ke cluster, pastikan konfigurasi akurat dengan menjalankan nomos hydrate untuk melihat pratinjau konfigurasi yang dirender dan menjalankan nomos vet untuk memvalidasi bahwa formatnya sudah benar.

1. Jalankan nomos hydrate berikut dengan flag berikut:

   nomos hydrate \
       --source-format=unstructured \
       --output=OUTPUT_DIRECTORY
   

   Dalam perintah ini:

   • --source-format=unstructured memungkinkan nomos hydrate berfungsi di repositori tidak terstruktur. Karena Anda menggunakan konfigurasi Kustomize dan chart Helm, Anda harus menggunakan repositori tidak terstruktur dan menambahkan flag ini.
   • --output=OUTPUT_DIRECTORY memungkinkan Anda menentukan jalur ke konfigurasi yang dirender. Ganti OUTPUT_DIRECTORY dengan lokasi tempat Anda ingin menyimpan output.

2. Periksa sintaksis dan validitas konfigurasi Anda dengan menjalankan nomos vet dengan flag berikut:

   nomos vet \
       --source-format=unstructured \
       --keep-output=true \
       --output=OUTPUT_DIRECTORY
   

   Dalam perintah ini:

   • --source-format=unstructured memungkinkan nomos vet berfungsi di repositori tidak terstruktur.
   • --keep-output=true menyimpan konfigurasi yang dirender.
   • --output=OUTPUT_DIRECTORY adalah jalur ke konfigurasi yang dirender.

Mengonfigurasi sinkronisasi dari repositori Git

Setelah membuat repositori dengan konfigurasi yang ingin Anda gunakan, Anda dapat mengonfigurasi sinkronisasi dari cluster ke repositori.

1. Untuk mengonfigurasi objek RootSync, buat file root-sync.yaml:

   # root-sync.yaml
   apiVersion: configsync.gke.io/v1beta1
   kind: RootSync
   metadata:
     name: root-sync
     namespace: config-management-system
   spec:
     sourceFormat: unstructured
     git:
       repo: YOUR_GIT_REPOSITORY
       branch: main
       auth: none
     override:
       enableShellInRendering: true
   

   Ganti YOUR_GIT_REPOSITORY dengan URL repositori Git Anda.

2. Terapkan file root-sync.yaml ke cluster Anda:

   kubectl apply -f root-sync.yaml
   

Memverifikasi penginstalan

Setelah menginstal dan mengonfigurasi Config Sync, Anda dapat memverifikasi bahwa penginstalan berhasil diselesaikan.

1. Pastikan tidak ada error lain dengan menggunakan nomos status:

   nomos status
   

   Contoh output:

   *CLUSTER_NAME
   --------------------
   <root>   https:/github.com/GoogleCloudPlatform/anthos-config-management-samples.git/helm-component/manifests@init
   SYNCED   fd17dd5a
   

2. Verifikasi apakah komponen Helm berhasil diinstal:

   kubectl get all -n cert-manager
   

   Contoh output:

   NAME                                              READY   STATUS    RESTARTS   AGE
   pod/my-cert-manager-54f5ccf74-wfzs4               1/1     Running   0          10m
   pod/my-cert-manager-cainjector-574bc8678c-rh7mq   1/1     Running   0          10m
   pod/my-cert-manager-webhook-7454f4c77d-rkct8      1/1     Running   0          10m
   
   NAME                              TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)    AGE
   service/my-cert-manager           ClusterIP   10.76.9.35     <none>        9402/TCP   10m
   service/my-cert-manager-webhook   ClusterIP   10.76.11.205   <none>        443/TCP    10m
   
   NAME                                         READY   UP-TO-DATE   AVAILABLE   AGE
   deployment.apps/my-cert-manager              1/1     1            1           10m
   deployment.apps/my-cert-manager-cainjector   1/1     1            1           10m
   deployment.apps/my-cert-manager-webhook      1/1     1            1           10m
   
   NAME                                                    DESIRED   CURRENT   READY   AGE
   replicaset.apps/my-cert-manager-54f5ccf74               1         1         1       10m
   replicaset.apps/my-cert-manager-cainjector-574bc8678c   1         1         1       10m
   replicaset.apps/my-cert-manager-webhook-7454f4c77d      1         1         1       10m
   

Pembersihan

Agar tidak perlu membayar biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, hapus project yang berisi resource tersebut, atau simpan project dan hapus setiap resource.

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 beberapa arsitektur, tutorial atau panduan memulai, dengan menggunakan kembali project dapat membantu Anda agar tidak melampaui batas kuota project.

1. Di Google Cloud konsol, buka halaman Manage resources.

   Buka Kelola resource

2. Pada daftar project, pilih project yang Anda ingin Anda hapus, lalu klik Delete.
3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus project.

Menghapus resource satu per satu

Menghapus manifes di repositori

Untuk membantu mencegah penghapusan yang tidak disengaja, Config Sync tidak mengizinkan Anda menghapus semua namespace atau resource cakupan cluster dalam satu commit. Ikuti petunjuk ini untuk meng-uninstal komponen dengan benar dan menghapus namespace dalam commit terpisah:

1. Hapus komponen cert-manager dari repositori Anda:

   git rm -rf manifests/cert-manager \
       && git commit -m "uninstall cert-manager" \
       && git push origin BRANCH
   

   Ganti BRANCH dengan cabang tempat Anda membuat repositori.

2. Hapus namespace cert-manager:

   git rm manifests/namespace-cert-manager.yaml \
       && git commit -m "remove the cert-manager namespace" \
       && git push origin BRANCH
   

3. Pastikan namespace cert-manager tidak ada:

   kubectl get namespace cert-namespace
   

   Contoh output:

   Error from server (NotFound): namespaces "cert-namespace" not found
   

Menghapus cluster

Untuk menghapus cluster, selesaikan perintah berikut:

Konsol

Untuk menghapus cluster menggunakan Google Cloud konsol, selesaikan tugas berikut:

1. Di Google Cloud konsol, buka halaman GKE.

   Buka GKE

2. Di samping cluster yang ingin Anda hapus, klik Actions, lalu klik Delete.

3. Saat diminta untuk mengonfirmasi, klik Delete lagi.

gcloud

Untuk menghapus cluster menggunakan Google Cloud CLI, jalankan perintah berikut:

gcloud container clusters delete CLUSTER_NAME

Untuk mengetahui informasi selengkapnya, lihat gcloud container clusters delete dokumentasi.

Langkah berikutnya

• Pelajari lebih lanjut cara menggunakan repositori tidak terstruktur.