Définition YAML de l'action « Déployer vers un cluster Kubernetes » - Amazon CodeCatalyst
DeployToKubernetesClusterIdentifierDependsOnComputeTypeFleetTimeoutEnvironmentNameConnectionsNameRoleInputsSourcesArtifacts - inputConfigurationNamespaceRegionClusterManifests

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Définition YAML de l'action « Déployer vers un cluster Kubernetes »

Voici la définition YAML de l'action Deploy to Kubernetes cluster. Pour savoir comment utiliser cette action, consultezDéploiement d'une application sur Amazon Elastic Kubernetes Service à l'aide d'un flux de travail.

Cette définition d'action existe sous la forme d'une section au sein d'un fichier de définition de flux de travail plus large. Pour de plus amples informations sur ce fichier, veuillez consulter Définition du flux de travail YAML.

Note

La plupart des propriétés YAML suivantes ont des éléments d'interface utilisateur correspondants dans l'éditeur visuel. Pour rechercher un élément de l'interface utilisateur, utilisez Ctrl+F. L'élément sera répertorié avec sa propriété YAML associée.

# The workflow definition starts here.
# See Propriétés de haut niveau 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

(Obligatoire)

Spécifiez le nom de l'action. Tous les noms d'action doivent être uniques dans le flux de travail. Les noms d'action sont limités aux caractères alphanumériques (a-z, A-Z, 0-9), aux tirets (-) et aux traits de soulignement (_). Les espaces ne sont pas autorisés. Vous ne pouvez pas utiliser de guillemets pour activer les caractères spéciaux et les espaces dans les noms d'action.

Par défaut: DeployToKubernetesCluster_nn.

Interface utilisateur correspondante : onglet Configuration/nom d'affichage de l'action

Identifier

(DeployToKubernetesCluster/Identifier)

(Obligatoire)

Identifie l'action. Ne modifiez pas cette propriété, sauf si vous souhaitez modifier la version. Pour plus d’informations, consultez Spécifier la version majeure, mineure ou corrective d'une action.

Par défaut: aws/kubernetes-deploy@v1.

Interface utilisateur correspondante : diagramme de flux de travail/ DeployToKubernetesCluster _nn/ aws/kubernetes-deploy @v1 label

DependsOn

(DeployToKubernetesCluster/DependsOn)

(Facultatif)

Spécifiez une action, un groupe d'actions ou une porte qui doit s'exécuter correctement pour que cette action soit exécutée.

Pour plus d'informations sur la fonctionnalité « dépend », consultez. Configuration des actions pour qu'elles dépendent d'autres actions

Interface utilisateur correspondante : onglet Entrées/dépend de - facultatif

Compute

(DeployToKubernetesCluster/Compute)

(Facultatif)

Le moteur informatique utilisé pour exécuter les actions de votre flux de travail. Vous pouvez spécifier le calcul au niveau du flux de travail ou au niveau de l'action, mais pas les deux. Lorsqu'elle est spécifiée au niveau du flux de travail, la configuration de calcul s'applique à toutes les actions définies dans le flux de travail. Au niveau du flux de travail, vous pouvez également exécuter plusieurs actions sur la même instance. Pour plus d’informations, consultez Partage du calcul entre les actions.

Interface utilisateur correspondante : aucune

Type

(DeployToKubernetesCluster/Compute/Type)

(Obligatoire s'Computeil est inclus)

Type de moteur de calcul. Vous pouvez utiliser l'une des valeurs suivantes :

  • EC2 (éditeur visuel) ou EC2 (éditeur YAML)

    Optimisé pour la flexibilité lors des courses d'action.

  • Lambda (éditeur visuel) ou Lambda (éditeur YAML)

    Vitesses de démarrage des actions optimisées.

Pour plus d'informations sur les types de calcul, veuillez consulter Types de calcul.

Interface utilisateur correspondante : onglet Configuration/Avancé - facultatif/Type de calcul

Fleet

(DeployToKubernetesCluster/Compute/Fleet)

(Facultatif)

Spécifiez la machine ou le parc qui exécutera votre flux de travail ou vos actions de flux de travail. Dans le cas des flottes à la demande, lorsqu'une action démarre, le flux de travail fournit les ressources dont il a besoin et les machines sont détruites à la fin de l'action. Exemples de flottes à la demande :Linux.x86-64.Large,Linux.x86-64.XLarge. Pour plus d'informations sur les flottes à la demande, consultezPropriétés de flotte à la demande.

Avec les flottes provisionnées, vous configurez un ensemble de machines dédiées pour exécuter les actions de votre flux de travail. Ces machines restent inactives, prêtes à exécuter des actions immédiatement. Pour plus d'informations sur les flottes provisionnées, consultez. Propriétés du parc provisionné

S'il Fleet est omis, la valeur par défaut estLinux.x86-64.Large.

Interface utilisateur correspondante : onglet Configuration/Avancé - facultatif/Parc de calcul

Timeout

(DeployToKubernetesCluster/Timeout)

(Facultatif)

Spécifiez la durée en minutes (éditeur YAML) ou en heures et minutes (éditeur visuel) pendant laquelle l'action peut être exécutée avant la CodeCatalyst fin de l'action. Le minimum est de 5 minutes et le maximum est décrit dansQuotas pour les workflows. Le délai d'expiration par défaut est le même que le délai d'expiration maximal.

Interface utilisateur correspondante : onglet Configuration/Délai d'expiration - facultatif

Environment

(DeployToKubernetesCluster/Environment)

(Obligatoire)

Spécifiez l' CodeCatalyst environnement à utiliser avec l'action. L'action se connecte au Compte AWS VPC Amazon facultatif spécifié dans l'environnement choisi. L'action utilise le rôle IAM par défaut spécifié dans l'environnement pour se connecter au Compte AWS, et utilise le rôle IAM spécifié dans la connexion Amazon VPC pour se connecter à Amazon VPC.

Note

Si le rôle IAM par défaut ne dispose pas des autorisations requises par l'action, vous pouvez configurer l'action pour utiliser un autre rôle. Pour plus d’informations, consultez Affectation d'un rôle IAM différent à une action.

Pour plus d'informations sur les environnements, reportez-vous Déploiement dans Comptes AWS et avec CodeCatalyst des environnements VPC aux sections etCréation d'un environnement.

Interface utilisateur correspondante : onglet Configuration/Environnement

Name

(DeployToKubernetesCluster/Environment/Name)

(Obligatoire s'Environmentil est inclus)

Spécifiez le nom de l'environnement existant que vous souhaitez associer à l'action.

Interface utilisateur correspondante : onglet Configuration/Environnement

Connections

(DeployToKubernetesCluster/Environment/Connections)

(Facultatif dans les nouvelles versions de l'action ; obligatoire dans les anciennes versions)

Spécifiez la connexion au compte à associer à l'action. Vous pouvez spécifier un maximum d'une connexion à un compte sousEnvironment.

Si vous ne spécifiez pas de connexion au compte :

  • L'action utilise la Compte AWS connexion et le rôle IAM par défaut spécifiés dans l'environnement de la CodeCatalyst console. Pour plus d'informations sur l'ajout d'une connexion à un compte et d'un rôle IAM par défaut dans l'environnement, consultezCréation d'un environnement.

  • Le rôle IAM par défaut doit inclure les politiques et les autorisations requises par l'action. Pour déterminer quelles sont ces politiques et autorisations, consultez la description de la propriété Role dans la documentation de définition YAML de l'action.

Pour plus d'informations sur les connexions aux comptes, consultezPermettre l'accès aux AWS ressources avec Connected Comptes AWS. Pour plus d'informations sur l'ajout d'une connexion de compte à un environnement, consultezCréation d'un environnement.

Interface utilisateur correspondante : l'une des options suivantes, selon la version de l'action :

  • (Versions plus récentes) Onglet configuration/Environnement/Qu'y a-t-il dans mon environnement ? /menu à trois points/ Changer de rôle

  • (Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Connexion AWS au compte

Name

(DeployToKubernetesCluster/Environment/Connections/Name)

(Facultatif)

Spécifiez le nom de la connexion au compte.

Interface utilisateur correspondante : l'une des options suivantes, selon la version de l'action :

  • (Versions plus récentes) Onglet configuration/Environnement/Qu'y a-t-il dans mon environnement ? /menu à trois points/ Changer de rôle

  • (Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Connexion AWS au compte

Role

(DeployToKubernetesCluster/Environment/Connections/Role)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom du rôle IAM auquel l'action de cluster Deploy to Kubernetes utilise pour accéder. AWS Assurez-vous que vous avez ajouté le rôle à votre CodeCatalyst espace et qu'il inclut les politiques suivantes.

Si vous ne spécifiez aucun rôle IAM, l'action utilise le rôle IAM par défaut répertorié dans l'environnement de la console. CodeCatalyst Si vous utilisez le rôle par défaut dans l'environnement, assurez-vous qu'il est conforme aux politiques suivantes.

  • La politique d'autorisation suivante :

    Avertissement

    Limitez les autorisations à celles indiquées dans la politique suivante. L'utilisation d'un rôle doté d'autorisations plus étendues peut présenter un risque de sécurité.

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

    La première fois que le rôle est utilisé, utilisez le caractère générique suivant dans la déclaration de politique de ressources, puis délimitez la politique avec le nom de la ressource une fois celle-ci disponible.

    "Resource": "*"

  • La politique de confiance personnalisée suivante :

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

Assurez-vous que ce rôle est ajouté à :

Astuce

Consultez également Tutoriel : Déploiement d'une application sur Amazon EKS les instructions relatives à l'ajout d'un rôle IAM à une connexion à un compte et ConfigMap.

Note

Vous pouvez utiliser le CodeCatalystWorkflowDevelopmentRole-spaceName rôle avec cette action, si vous le souhaitez. Pour plus d’informations sur ce rôle, consultez Création du CodeCatalystWorkflowDevelopmentRole-spaceNamerôle pour votre compte et votre espace. Sachez que le CodeCatalystWorkflowDevelopmentRole-spaceName rôle dispose d'autorisations d'accès complètes, ce qui peut présenter un risque de sécurité. Nous vous recommandons de n'utiliser ce rôle que dans les didacticiels et les scénarios où la sécurité est moins préoccupante.

Interface utilisateur correspondante : l'une des options suivantes, selon la version de l'action :

  • (Versions plus récentes) Onglet configuration/Environnement/Qu'y a-t-il dans mon environnement ? /menu à trois points/ Changer de rôle

  • (Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Rôle

Inputs

(DeployToKubernetesCluster/Inputs)

(Obligatoire s'Connectionsil est inclus)

La Inputs section définit les données dont ils ont DeployToKubernetesCluster besoin lors de l'exécution d'un flux de travail.

Note

Une seule entrée (source ou artefact) est autorisée par action Deploy to Amazon EKS.

Interface utilisateur correspondante : onglet Entrées

Sources

(DeployToKubernetesCluster/Inputs/Sources)

(Obligatoire si votre fichier manifeste est stocké dans un référentiel source)

Si votre ou vos fichiers manifestes Kubernetes sont stockés dans un référentiel source, spécifiez l'étiquette de ce référentiel source. Actuellement, la seule étiquette prise en charge estWorkflowSource.

Si vos fichiers manifestes ne sont pas contenus dans un référentiel source, ils doivent résider dans un artefact généré par une autre action.

Pour plus d'informations sur les sources, consultez Connexion d'un flux de travail à un référentiel source.

Interface utilisateur correspondante : onglet Entrées/Sources - facultatif

Artifacts - input

(DeployToKubernetesCluster/Inputs/Artifacts)

(Obligatoire si votre fichier manifeste est stocké dans un artefact de sortie d'une action précédente)

Si le ou les fichiers manifestes Kubernetes sont contenus dans un artefact généré par une action précédente, spécifiez cet artefact ici. Si vos fichiers manifestes ne sont pas contenus dans un artefact, ils doivent résider dans votre référentiel source.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage de données entre les actions d'un flux de travail à l'aide d'artefacts.

Interface utilisateur correspondante : onglet Configuration/Artefacts - facultatif

Configuration

(DeployToKubernetesCluster/Configuration)

(Obligatoire)

Section dans laquelle vous pouvez définir les propriétés de configuration de l'action.

Interface utilisateur correspondante : onglet Configuration

Namespace

(DeployToKubernetesCluster/Configuration/Namespace)

(Facultatif)

Spécifiez l'espace de noms Kubernetes dans lequel votre application Kubernetes sera déployée. À utiliser default si vous n'utilisez pas d'espaces de noms avec votre cluster. Pour plus d'informations sur les espaces de noms, consultez la section Subdivision de votre cluster à l'aide des espaces de noms Kubernetes dans la documentation de Kubernetes.

Si vous omettez l'espace de noms, une valeur de default est utilisée.

Interface utilisateur correspondante : onglet Configuration/espace de noms

Region

(DeployToKubernetesCluster/Configuration/Region)

(Obligatoire)

Spécifiez la AWS région dans laquelle se trouvent votre cluster et votre service Amazon EKS. Pour obtenir la liste des codes de région, consultez la section Points de terminaison régionaux dans le Références générales AWS.

Interface utilisateur correspondante : onglet Configuration/région

Cluster

(DeployToKubernetesCluster/Configuration/Cluster)

(Obligatoire)

Spécifiez le nom d'un cluster Amazon EKS existant. L'action Déployer vers le cluster Kubernetes déploiera votre application conteneurisée dans ce cluster. Pour plus d'informations sur les clusters Amazon EKS, consultez la section Clusters du guide de l'utilisateur Amazon EKS.

Interface utilisateur correspondante : onglet Configuration/Cluster

Manifests

(DeployToKubernetesCluster/Configuration/Manifests)

(Obligatoire)

Spécifiez le chemin d'accès à vos fichiers manifestes Kubernetes au format YAML, appelés fichiers de configuration, fichiers de configuration ou simplement configurations dans la documentation de Kubernetes.

Si vous utilisez plusieurs fichiers manifestes, placez-les dans un seul dossier et référencez ce dossier. Les fichiers manifestes sont traités de manière alphanumérique par Kubernetes. Veillez donc à préfixer les noms de fichiers par des chiffres ou des lettres croissants pour contrôler l'ordre de traitement. Par exemple :

00-namespace.yaml

01-deployment.yaml

Si vos fichiers manifestes se trouvent dans votre dépôt source, le chemin est relatif au dossier racine du dépôt source. Si les fichiers se trouvent dans un artefact issu d'une action de flux de travail précédente, le chemin est relatif au dossier racine de l'artefact.

Exemples :

Manifests/

deployment.yaml

my-deployment.yml

N'utilisez pas de caractères génériques (*).

Note

Les diagrammes Helm et les fichiers de personnalisation ne sont pas pris en charge.

Pour plus d'informations sur les fichiers manifestes, consultez la section Organisation des configurations de ressources dans la documentation de Kubernetes.

Interface utilisateur correspondante : onglet Configuration/Manifestes