YAML-Definition der Aktion „Auf Kubernetes-Cluster bereitstellen“

Im Folgenden finden Sie die YAML-Definition der Cluster-Aktion Deploy to Kubernetes. Informationen zur Verwendung dieser Aktion finden Sie unter. Bereitstellung einer Anwendung auf Amazon Elastic Kubernetes Service mit einem Workflow

Diese Aktionsdefinition ist als Abschnitt in einer umfassenderen Workflow-Definitionsdatei vorhanden. Weitere Informationen über diese Datei finden Sie unter YAML-Workflow-Definition.

Anmerkung

Die meisten der folgenden YAML-Eigenschaften haben entsprechende Benutzeroberflächenelemente im visuellen Editor. Verwenden Sie Strg+F, um nach einem UI-Element zu suchen. Das Element wird mit der zugehörigen YAML-Eigenschaft aufgelistet.

# The workflow definition starts here.
# See Eigenschaften der obersten Ebene for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.   
  DeployToKubernetesCluster_nn: 
    Identifier: aws/kubernetes-deploy@v1
    DependsOn:
      - build-action
    Compute:  
        - Type: EC2 | Lambda
        - Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: DeployToEKS
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - manifest-artifact
    Configuration:
      Namespace: namespace
      Region: us-east-1 
      Cluster: eks-cluster
      Manifests: manifest-path

DeployToKubernetesCluster

(Erforderlich)

Geben Sie den Namen der Aktion an. Alle Aktionsnamen müssen innerhalb des Workflows eindeutig sein. Aktionsnamen sind auf alphanumerische Zeichen (a-z, A-Z, 0-9), Bindestriche (-) und Unterstriche (_) beschränkt. Leerzeichen sind nicht erlaubt. Sie können keine Anführungszeichen verwenden, um Sonderzeichen und Leerzeichen in Aktionsnamen zuzulassen.

Standard: DeployToKubernetesCluster_nn.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“/Anzeigename der Aktion

Identifier

(DeployToKubernetesCluster/Identifier)

(Erforderlich)

Identifiziert die Aktion. Ändern Sie diese Eigenschaft nicht, es sei denn, Sie möchten die Version ändern. Weitere Informationen finden Sie unter Angabe der Haupt-, Neben- oder Patch-Version einer Aktion.

Standard: aws/kubernetes-deploy@v1.

Entsprechende Benutzeroberfläche: Workflow-Diagram/ DeployToKubernetesCluster _nn/ aws/kubernetes-deploy @v1 label

DependsOn

(DeployToKubernetesCluster/DependsOn)

(Optional)

Geben Sie eine Aktion, eine Aktionsgruppe oder ein Gate an, die erfolgreich ausgeführt werden müssen, damit diese Aktion ausgeführt werden kann.

Weitere Hinweise zur Funktion „Hängt davon ab“ finden Sie unter. Aktionen so konfigurieren, dass sie von anderen Aktionen abhängen

Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„Hängt davon ab“ — optional

Compute

(DeployToKubernetesCluster/Compute)

(Optional)

Die Rechen-Engine, die zur Ausführung Ihrer Workflow-Aktionen verwendet wurde. Sie können die Berechnung entweder auf Workflow-Ebene oder auf Aktionsebene angeben, jedoch nicht auf beiden Ebenen. Wenn auf Workflow-Ebene angegeben, gilt die Rechenkonfiguration für alle im Workflow definierten Aktionen. Auf Workflow-Ebene können Sie auch mehrere Aktionen auf derselben Instanz ausführen. Weitere Informationen finden Sie unter Rechenleistung für mehrere Aktionen gemeinsam nutzen.

Entsprechende Benutzeroberfläche: keine

Type

(DeployToKubernetesCluster/Compute/Type)

(Erforderlich, wenn Compute es enthalten ist)

Der Typ der Compute Engine. Sie können einen der folgenden Werte verwenden:

• EC2 (visueller Editor) oder EC2 (YAML-Editor)

  Optimiert für Flexibilität bei Aktionsläufen.

• Lambda (visueller Editor) oder Lambda (YAML-Editor)

  Optimierte Startgeschwindigkeiten für Aktionen.

Weitere Informationen zu Datentypen finden Sie unter Berechnungstypen.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /Erweitert — optional/ Berechnungstyp

Fleet

(DeployToKubernetesCluster/Compute/Fleet)

(Optional)

Geben Sie die Maschine oder Flotte an, auf der Ihr Workflow oder Ihre Workflow-Aktionen ausgeführt werden sollen. Bei bedarfsgesteuerten Flotten stellt der Workflow zu Beginn einer Aktion die benötigten Ressourcen bereit, und die Maschinen werden zerstört, wenn die Aktion abgeschlossen ist. Beispiele für Flotten auf Abruf:Linux.x86-64.Large,. Linux.x86-64.XLarge Weitere Informationen zu Flotten auf Abruf finden Sie unter. Flotteneigenschaften auf Abruf

Bei bereitgestellten Flotten konfigurieren Sie eine Reihe von dedizierten Maschinen, um Ihre Workflow-Aktionen auszuführen. Diese Maschinen bleiben inaktiv und können sofort Aktionen ausführen. Weitere Informationen zu bereitgestellten Flotten finden Sie unter. Bereitgestellte Flotteneigenschaften

Wenn Fleet es weggelassen wird, ist die Standardeinstellung. Linux.x86-64.Large

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /Erweitert — optional/ Compute Fleet

Timeout

(DeployToKubernetesCluster/Timeout)

(Optional)

Geben Sie an, wie lange die Aktion in Minuten (YAML-Editor) oder Stunden und Minuten (visueller Editor) ausgeführt werden kann, bevor die Aktion beendet wird. CodeCatalyst Das Minimum beträgt 5 Minuten und das Maximum ist unter beschriebenKontingente für Workflows. Das Standard-Timeout entspricht dem maximalen Timeout.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Timeout“ — optional

Environment

(DeployToKubernetesCluster/Environment)

(Erforderlich)

Geben Sie die CodeCatalyst Umgebung an, die für die Aktion verwendet werden soll.

Weitere Informationen zu Umgebungen finden Sie unter Bereitstellung in AWS-Konten und VPCs mit Umgebungen CodeCatalyst undErstellen einer Umgebung.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /„ Umgebung/Konto/Rolle“/Umgebung

Name

(DeployToKubernetesCluster/Environment/Name)

(EnvironmentErforderlich, wenn es enthalten ist)

Geben Sie den Namen einer vorhandenen Umgebung an, die Sie der Aktion zuordnen möchten.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /„ Umgebung/Konto/Rolle“/Umgebung

Connections

(DeployToKubernetesCluster/Environment/Connections)

(EnvironmentErforderlich, wenn es enthalten ist)

Geben Sie die Kontoverbindung an, die der Aktion zugeordnet werden soll. Sie können unter maximal eine Kontoverbindung angebenEnvironment.

Weitere Informationen zu Kontoverbindungen finden Sie unterErmöglichen des Zugriffs auf AWS Ressourcen mit verbundenen AWS-Konten. Informationen darüber, wie Sie eine Kontoverbindung mit Ihrer Umgebung verknüpfen, finden Sie unterErstellen einer Umgebung.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /„ Umgebung/Konto/Rolle“/Kontoverbindung AWS

Name

(DeployToKubernetesCluster/Environment/Connections/Name)

(Erforderlich)

Geben Sie den Namen der Kontoverbindung an.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /„ Umgebung/Konto/Rolle“/Kontoverbindung AWS

Role

(DeployToKubernetesCluster/Environment/Connections/Role)

(Erforderlich)

Geben Sie den Namen der IAM-Rolle an, auf die die Clusteraktion Deploy to Kubernetes für den Zugriff verwendet. AWS Stellen Sie sicher, dass diese Rolle die folgenden Richtlinien umfasst:

• Die folgende Berechtigungsrichtlinie:

  Warnung

  Beschränken Sie die Berechtigungen auf diejenigen, die in der folgenden Richtlinie aufgeführt sind. Die Verwendung einer Rolle mit umfassenderen Berechtigungen kann ein Sicherheitsrisiko darstellen.

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Effect": "Allow",
              "Action": [
                  "eks:DescribeCluster",
                  "eks:ListClusters"
              ],
              "Resource": "*"
          }
      ]
  }

  Anmerkung

  Wenn die Rolle zum ersten Mal verwendet wird, verwenden Sie den folgenden Platzhalter in der Ressourcenrichtlinienanweisung und grenzen Sie dann die Richtlinie mit dem Ressourcennamen ab, sobald sie verfügbar ist.

  "Resource": "*"

• Die folgende benutzerdefinierte Vertrauensrichtlinie:

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Sid": "",
              "Effect": "Allow",
              "Principal": {
                  "Service":  [
                     "codecatalyst-runner.amazonaws.com",
                     "codecatalyst.amazonaws.com"
                   ]
              },
              "Action": "sts:AssumeRole"
          }
      ]
  }

Stellen Sie sicher, dass diese Rolle hinzugefügt wurde zu:

• Ihre Kontoverbindung. Weitere Informationen zum Hinzufügen einer IAM-Rolle zu einer Kontoverbindung finden Sie unterHinzufügen von IAM-Rollen zu Kontoverbindungen.

• Ihr Kubernetes ConfigMap. Weitere Informationen zum Hinzufügen einer IAM-Rolle zu einer ConfigMap finden Sie in der Dokumentation unter Verwalten von IAM-Benutzern und -Rollen. eksctl

Tipp

Anweisungen Tutorial: Bereitstellen einer Anwendung in Amazon EKS zum Hinzufügen einer IAM-Rolle zu einer Kontoverbindung finden Sie auch unter. ConfigMap

Anmerkung

Sie können hier den Namen der CodeCatalystWorkflowDevelopmentRole-spaceName Rolle angeben, wenn Sie möchten. Weitere Informationen über diese Rolle finden Sie unter Die CodeCatalystWorkflowDevelopmentRole-spaceNameRolle für Ihr Konto und Ihren Bereich erstellen. Beachten Sie, dass die CodeCatalystWorkflowDevelopmentRole-spaceName Rolle über sehr umfangreiche Berechtigungen verfügt, was ein Sicherheitsrisiko darstellen kann. Wir empfehlen, diese Rolle nur in Tutorials und Szenarien zu verwenden, in denen die Sicherheit weniger wichtig ist. Wenn Sie sich dafür entscheiden, die CodeCatalystWorkflowDevelopmentRole-spaceName Rolle zu verwenden, stellen Sie sicher, dass Sie sie Ihrer ConfigMap Datei hinzufügen. Folgen Sie dabei den Anweisungen unter Verwalten von IAM-Benutzern und -Rollen in der eksctl Dokumentation.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /„ Umgebung/Konto/Rolle“/Rolle

Inputs

(DeployToKubernetesCluster/Inputs)

(Optional)

In Inputs diesem Abschnitt werden die Daten definiert, die während einer Workflow-Ausführung benötigt werden. DeployToKubernetesCluster

Anmerkung

Pro Aktion „In Amazon EKS bereitstellen“ ist nur eine Eingabe (entweder eine Quelle oder ein Artefakt) zulässig.

Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“

Sources

(DeployToKubernetesCluster/Inputs/Sources)

(Erforderlich, wenn Ihre Manifestdatei in einem Quell-Repository gespeichert ist)

Wenn Ihre Kubernetes-Manifestdatei (en) in einem Quell-Repository gespeichert sind, geben Sie die Bezeichnung dieses Quell-Repositorys an. Derzeit ist das einzige unterstützte Label. WorkflowSource

Wenn Ihre Manifestdateien nicht in einem Quell-Repository enthalten sind, müssen sie sich in einem Artefakt befinden, das durch eine andere Aktion generiert wurde.

Weitere Informationen zu Quellen finden Sie unter Einen Workflow mit einem Quell-Repository verbinden.

Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„Quellen“ — optional

Artifacts - input

(DeployToKubernetesCluster/Inputs/Artifacts)

(Erforderlich, wenn Ihre Manifestdatei in einem Ausgabeartefakt einer früheren Aktion gespeichert ist)

Wenn die Kubernetes-Manifestdatei (en) in einem Artefakt enthalten sind, das durch eine vorherige Aktion generiert wurde, geben Sie dieses Artefakt hier an. Wenn Ihre Manifestdateien nicht in einem Artefakt enthalten sind, müssen sie sich in Ihrem Quell-Repository befinden.

Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unter. Teilen von Daten zwischen Aktionen in einem Workflow mithilfe von Artefakten

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“/„Artefakte“ — optional

Configuration

(DeployToKubernetesCluster/Configuration)

(Erforderlich)

Ein Abschnitt, in dem Sie die Konfigurationseigenschaften der Aktion definieren können.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“

Namespace

(DeployToKubernetesCluster/Configuration/Namespace)

(Optional)

Geben Sie den Kubernetes-Namespace an, in dem Ihre Kubernetes-Anwendung bereitgestellt wird. Verwenden Sie diese Optiondefault, wenn Sie in Ihrem Cluster keine Namespaces verwenden. Weitere Informationen zu Namespaces finden Sie in der Kubernetes-Dokumentation unter Unterteilung Ihres Clusters mithilfe von Kubernetes-Namespaces.

Wenn Sie den Namespace weglassen, wird der Wert von verwendet. default

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Namespace“

Region

(DeployToKubernetesCluster/Configuration/Region)

(Erforderlich)

Geben Sie die AWS Region an, in der sich Ihr Amazon EKS-Cluster und -Service befinden. Eine Liste der Regionscodes finden Sie unter Regionale Endpunkte in der. Allgemeine AWS-Referenz

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Region“

Cluster

(DeployToKubernetesCluster/Configuration/Cluster)

(Erforderlich)

Geben Sie den Namen eines vorhandenen Amazon EKS-Clusters an. Mit der Aktion „Auf Kubernetes-Cluster bereitstellen“ wird Ihre containerisierte Anwendung in diesem Cluster bereitgestellt. Weitere Informationen zu Amazon EKS-Clustern finden Sie unter Clusters im Amazon EKS-Benutzerhandbuch.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Cluster“

Manifests

(DeployToKubernetesCluster/Configuration/Manifests)

(Erforderlich)

Geben Sie den Pfad zu Ihren Kubernetes-Manifestdateien im YAML-Format an, die in der Kubernetes-Dokumentation als Konfigurationsdateien, Konfigurationsdateien oder einfach als Konfigurationen bezeichnet werden.

Wenn Sie mehrere Manifestdateien verwenden, platzieren Sie sie in einem einzigen Ordner und verweisen Sie auf diesen Ordner. Manifestdateien werden von Kubernetes alphanumerisch verarbeitet. Stellen Sie daher sicher, dass Sie Dateinamen mit steigenden Zahlen oder Buchstaben voranstellen, um die Verarbeitungsreihenfolge zu kontrollieren. Beispielsweise:

00-namespace.yaml

01-deployment.yaml

Wenn sich Ihre Manifestdateien in Ihrem Quell-Repository befinden, ist der Pfad relativ zum Stammordner des Quell-Repositorys. Wenn sich die Dateien in einem Artefakt aus einer früheren Workflow-Aktion befinden, ist der Pfad relativ zum Artefakt-Stammordner.

Beispiele:

Manifests/

deployment.yaml

my-deployment.yml

Verwenden Sie keine Platzhalter (). *

Anmerkung

Helm-Diagramme und Anpassungsdateien werden nicht unterstützt.

Weitere Informationen zu Manifestdateien finden Sie in der Kubernetes-Dokumentation unter Organisieren von Ressourcenkonfigurationen.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Manifeste“