Manifeste in Cloud Deploy verwalten

Auf dieser Seite wird beschrieben, wie Sie Cloud Deploy so konfigurieren, dass die Konfiguration für jedes Ziel in einer Bereitstellungspipeline gerendert wird.

Cloud Deploy verwendet Skaffold zum Rendern Ihrer Kubernetes-Manifeste. Der Dienst unterstützt das Rendering von RAW-Manifesten und erweiterten Manifestverwaltungstools wie Helm, Kustomize und kpt.

Der Renderingprozess umfasst zwei Phasen:

  1. Das Manifest-Managementtool generiert das Manifest.

  2. Skaffold ersetzt die Image-Referenzen im Manifest durch die Images, die Sie in Ihrem Release bereitstellen möchten.

Diese Seite enthält Konfigurationsbeispiele mit Helm und Kustomize.

Skaffold zum Generieren der Konfiguration verwenden

Wenn Sie noch keine Skaffold-Konfigurationsdatei (skaffold.yaml) haben, können Sie basierend auf dem Inhalt Ihres Repositorys Skaffold verwenden.

  1. Installieren Sie Skaffold über die Google Cloud CLI:

    gcloud components install skaffold

  2. Führen Sie skaffold init in dem Repository aus, das Ihre Manifeste enthält:

    skaffold init --skip-build

Mit diesem Befehl wird eine skaffold.yaml-Datei in Ihrem Repository erstellt. Diese Datei verweist auf die Manifeste in diesem Repository. Dieser Inhalt sieht so aus:

apiVersion: skaffold/v4beta6
kind: Config
metadata:
  name: sample-app
manifests:
  rawYaml:
    - k8s-manifests/deployment.yaml
    - k8s-manifests/rbac.yaml
    - k8s-manifests/redis.yaml
    - k8s-manifests/service.yaml

RAW-Manifeste rendern

Raw-Manifeste sind Manifeste, die nicht von einem Tool wie Helm oder Kustomize verwaltet werden und daher keine Vorverarbeitung erfordern, bevor sie in einem Cluster hydriert und in einem Cluster bereitgestellt werden.

Standardmäßig verwendet Cloud Deploy zum Rendern Ihrer Kubernetes-Manifeste skaffold render. Dabei ersetzt Cloud Deploy die Namen der nicht getaggten Images durch die Namen der von Ihnen bereitgestellten Container-Images. Wenn Sie dann den Release hochstufen, verwendet Cloud Deploy skaffold apply, um die Manifeste anzuwenden und die Images im Google Kubernetes Engine-Cluster bereitzustellen.

Eine manifests-Stanza aus einer Grundkonfiguration sieht so aus:

manifests:
  rawYaml:
    - PATH_TO_MANIFEST

Weitere Informationen dazu, welche Werte hier übergeben werden können, finden Sie in der Skaffold-Dokumentation.

Rendering mit Helm

Sie können Cloud Deploy zum Rendern Ihrer Helm-Diagramme verwenden. Fügen Sie dazu Helm-Diagrammdetails in eine deploy-Stanza in einem Skaffold-Profil ein.

Jede dieser Definitionen sieht so aus:

apiVersion: skaffold/v4beta6
kind: Config
manifests:
  helm:
    releases:
      - name: RELEASE_NAME
        chartPath: PATH_TO_HELM_CHART
        artifactOverrides:
          image: IMAGE_NAME

Wobei:

RELEASE_NAME ist der Name der Helm-Diagramminstanz für diesen Release.

PATH_TO_HELM_CHART ist der lokale Pfad zu einem gepackten Helm-Diagramm oder einem entpackten Helm-Diagrammverzeichnis.

IMAGE_NAME ist der Name des Container-Images, das Sie bereitstellen.

Ihr Helm-Diagramm muss einen Wert image-Parameter haben, der das im Diagramm bereitzustellende Image definiert.

Sie können zusätzliche Helm-Konfigurationsoptionen verwenden, wie in der Skaffold-Dokumentation beschrieben.

Rendering mit Kustomize

Sie können Kustomize mit Cloud Deploy verwenden. Verweisen Sie dazu auf die Kustomization-Dateien aus der deploy-Stanza in Ihrer skaffold.yaml-Profilkonfiguration.

Sie fügen eine separate Kustomize-Konfiguration für jedes Ziel hinzu, für das Sie Kustomize verwenden, und zwar unter jeder entsprechenden profile in Ihrer skaffold.yaml.

Jede dieser Definitionen sieht so aus:

apiVersion: skaffold/v4beta6
kind: Config
manifests:
  kustomize:
    paths:
      - PATH_TO_KUSTOMIZE

Wobei:

PATH_TO_KUSTOMIZE verweist auf Ihre Kustomization-Dateien. Der Standardwert ist ["."]

Sie können zusätzliche Kustomize-Konfigurationsoptionen verwenden, wie in der Skaffold-Dokumentation beschrieben.

Unterschiedliche Manifeste pro Ziel konfigurieren

Oft erfordert jedes Ziel eine etwas andere Konfiguration. Beispielsweise können die Produktionsbereitstellungen mehr Replikate enthalten als die Staging-Bereitstellungen.

Sie können für jedes Ziel eine andere Gruppe von Manifesten rendern, indem Sie jede Variante als anderes Skaffold-Profil bereitstellen.

Profile mit RAW-Manifesten

Wenn Sie mit Rohmanifesten arbeiten, können Sie Cloud Deploy je nach Ziel auf eine andere Datei verweisen. Sie könnten sie so konfigurieren:

apiVersion: skaffold/v4beta6
kind: Config
profiles:
  - name: prod
    manifests:
      rawYaml:
        - prod.yaml
  - name: staging
    manifests:
      rawYaml:
        - staging.yaml

Profile mit Kustomize

Hier sehen Sie ein Beispiel-skaffold.yaml mit unterschiedlichen Profilen für Staging und Produktion mit Kustomize, wobei jedes Profil auf eine andere Kustomisierung verweist:

apiVersion: skaffold/v4beta6
kind: Config
profiles:
  - name: prod
    manifests:
      kustomize:
        paths:
          - environments/prod
  - name: staging
    manifests:
      kustomize:
        paths:
          - environments/staging

Profile, auf die in der Bereitstellungspipeline verwiesen wird

Auf diese in skaffold.yaml definierten Profile wird in der Konfiguration der Bereitstellungspipeline pro Ziel verwiesen:

serialPipeline:
  stages:
  - targetId: staging-target
    profiles:
    - staging
  - targetId: prod-target
    profiles:
    - prod

Nächste Schritte