Menggunakan Config Sync dengan Kustomize dan Helm


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

Saat Anda menggunakan Config Sync, konfigurasi Kustomize dan diagram Helm yang Anda tempatkan di repositori Git akan dirender secara otomatis. Rendering otomatis memberi Anda 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 asli dan diagram Helm serta repositori Git lain dengan output yang dihasilkan oleh proses hidrasi eksternal. Kemudian, Anda harus mengonfigurasi Config Sync untuk menyinkronkan dari repositori Git dengan output yang dirender. Dengan rendering otomatis, Anda hanya perlu mengelola satu repositori dengan konfigurasi asli.

  • Alur kerja pengembangan Anda disederhanakan. Tanpa rendering otomatis, perubahan yang dilakukan pada konfigurasi asli Anda perlu 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.

Tujuan

  • Konfigurasikan 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.
  • Lihat pratinjau dan validasi konfigurasi yang Anda buat.
  • Gunakan Config Sync untuk merender diagram secara otomatis dan menyinkronkan cluster ke repositori.
  • Pastikan penginstalan Anda berhasil.

Biaya

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

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

    Go to project selector

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

  3. Buat, atau pastikan Anda memiliki akses ke, cluster yang memenuhi persyaratan untuk Config Sync dan menggunakan setelan Config Sync berikut:
  4. Daftarkan cluster Anda ke fleet.
  5. Instal alat command line nomos. Jika Anda sudah menginstal alat nomos, pastikan Anda mengupgradenya ke versi 1.9.0 atau yang lebih baru.
  6. Instal Helm.

Sebaiknya Anda juga memahami Git, Kustomize, dan Helm.

Mengonfigurasi repositori

Tugas berikut menunjukkan cara menyiapkan repositori Git dengan konfigurasi yang menggabungkan konfigurasi Kustomize dengan diagram 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 menyertakan patch untuk basis diagram 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 dasar Kustomize, yang merender diagram Helm jarak jauh.

  5. Kembali ke root repositori Git Anda, buat file bernama ignore-deployment-mutation-patch.yaml, lalu 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 diagram Helm dasar. Tindakan ini akan 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 sudah 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 bekerja di repositori yang tidak terstruktur. Karena Anda menggunakan konfigurasi Kustomize dan diagram Helm, Anda perlu 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 output disimpan.
  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 bekerja di repositori yang 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 digunakan, Anda dapat mengonfigurasi sinkronisasi dari cluster ke repositori. Jika Anda telah menginstal Config Sync, lanjutkan ke Memverifikasi status sinkronisasi.

  1. Di konsol Google Cloud, aktifkan GKE Hub API.

    Buka GKE Hub API

  2. Di konsol Google Cloud, buka halaman Config di bagian Features.

    Buka Config

  3. Klik Install Config Sync.

  4. Pilih Auto-upgrades untuk mengaktifkan Config Sync guna mengupgrade versi secara otomatis.

  5. Di bagian Opsi penginstalan, pilih Instal Config Sync di setiap cluster.

  6. Di tabel Available clusters, pilih cs-cluster, lalu klik Install Config Sync. Di tab Setelan, Anda akan melihat status untuk cs-cluster sebagai Diaktifkan setelah beberapa menit.

  7. Di dasbor Config Sync, klik Deploy Package.

  8. Di tabel Select clusters for package deployment, pilih cs-cluster, lalu klik Continue.

  9. Biarkan Paket dihosting di Git dipilih, lalu klik Lanjutkan.

  10. Di kolom Package name, masukkan sample-repository.

  11. Di kolom Repository URL, masukkan https://github.com/GoogleCloudPlatform/anthos-config-management-samples.

  12. Di kolom Path, masukkan config-sync-quickstart/multirepo/root.

  13. Biarkan kolom lain tetap pada nilai defaultnya.

  14. Klik Deploy Package.

    Setelah beberapa menit, Anda akan melihat Disinkronkan di kolom Status sinkronisasi untuk cs-cluster.

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

  1. In the Google Cloud console, go to the Manage resources page.

    Go to Manage resources

  2. In the project list, select the project that you want to delete, and then click Delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

Menghapus resource satu per satu

Menghapus manifes di repositori Anda

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 baik 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. Verifikasi bahwa 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 Konsol Google Cloud, selesaikan tugas berikut:

  1. Di konsol Google Cloud, buka halaman GKE.

    Buka GKE

  2. Di samping cluster yang ingin Anda hapus, klik Tindakan, lalu klik Hapus.

  3. Saat diminta untuk mengonfirmasi, klik Hapus lagi.

gcloud

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

gcloud container clusters delete CLUSTER_NAME

Untuk informasi selengkapnya, lihat dokumentasi gcloud container clusters delete.

Langkah selanjutnya