Argo CD'de app-of-apps deseniyle Application'ları Git'ten yönetmek
Kök Application'ın nasıl kurulduğu, sync wave'in child Application'larda neden beklediğiniz gibi çalışmadığı, silme davranışı ve ApplicationSet'e geçiş.
Talos Mühendislik
Platform Ekibi
Argo CD'yi kurduğunuz gün ilk Application'ları arayüzden ya da kubectl apply ile yaratırsınız. Uygulamanın manifest'leri Git'tedir, ama o manifest'leri izleyen Application nesnesinin kendisi hiçbir yerde kayıtlı değildir. Sayı on beşi yirmiyi geçince hangisini kimin, hangi ayarla açtığını bilen kalmaz, cluster'ı yeniden kurmak da arayüzde tek tek tıklamak demek olur.
App-of-apps bu açığı kapatmanın en az zahmetli yolu. Application da sonuçta bir Kubernetes kaynağı olduğuna göre onu da bir repoya koyup başka bir Application'a izletebilirsiniz.
Kök Application ve repo düzeni
Elle uyguladığınız tek şey kök Application olur. O, bir dizindeki Application manifest'lerini izler, gerisini Argo CD halleder.
platform-gitops/
├── bootstrap/
│ └── root.yaml
└── apps/
├── cert-manager.yaml
├── kyverno.yaml
├── monitoring.yaml
└── billing-api.yaml
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
name: root
namespace: argocd
spec:
project: platform
source:
repoURL: https://git.example.com/platform/platform-gitops.git
targetRevision: main
path: apps
destination:
server: https://kubernetes.default.svc
namespace: argocd
syncPolicy:
automated:
prune: true
selfHeal: true
Argo CD bir dizini varsayılan olarak alt dizinlere inmeden okur. Application dosyalarını apps/platform/, apps/observability/ gibi klasörlere ayırmak isterseniz source.directory.recurse: true eklemeniz gerekir, yoksa kök Application hiçbirini görmez. Recurse açıkken o ağacın altına Application dışında manifest koymayın, onlar da uygulanmaya çalışılır.
Kök dosyasını izlenen dizinin dışında tutmayı tercih ediyorum. Kökün kendi kendini yönetmesi mümkün, ama hatalı bir commit'le kökü bozduğunuzda düzeltecek mekanizmayı da bozmuş olursunuz.
Yeni bir uygulama eklemek artık apps/ altına bir dosya koyan bir pull request'ten ibaret. Aynı sebeple o repoya yazabilen herkes fiilen Argo CD yöneticisidir, çünkü istediği projeye, istediği hedefe Application tanımlayabilir. Kök repoda merge yetkisini dar tutun, child Application'ları da default yerine izinleri sınırlanmış AppProject'lere bağlayın.
Sıralama için sync wave ve eksik sağlık kontrolü
Platform bileşenlerinin bir sırası vardır. cert-manager gelmeden sertifika isteyen bir chart, policy engine gelmeden policy'ler işe yaramaz. Argo CD'de bunun aracı sync wave annotation'ıdır. Düşük numara önce uygulanır, Argo CD bir wave'deki kaynaklar sağlıklı olmadan sonrakine geçmez.
metadata:
name: cert-manager
namespace: argocd
annotations:
argocd.argoproj.io/sync-wave: "10"
Burada desenin en çok can yakan ayrıntısı var. Argo CD 1.8'den beri Application kaynağı için hazır bir sağlık kontrolü gelmiyor. Kök Application, child Application nesnesi yaratılır yaratılmaz onu sağlıklı sayar ve bir sonraki wave'e geçer. Numaraları özenle verirsiniz, ama pratikte her şey neredeyse aynı anda başlar. Beklemesini istiyorsanız kontrolü argocd-cm içine kendiniz eklemeniz gerekiyor:
data:
resource.customizations.health.argoproj.io_Application: |
hs = {}
hs.status = "Progressing"
hs.message = ""
if obj.status ~= nil and obj.status.health ~= nil then
hs.status = obj.status.health.status
if obj.status.health.message ~= nil then
hs.message = obj.status.health.message
end
end
return hs
Kullandığınız sürümün belgesinden doğrulamakta fayda var. Bir de wave yalnızca kökün tek bir sync işlemi içinde sıra belirler. Child'lar sonradan kendi otomatik sync'leriyle bağımsız hareket eder, yani wave ilk kurulumun sırasını çözer, sonraki değişikliklerin sırasını garanti etmez.
CNI ayrı bir konu. Argo CD'nin pod'ları ağ olmadan ayağa kalkmaz, o yüzden çoğu kurulumda CNI'ı bootstrap aşamasında kurar, yönetimini sonradan Argo CD'ye devredersiniz. Bunu wave numarasıyla çözemezsiniz.
Silme davranışı
Kökte prune: true varken apps/ altından bir dosyayı silerseniz ilgili Application nesnesi de silinir. O Application'ın cluster'a kurduğu kaynakların akıbeti finalizer'a bağlıdır. Child Application'da resources-finalizer.argocd.argoproj.io finalizer'ı varsa deployment'lar, servisler, PVC'ler onunla birlikte gider. Yoksa Application kaybolur, kaynaklar sahipsiz hâlde cluster'da kalır.
İkisi de yanlış anda can sıkar. Benim tercihim finalizer'ı eklemek ve kök repoda dosya silen, taşıyan ya da ad değiştiren her pull request'i bu gözle okumak. Aynı mantık bir kademe yukarıda da geçerli, kök Application'ı cascade ile silmek bütün ağacı siler.
ApplicationSet'e geçiş
App-of-apps'te her Application için bir dosya yazarsınız. Aynı stack'i on tenant'a ya da on cluster'a kuruyorsanız bu dosyalar birbirinin kopyası olur ve bir alanı değiştirmek on dosyayı düzenlemek demektir. Bu noktada şablondan Application üreten ApplicationSet daha doğru araç.
apiVersion: argoproj.io/v1alpha1
kind: ApplicationSet
metadata:
name: tenant-stacks
namespace: argocd
spec:
goTemplate: true
generators:
- list:
elements:
- tenant: acme
- tenant: globex
template:
metadata:
name: '{{ .tenant }}-stack'
spec:
project: tenants
source:
repoURL: https://git.example.com/platform/platform-gitops.git
targetRevision: main
path: charts/tenant-stack
helm:
parameters:
- name: tenant
value: '{{ .tenant }}'
destination:
server: https://kubernetes.default.svc
namespace: 'tenant-{{ .tenant }}'
Gerçek kullanımda list generator yerine çoğunlukla Git dizinlerinden ya da kayıtlı cluster'lardan üreten generator'lar tercih edilir. Birden fazla cluster söz konusuysa merkezi modelin bedeli için Argo CD ile Flux karşılaştırmasına da bakın.
İki yaklaşım birbirini dışlamıyor. ApplicationSet manifest'ini apps/ dizinine koyarsanız kök Application onu da yönetir. Dikkat edeceğiniz yer yine silme: listeden bir eleman çıkardığınızda üretilen Application ve varsayılan ayarla kaynakları da silinir. Bunu istemiyorsanız ApplicationSet'in syncPolicy.preserveResourcesOnDeletion alanına bakın.