View a markdown version of this page

Référence pour les fichiers de définitions d'image - AWS CodePipeline

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.

Référence pour les fichiers de définitions d'image

Cette section est fournie à des fins de référence uniquement. Pour de plus amples informations sur la création d'un pipeline avec des actions source ou de déploiement pour les conteneurs, veuillez consulter Créez un pipeline, des étapes et des actions.

AWS CodePipeline les collaborateurs chargés des actions de conteneur, telles qu'une action source Amazon ECR ou des actions de déploiement Amazon ECS, utilisent des fichiers de définitions pour mapper l'URI de l'image et le nom du conteneur à la définition de la tâche. Chaque fichier de définitions est un JSON-formatted fichier utilisé par le fournisseur d'actions comme suit :

fichier imagedefinitions.json pour les actions de déploiement standard d'Amazon ECS

Un document de définitions d'images est un fichier JSON qui décrit le nom de votre conteneur Amazon ECS, ainsi que l'image et la balise. Si vous déployez des applications basées sur des conteneurs, vous devez générer un fichier de définitions d'images pour fournir au collaborateur CodePipeline le conteneur Amazon ECS et l'identification de l'image à récupérer dans le référentiel d'images, tel qu'Amazon ECR.

Note

Le nom de fichier par défaut pour le fichier est imagedefinitions.json. Si vous choisissez d'utiliser un autre nom de fichier, vous devez l'indiquer lorsque vous créez la phase de déploiement du pipeline.

Créez le fichier imagedefinitions.json en respectant les considérations suivantes :

  • Le fichier doit utiliser un UTF-8 encodage.

  • La taille maximum du fichier de définitions d'image est de 100 Ko.

  • Vous devez créer le fichier en tant que source ou artefact de génération afin qu'il soit un artefact d'entrée pour l'action de déploiement. En d'autres termes, assurez-vous que le fichier est soit téléchargé vers votre emplacement source, tel que votre CodeCommit référentiel, soit généré en tant qu'artefact de sortie intégré.

Le fichier imagedefinitions.json fournit le nom du conteneur et l'URI de l'image. Il doit être construit avec l'ensemble de paires clé-valeur suivant.

Clé Valeur
name container_name
imageUri imageUri
Note

Le champ name est utilisé pour le nom de l'image du conteneur, c'est-à-dire le nom de l'image Docker.

Voici la structure JSON, dans laquelle le nom du conteneur est sample-app, l'URI d'image est ecs-repo et la balise est latest :

[ { "name": "sample-app", "imageUri": "11111EXAMPLE.dkr.ecr.us-west-2.amazonaws.com/ecs-repo:latest" } ]

Vous pouvez également construire le fichier de manière à répertorier plusieurs paires image-conteneur.

Structure JSON :

[ { "name": "simple-app", "imageUri": "httpd:2.4" }, { "name": "simple-app-1", "imageUri": "mysql" }, { "name": "simple-app-2", "imageUri": "java1.8" } ]

Avant de créer votre pipeline, suivez les étapes suivantes pour configurer le fichier imagedefinitions.json.

  1. Dans le cadre de la planification du déploiement d'application basé sur conteneur pour votre pipeline, planifiez l'étape source et l'étape de build, le cas échéant.

  2. Sélectionnez l’une des méthodes suivantes :

    1. Si votre pipeline est créé de telle sorte qu'il ignore l'étape de génération, vous devez créer manuellement le fichier JSON et le télécharger dans votre référentiel source afin que l'action source puisse fournir l'artefact. Créez le fichier à l'aide de l'éditeur de texte et nommez-le ou utilisez le nom de fichier imagedefinitions.json par défaut. Disposez le fichier de définitions d'image dans votre référentiel source.

      Note

      Si votre référentiel source est un compartiment Amazon S3, pensez à compresser le fichier JSON.

    2. Si votre pipeline comporte une phase de construction, ajoutez une commande à votre fichier buildspec qui affiche le fichier de définitions d'images dans votre référentiel source pendant la phase de génération. L'exemple suivant utilise la commande printf pour créer un fichier imagedefinitions.json. Répertoriez cette commande dans la section post_build du fichier buildspec.yml :

      printf '[{"name":"container_name","imageUri":"image_URI"}]' > imagedefinitions.json

      Vous devez inclure le fichier de définitions d'image en tant qu'artefact de sortie dans le fichier buildspec.yml.

  3. Lors de la création de votre pipeline dans la console, vous devez saisir le nom du fichier de définitions d'image dans le champ Nom du fichier image de la page Déploiement de l'assistant Créer un pipeline.

Pour un didacticiel étape par étape sur la création d'un pipeline utilisant Amazon ECS comme fournisseur de déploiement, consultez Tutoriel : Déploiement continu avec CodePipeline.

Detail.json fichier image pour les actions de blue/green déploiement d'Amazon ECS

Un imageDetail.json document est un fichier JSON qui décrit l'URI de votre image Amazon ECS. Si vous déployez des applications basées sur des conteneurs pour un blue/green déploiement, vous devez générer le imageDetail.json fichier pour fournir à Amazon ECS et à l'assistant CodeDeploy technique l'identification de l'image à récupérer dans le référentiel d'images, tel qu'Amazon ECR.

Note

Le nom du fichier doit être imageDetail.json.

Pour une description de l'action et de ses paramètres, consultezAmazon Elastic Container Service et référence des actions de déploiement CodeDeploy bleu-vert.

Vous devez créer le fichier imageDetail.json en tant que source ou artefact de génération afin qu'il soit un artefact d'entrée pour l'action de déploiement. Vous pouvez utiliser l'une de ces méthodes pour fournir le fichier imageDetail.json dans le pipeline :

  • Incluez le imageDetail.json fichier dans votre emplacement source afin qu'il soit inclus dans le pipeline en tant qu'entrée pour votre action de blue/green déploiement Amazon ECS.

    Note

    Si votre référentiel source est un compartiment Amazon S3, pensez à compresser le fichier JSON.

  • Les actions de source Amazon ECR génèrent automatiquement un imageDetail.json fichier en tant qu'artefact d'entrée pour l'action suivante.

    Note

    Étant donné que l'action source Amazon ECR crée ce fichier, les pipelines comportant une action source Amazon ECR n'ont pas besoin de fournir manuellement un imageDetail.json fichier.

    Pour un didacticiel sur la création d'un pipeline qui inclut un stage source Amazon ECR, consultezTutoriel : Création d'un pipeline avec une source et ECS-to-CodeDeploy un déploiement Amazon ECR.

Schéma illustrant le Detail.json fichier image contenu dans le compartiment d'artefacts

Le fichier imageDetail.json fournit l'URI de l'image. Il doit être construit avec la paire clé-valeur suivante.

Clé Valeur
ImageURI image_URI
imageDetail.json

Voici la structure JSON, dans laquelle l'URI de l'image est ACCOUNTID.dkr.ecr.us-west-2.amazonaws.com/dk-image-repo@sha256:example3:

{ "ImageURI": "ACCOUNTID.dkr.ecr.us-west-2.amazonaws.com/dk-image-repo@sha256:example3" }
imageDetail.json (generated by ECR)

Un imageDetail.json fichier est généré automatiquement par l'action source Amazon ECR chaque fois qu'une modification est transmise au référentiel d'images. Les actions source imageDetail.json générées par Amazon ECR sont fournies sous forme d'artefact de sortie entre l'action source et l'action suivante dans le pipeline.

Voici la structure JSON, dans laquelle le nom du référentiel est dk-image-repo, l'URI de l'image est ecs-repo et la balise de l'image est latest :

{ "ImageSizeInBytes": "44728918", "ImageDigest": "sha256:EXAMPLE11223344556677889900bfea42ea2d3b8a1ee8329ba7e68694950afd3", "Version": "1.0", "ImagePushedAt": "Mon Jan 21 20:04:00 UTC 2019", "RegistryId": "EXAMPLE12233", "RepositoryName": "dk-image-repo", "ImageURI": "ACCOUNTID.dkr.ecr.us-west-2.amazonaws.com/dk-image-repo@sha256:example3", "ImageTags": [ "latest" ] }

Le imageDetail.json fichier associe l'URI de l'image et le nom du conteneur à la définition de tâche Amazon ECS comme suit :

  • ImageSizeInBytes : taille, en octets, de l'image dans le référentiel.

  • ImageDigest : hachage sha256 du manifeste de l'image.

  • Version : version de l'image.

  • ImagePushedAt : date et heure de la transmission de la dernière image dans le référentiel.

  • RegistryId: ID de AWS compte associé au registre qui contient le référentiel.

  • RepositoryName: nom du référentiel Amazon ECR dans lequel l'image a été envoyée.

  • ImageURI : URI de l'image.

  • ImageTags : balise utilisée pour l'image.

Avant de créer votre pipeline, suivez les étapes suivantes pour configurer le fichier imageDetail.json.

  1. Dans le cadre de la planification du blue/green déploiement d'applications basées sur des conteneurs pour votre pipeline, planifiez la phase source et la phase de génération, le cas échéant.

  2. Sélectionnez l’une des méthodes suivantes :

    1. Si votre pipeline a ignoré l'étape de création, vous devez créer manuellement le fichier JSON et le télécharger dans votre référentiel source, par exemple CodeCommit, afin que l'action source puisse fournir l'artefact. Créez le fichier à l'aide de l'éditeur de texte et nommez-le ou utilisez le nom de fichier imageDetail.json par défaut. Procédez à la transmission du fichier imageDetail.json dans votre référentiel source.

    2. Si votre pipeline comporte une étape de génération, procédez comme suit :

      1. Ajoutez une commande à votre fichier buildspec qui affiche le fichier de définitions d'image dans votre référentiel source pendant la phase de génération. L'exemple suivant utilise la commande printf pour créer un fichier imageDetail.json. Répertoriez cette commande dans la section post_build du fichier buildspec.yml :

        printf '{"ImageURI":"image_URI"}' > imageDetail.json

        Vous devez inclure le fichier imageDetail.json en tant qu'artefact de sortie dans le fichier buildspec.yml.

      2. Ajoutez le fichier imageDetail.json en tant qu'artefact dans le fichier buildspec.yml.

        artifacts: files: - imageDetail.json