Mendeklarasikan dependensi antar-objek resource

Panduan ini mengajarkan cara kerja dependensi di Config Sync dan cara menentukan dependensi Anda sendiri.

Config Sync secara otomatis mendeteksi dependensi implisit antara objek tertentu saat menyinkronkannya ke cluster. Misalnya, objek Namespace selalu diterapkan sebelum objek apa pun di Namespace tersebut, dan objek CustomResourceDefinition (CRD) selalu diterapkan sebelum resource kustom jenis ini diterapkan. Demikian pula, urutan penghapusan dibalik untuk dependensi implisit ini: Namespace dihapus setelah objek di namespace tersebut, dan CRD dihapus setelah Resource Kustom jenis tersebut.

Anda juga dapat menetapkan dependensi eksplisit menggunakan anotasi depends-on. Misalnya, Anda mungkin ingin StatefulSet MySQL Anda dimulai sebelum Deployment Wordpress, sehingga database Anda diterapkan dan siap sebelum Wordpress dimulai.

Persyaratan

  • RootSync dan RepoSync API harus diaktifkan. Jika Anda menginstal Config Sync secara manual menggunakan kubectl, dan belum mengaktifkan API RootSync dan RepoSync, Anda harus memigrasikan objek ConfigManagement.

  • Batasan: Dependensi harus berada di sumber kebenaran yang sama dengan dependennya. Dependensi harus dikelola oleh objek RootSync atau RepoSync yang sama dengan objek yang bergantung padanya, yang memastikan semua resource berada di ResourceGroup yang sama.

Terapkan grup

Saat menyinkronkan resource ke cluster, Config Sync membagi resource yang memiliki dependensi langsung atau tidak langsung ke dalam grup penerapan yang berbeda. Satu grup penerapan hanya terdiri dari resource tanpa dependensi langsung atau tidak langsung satu sama lain. Grup penerapan yang tidak memiliki dependensi resource akan diterapkan terlebih dahulu.

Penggerakan dan rekonsiliasi

Saat objek diaktifkan (diterapkan atau dipangkas), objek tersebut mungkin memerlukan waktu beberapa saat untuk disesuaikan oleh pengontrolnya. Misalnya, saat Deployment diterapkan, Pod yang mendasarinya mungkin tidak langsung siap. Setelah Pod yang mendasarinya siap, Deployment akan disesuaikan. Untuk berbagai jenis objek, Config Sync memeriksa berbagai jenis kondisi untuk memverifikasi apakah suatu objek diselaraskan. Detail selengkapnya dapat ditemukan di sigs.k8s.io/cli-utils

Dengan anotasi depends-on, Config Sync tidak hanya menerapkan objek dalam urutan yang Anda inginkan, tetapi juga memverifikasi bahwa objek dependensi direkonsiliasi sebelum menerapkan objek dependen.

Jika objek dependensi tidak direkonsiliasi dalam waktu tunggu rekonsiliasi default 5 menit, Config Sync tidak akan menerapkan objek dependen hingga periode sinkronisasi berikutnya. Anda dapat mengganti waktu tunggu pencocokan default dengan menyetel spec.override.reconcileTimeout.

Menambahkan anotasi depends-on ke objek

Untuk menentukan dependensi, tambahkan anotasi config.kubernetes.io/depends-on pada objek dependen dengan nilai yang mereferensikan objek dependensi.

Untuk contoh Wordpress, anotasi di Deployment Wordpress menyerupai berikut:

# deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: wordpress
  namespace: default
  labels:
    app: wordpress
  annotations:
    config.kubernetes.io/depends-on: apps/namespaces/default/StatefulSet/wordpress-mysql

Saat menerapkan objek, Config Sync akan menerapkan dependensi terlebih dahulu, yaitu objek StatefulSet wordpress-mysql. Setelah dependensi disesuaikan, Config Sync akan menerapkan Deployment wordpress yang bergantung.

Referensi objek

Referensi objek menggunakan sintaksis berikut:

  • Untuk objek yang memiliki namespace:

    GROUP/namespaces/NAMESPACE/KIND/NAME

  • Untuk objek cakupan cluster:

    GROUP/KIND/NAME

    Ganti kode berikut:

    • GROUP: Grup objek dependensi.
    • NAMESPACE: Namespace objek dependensi cakupan namespace.
    • KIND: Jenis objek dependensi. Kolom ini peka huruf besar/kecil. Misalnya, gunakan "Pod" bukan "pod".
    • NAME: Nama objek dependensi.

Untuk objek dalam grup inti, string kosong digunakan sebagai gantinya, misalnya /namespaces/test/Pod/pod-a.

Gunakan , untuk memisahkan beberapa referensi objek, misalnya /namespaces/test/Pod/pod-a,/namespaces/test/Pod/pod-b.