Diese Seite wurde von der Cloud Translation API übersetzt.

Config Sync mit Kustomize und Helm verwenden

In dieser Anleitung fügen Sie Ihrem Repository Kustomize-Konfigurationen hinzu, die auf Helm-Diagramme verweisen. Anschließend verwenden Sie Config Sync, um Ihren Cluster mit Ihrem Repository zu synchronisieren.

Wenn Sie Config Sync verwenden, werden die Kustomize-Konfigurationen und Helm-Diagramme, die Sie in Ihrem Git-Repository speichern, automatisch gerendert. Das automatische Rendering bietet folgende Vorteile:

Sie benötigen keine externe Hydrationspipeline mehr. Ohne automatisiertes Rendering müssen Sie die Konfigurationen manuell mit Kustomize und Helm auf Ihrer Workstation rendern oder einen Schritt einrichten, um den Hydrationsprozess in Ihren CI-Systemen auszulösen. Bei automatisiertem Rendering übernimmt Config Sync die Ausführung.
Ihre Wartungskosten werden reduziert. Ohne automatisiertes Rendering müssen Sie ein Git-Repository mit den ursprünglichen Kustomize-Konfigurationen und Helm-Diagrammen und ein weiteres Git-Repository mit der von der externen Hydration generierten Ausgabe verwalten. Anschließend müssen Sie Config Sync für die Synchronisierung aus dem Git-Repository mit der gerenderten Ausgabe konfigurieren. Beim automatisierten Rendering müssen Sie nur ein einziges Repository mit den ursprünglichen Konfigurationen verwalten.
Ihr Entwicklungsworkflow wird vereinfacht. Ohne automatisiertes Rendering müssen Änderungen an Ihren ursprünglichen Konfigurationen zweimal überprüft werden, bevor sie zusammengeführt werden: einmal im ursprünglichen Repository und einmal im gerenderten Repository. Beim automatisierten Rendering werden die gerenderten Konfigurationen von Config Sync generiert. Sie müssen nur die Änderungen an den ursprünglichen Konfigurationen überprüfen.

Repository konfigurieren

Die folgenden Aufgaben zeigen, wie Sie ein Git-Repository mit Konfigurationen vorbereiten, die Kustomize-Konfigurationen mit Helm-Diagrammen kombinieren:

Erstellen Sie ein Git-Repository oder sorgen Sie dafür, dass Sie darauf zugreifen können. Da Ihr Repository Kustomize und Helm verwendet, sollte dies ein unstrukturiertes Repository sein.
Erstellen Sie im Stammverzeichnis Ihres Git-Repositorys eine Datei mit dem Namen kustomization.yaml und fügen Sie den folgenden Code in diese ein:
```
# ./kustomization.yaml
resources:
- base

patches:
- path: ignore-deployment-mutation-patch.yaml
  target:
    kind: Deployment
```
Diese Datei ist ein Kustomize-Overlay, das auf die Kustomize-Basis verweist. Dieses Overlay enthält einen Patch für die Helm-Diagrammbasis, der die client.lifecycle.config.k8s.io/mutation: ignore-Annotation zu allen Deployment-Objekten hinzufügt. Die Annotation bewirkt, dass Config Sync in Konflikt stehende Änderungen an diesem Objekt im Cluster ignoriert, nachdem Sie es erstellt haben.
Erstellen Sie in Ihrem Git-Repository ein Verzeichnis mit dem Namen base:
```
mkdir base
```
Erstellen Sie im Verzeichnis base eine weitere Datei mit dem Namen kustomization.yaml und fügen Sie den folgenden Code in diese ein:
```
# ./base/kustomization.yaml
helmCharts:
- name: cert-manager
  repo: https://charts.jetstack.io
  version: v1.5.3
  releaseName: my-cert-manager
  namespace: cert-manager
```
Diese Datei ist die Kustomize-Basis, die das Remote-Helm-Diagramm rendert.
Wechseln Sie zurück zum Stammverzeichnis Ihres Git-Repositorys, erstellen Sie eine Datei mit dem Namen ignore-deployment-mutation-patch.yaml und fügen Sie den folgenden Code in diese ein:
```
# ./ignore-deployment-mutation-patch.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
 name: any
 annotations:
   client.lifecycle.config.k8s.io/mutation: ignore
```
Diese Datei ist ein Patch, der auf das Helm-Basisdiagramm angewendet wird. Die Annotation client.lifecycle.config.k8s.io/mutation: ignore wird allen Deployments im Basisverzeichnis hinzugefügt.

Übernehmen Sie die Änderungen für Ihr Repository:

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

Das Beispiel-Repository enthält ein Beispiel für ein solches Repository.

Vorschau gerenderter Konfigurationen anzeigen und diese validieren

Bevor Config Sync die Konfigurationen rendert und mit dem Cluster synchronisiert, prüfen Sie, ob die Konfigurationen korrekt sind. Führen Sie dazu nomos hydrate aus, um eine Vorschau der gerenderten Konfiguration anzuzeigen, und nomos vet, um zu prüfen, ob das Format korrekt ist.

Führen Sie den folgenden nomos hydrate-Befehl mit den folgenden Flags aus:
```
nomos hydrate \
    --source-format=unstructured \
    --output=OUTPUT_DIRECTORY
```
Dabei gilt:
- Mit --source-format=unstructured kann nomos hydrate an einem unstrukturierten Repository arbeiten. Da Sie Kustomize-Konfigurationen und Helm-Diagramme verwenden, müssen Sie ein unstrukturiertes Repository verwenden und dieses Flag hinzufügen.
- Mit --output=OUTPUT_DIRECTORY können Sie einen Pfad zu den gerenderten Konfigurationen definieren. Ersetzen Sie OUTPUT_DIRECTORY durch den Speicherort, an dem die Ausgabe gespeichert werden soll.
Prüfen Sie die Syntax und Gültigkeit Ihrer Konfigurationen. Führen Sie dazu nomos vet mit den folgenden Flags aus:
```
nomos vet \
    --source-format=unstructured \
    --keep-output=true \
    --output=OUTPUT_DIRECTORY
```
Dabei gilt:
- Mit --source-format=unstructured kann nomos vet an einem unstrukturierten Repository arbeiten.
- --keep-output=true speichert die gerenderten Konfigurationen.
- --output=OUTPUT_DIRECTORY ist der Pfad zu den gerenderten Konfigurationen.

Synchronisierung über das Git-Repository konfigurieren

Nachdem Sie ein Repository mit den Konfigurationen erstellt haben, die Sie verwenden möchten, können Sie die Synchronisierung von Ihrem Cluster zu Ihrem Repository konfigurieren.

Erstellen Sie eine root-sync.yaml-Datei, um Ihr RootSync-Objekt zu konfigurieren:

# 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

Ersetzen Sie YOUR_GIT_REPOSITORY durch die URL Ihres Git-Repositorys.

Wenden Sie die Datei root-sync.yaml auf Ihren Cluster an:
```
kubectl apply -f root-sync.yaml
```

Installation überprüfen

Nach der Installation und Konfiguration von Config Sync können Sie prüfen, ob die Installation erfolgreich abgeschlossen wurde.

Prüfen Sie mit nomos status, ob keine anderen Fehler vorliegen:

nomos status

Beispielausgabe:

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

Prüfen Sie, ob die Helm-Komponente erfolgreich installiert wurde:

kubectl get all -n cert-manager