Memantau objek RootSync dan RepoSync

Halaman ini menunjukkan berbagai cara untuk memantau objek RootSync dan RepoSync. Misalnya, Anda mungkin ingin memverifikasi apakah commit terbaru dalam sumber tepercaya diterapkan ke cluster dan berhasil direkonsiliasi.

Lihat commit yang disinkronkan

Anda dapat memeriksa commit mana yang disinkronkan ke cluster dengan memeriksa kolom .status.sync dalam objek RootSync atau RepoSync.

  • Untuk melihat commit yang disinkronkan untuk objek RootSync, jalankan perintah berikut:

    kubectl get rootsync ROOT_SYNC_NAME -n config-management-system
    

    Ganti ROOT_SYNC_NAME dengan nama objek RootSync.

  • Untuk melihat commit yang disinkronkan untuk objek RepoSync, jalankan perintah berikut:

    kubectl get reposync REPO_SYNC_NAME -n REPO_SYNC_NAMESPACE
    

    Ganti kode berikut:

    • REPO_SYNC_NAME: nama objek RepoSync.
    • REPO_SYNC_NAMESPACE: namespace tempat Anda membuat repositori namespace.

Output untuk perintah ini menunjukkan nilai commit sumber dan commit yang disinkronkan. Misalnya, jika Anda menjalankan perintah untuk RepoSync, Anda akan melihat output yang mirip dengan berikut ini:

NAME        RENDERINGCOMMIT                            SOURCECOMMIT                               SYNCCOMMIT
root-sync   66882815f0ef5517df27e864fb1315e97756ab72   66882815f0ef5517df27e864fb1315e97756ab72   66882815f0ef5517df27e864fb1315e97756ab72

Nilai dalam kolom RENDERINGCOMMIT adalah commit yang diproses oleh hydration-controller. Jika tidak ada rendering yang diperlukan, nilainya akan sama dengan kolom SOURCECOMMIT. Nilai dalam kolom SOURCECOMMIT adalah commit dari sumber tepercaya yang harus disinkronkan ke cluster. Nilai dalam kolom SYNCCOMMIT adalah commit yang di-deploy ke cluster. Jika kedua nilai dalam kolom SOURCECOMMIT dan SYNCCOMMIT sama, berarti commit yang diharapkan telah di-deploy ke cluster.

Memastikan resource di commit telah direkonsiliasi

Karena ResourceGroups merekam status rekonsiliasi resource terkelola yang dideklarasikan dalam sumber tepercaya, Anda dapat memeriksanya untuk mengonfirmasi apakah resource dalam commit direkonsiliasi.

Objek ResourceGroup memiliki namespace dan nama yang sama dengan objek RootSync atau RepoSync. Misalnya, untuk objek RootSync dengan nama root-sync dalam config-management-system namespace, objek ResourceGroup yang sesuai juga root-sync dalam namespace config-management-system.

  • Untuk mendapatkan objek ResourceGroup untuk objek RootSync:

    kubectl get resourcegroup ROOT_SYNC_NAME -n config-management-system -o yaml
    
  • Untuk mendapatkan objek ResourceGroup untuk objek RepoSync:

    kubectl get resourcegroup REPO_SYNC_NAME -n REPO_SYNC_NAMESPACE -o yaml
    

    Ganti kode berikut:

    • ROOT_SYNC_NAME: nama objek ResourceGroup yang ingin Anda cari.
    • REPO_SYNC_NAME: nama objek ResourceGroup yang ingin Anda cari.
    • REPO_SYNC_NAMESPACE: nama objek ResourceGroup yang ingin Anda cari.

Untuk mengonfirmasi bahwa resource dalam commit direkonsiliasi, cari hal berikut dalam output:

  • .status.observedGeneration sama dengan nilai kolom .metadata.generation di objek ResourceGroup.
  • Kondisi Stalled dan kondisi Reconciling memiliki status sebagai "False".
  • Setiap item di kolom .status.resourceStatuses memiliki status Current.

Lihat error

Objek RootSync dan RepoSync menggunakan kolom status untuk melacak error yang ditemukan saat menyinkronkan konfigurasi dari sumber tepercaya ke cluster.

  • Untuk melihat status objek RootSync, jalankan perintah berikut:

    kubectl get rootsync ROOT_SYNC_NAME -n config-management-system -o yaml
    

    Ganti ROOT_SYNC_NAME dengan nama objek RootSync.

  • Untuk melihat status objek RepoSync, jalankan perintah berikut:

    kubectl get reposync REPO_SYNC_NAME -n NAMESPACE -o yaml
    

    Ganti kode berikut:

    • REPO_SYNC_NAME: nama objek RepoSync.
    • NAMESPACE: namespace tempat Anda membuat repositori namespace.

Untuk mempelajari subkolom pada kolom status lebih lanjut, lihat Status objek.

Melihat detail objek

Untuk melihat detail objek RootSync dan RepoSync serta menemukan informasi lebih lanjut tentang potensi error, gunakan perintah kubectl describe.

Output dari perintah ini mencakup peristiwa, yang dapat sangat membantu untuk men-debug masalah seperti container yang mengalami batasan memori (OOMKilled), kegagalan penjadwalan, atau error penarikan image.

Agar format lebih mudah dibaca, konversikan output ke YAML dengan menambahkan -o yaml ke perintah berikut. Format ini sangat membantu ketika Anda perlu memeriksa parameter, anotasi, atau spesifikasi resource tertentu.

  • Untuk melihat detail objek RootSync, jalankan perintah berikut:

    kubectl describe rootsync ROOT_SYNC_NAME -n config-management-system
    

    Ganti ROOT_SYNC_NAME dengan nama objek RootSync.

  • Untuk melihat detail objek RepoSync, jalankan perintah berikut:

    kubectl describe reposync REPO_SYNC_NAME -n NAMESPACE
    

    Ganti kode berikut:

    • REPO_SYNC_NAME: nama objek RepoSync.
    • NAMESPACE: namespace tempat Anda membuat repositori namespace.

Melihat apakah resource sudah siap

Untuk mengetahui apakah resource yang disinkronkan ke cluster sudah siap, lihat status rekonsiliasi. Misalnya, melihat status rekonsiliasi dapat menunjukkan apakah Deployment yang disinkronkan siap untuk menyalurkan traffic.

Untuk sumber tepercaya yang disinkronkan ke cluster, status rekonsiliasi semua resource digabungkan dalam resource yang disebut ResourceGroup. Untuk setiap objek RootSync atau RepoSync, ResourceGroup akan dibuat untuk menangkap kumpulan resource yang diterapkan ke cluster dan menggabungkan statusnya.

  • Untuk melihat status rekonsiliasi untuk objek RootSync, jalankan perintah berikut:

    kubectl get resourcegroup.kpt.dev ROOT_SYNC_NAME -n config-management-system -o yaml
    

    Ganti ROOT_SYNC_NAME dengan nama objek RootSync.

  • Untuk melihat status rekonsiliasi untuk objek RepoSync, jalankan perintah berikut:

    kubectl get resourcegroup.kpt.dev REPO_SYNC_NAME -n NAMESPACE -o yaml
    

    Ganti kode berikut:

    • REPO_SYNC_NAME: nama objek RepoSync.
    • NAMESPACE: namespace tempat Anda membuat repositori namespace.

Pada output, Anda akan melihat semua status resource ResourceGroup. Misalnya, output berikut menunjukkan bahwa Deployment yang bernama nginx-deployment sudah siap:

resourceStatuses:
- group: apps
  kind: Deployment
  name: nginx-deployment
  namespace: default
  status: Current

Lihat log

Untuk setiap objek RootSync dan RepoSync yang Anda buat, Config Sync akan membuat Deployment rekonsiler untuk melakukan sinkronisasi. Bagian ini menjelaskan cara melihat log untuk rekonsiler ini. Melihat log dapat membantu saat men-debug masalah dengan memberikan informasi tambahan tentang progres, peringatan, dan error selain yang tersedia di status objek RootSync dan RepoSync.

  • Untuk melihat log rekonsiler RootSync atau RepoSync, jalankan perintah berikut:

    kubectl logs -n config-management-system deployment/RECONCILER_NAME CONTAINER_NAME
    

    Ganti kode berikut:

    • RECONCILER_NAME: nama rekonsiliasi objek RootSync atau RepoSync.

      • Untuk RootSync, nama rekonsilernya adalah root-reconciler-ROOT_SYNC_NAME atau root-reconciler jika nama RootSync adalah root-sync.

      • Untuk RepoSync, nama rekonsilernya adalah ns-reconciler-NAMESPACE-REPO_SYNC_NAME-REPO_SYNC_NAME_LENGTH atau ns-reconciler-NAMESPACE jika nama RepoSync adalah repo-sync, dengan NAMESPACE adalah namespace tempat Anda membuat objek RepoSync.

    • CONTAINER_NAME: nama penampung harus berupa salah satu dari nilai berikut: reconciler, git-sync, hydration-controller, oci-sync, atau helm-sync. Untuk mempelajari penampung ini lebih lanjut, lihat Penampung rekonsiler.

Mengonfigurasi level log rekonsiler RootSync atau RepoSync

Untuk menyertakan informasi lebih lanjut dalam log container, konfigurasikan panjang log. Secara default, sebagian besar penampung memiliki nilai default 0 untuk log verbositas. Pengecualian untuk hal ini adalah penampung git-sync dan otel-agent yang memiliki nilai default 5.

Saat mengubah panjang log, perlu diingat bahwa meningkatkan panjang log akan mengakibatkan biaya logging yang lebih tinggi karena volume data yang dicatat lebih besar.

Untuk mengubah panjang log, gunakan kolom .spec.override.logLevels seperti ditunjukkan pada contoh berikut:

apiVersion: configsync.gke.io/v1beta1
kind: RootSync
metadata:
  name: root-sync
  namespace: config-management-system
spec:
  override:
    logLevels:
    - containerName: "reconciler"
      logLevel: 0
    - containerName: "git-sync"
       logLevel: 10

Nilai di kolom containerName harus salah satu dari yang berikut: reconciler, git-sync, hydration-controller, oci-sync, atau helm-sync.

Untuk mengonfirmasi panjang log dikonfigurasi, jalankan perintah berikut:

kubectl get deployment.apps/root-reconciler -n config-management-system -o yaml

Verbositas log dapat ditemukan sebagai salah satu args dalam spec.template.spec.containers[] dan terlihat seperti -v=0, dengan 0 adalah panjang log saat ini. Dalam contoh ini, nilai log verbositas 0 hanya akan mencatat peristiwa penting.