Créez et ajoutez une action personnalisée dans CodePipeline

Pour créer une action personnalisée à l'aide du AWS CLI

1. Ouvrez un éditeur de texte et créez un JSON fichier pour votre action personnalisée qui inclut la catégorie d'action, le fournisseur d'actions et tous les paramètres requis par votre action personnalisée. Par exemple, pour créer une action de génération personnalisée ne nécessitant qu'une seule propriété, votre JSON fichier peut ressembler à ceci :

   {
       "category": "Build",
       "provider": "My-Build-Provider-Name",
       "version": "1",
       "settings": {
           "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
           "executionUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
       },
       "configurationProperties": [{
           "name": "ProjectName",
           "required": true,
           "key": true,
           "secret": false,
           "queryable": false,
           "description": "The name of the build project must be provided when this action is added to the pipeline.",
           "type": "String"
       }],
       "inputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "outputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "tags": [{
         "key": "Project",
         "value": "ProjectA"
       }]
   }

   Cet exemple ajoute le balisage à l'action personnalisée en incluant la clé de balise Project et la valeur ProjectA sur l'action personnalisée. Pour plus d'informations sur le balisage des ressources CodePipeline, consultezBalisage des ressources.

   Deux propriétés sont incluses dans le JSON fichier, entityUrlTemplate etexecutionUrlTemplate. Vous pouvez faire référence à un nom dans les propriétés de configuration de l'action personnalisée dans les URL modèles en suivant le format{Config:name}, à condition que la propriété de configuration soit à la fois obligatoire et non secrète. Par exemple, dans l'exemple ci-dessus, la entityUrlTemplate valeur fait référence à la propriété de configuration ProjectName.

   • entityUrlTemplate : le lien statique qui fournit des informations sur le fournisseur de services pour l'action. Dans cet exemple, le système de génération comprend un lien statique pour chaque projet de génération. Le format du lien varie en fonction de votre fournisseur de génération (ou, si vous créez un type d'action différent, comme un test, l'autre fournisseur de services). Vous devez fournir ce format de lien de sorte à ce que lorsque l'action personnalisée est ajoutée, l'utilisateur puisse choisir ce lien pour ouvrir un navigateur sur une page de votre site web qui fournit les détails concernant le projet de génération (ou l'environnement de test).

   • executionUrlTemplate : le lien dynamique qui sera mis à jour avec des informations sur l'exécution actuelle ou la plus récente de l'action. Lorsque votre assistant de tâches personnalisé met à jour l'état d'une tâche (par exemple, réussite, échec, ou en cours), il fournit également un externalExecutionId qui sera utilisé pour finaliser le lien. Ce lien peut être utilisé pour fournir les détails relatifs à l'exécution d'une action.

   Par exemple, lorsque vous consultez l'action dans le pipeline, vous voyez les deux liens suivants :

   

   Ce lien statique s'affiche lorsque vous avez ajouté votre action personnalisée et pointe vers l'adresse dans entityUrlTemplate, que vous spécifiez lorsque vous créez votre action personnalisée.

   Ce lien dynamique est mis à jour après chaque exécution de l'action et pointe vers l'adresse dans executionUrlTemplate, que vous spécifiez lorsque vous créez votre action personnalisée.

   Pour plus d'informations sur ces types de liens, ainsi que sur RevisionURLTemplate etThirdPartyURL, voir ActionTypeSettingset CreateCustomActionTypedans la CodePipeline APIréférence. Pour plus d'informations sur les exigences en termes de structure de l'action et sur la manière de créer une action, consultez CodePipeline référence de structure de pipeline.

2. Enregistrez le JSON fichier et donnez-lui un nom facilement mémorisable (par exemple, MyCustomAction.json).

3. Ouvrez une session de terminal (Linux, OS X, Unix) ou une invite de commande (Windows) sur un ordinateur où vous avez installé l' AWS CLI.

4. Utilisez le AWS CLI pour exécuter la aws codepipeline create-custom-action-type commande, en spécifiant le nom du JSON fichier que vous venez de créer.

   Par exemple, pour créer une action personnalisée :

   Important

   N'oubliez pas d'inclure file:// devant le nom du fichier. Il est nécessaire dans cette commande.

   aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json

5. Cette commande affiche l'intégralité de la structure de l'action personnalisée que vous avez créée, ainsi que la JobList propriété de la configuration de l'action, qui est ajoutée automatiquement. Lorsque vous ajoutez l'action personnalisée à un pipeline, vous pouvez utiliser JobList pour spécifier les projets du fournisseur, que vous pouvez solliciter pour les tâches. Si vous ne configurez pas ce réglage, toutes les tâches disponibles s'afficheront lorsque vous rechercherez des tâches avec l'exécutant de tâches personnalisé.

   Par exemple, la commande précédente peut afficher une structure similaire à ce qui suit :

   {
       "actionType": {
           "inputArtifactDetails": {               
               "maximumCount": 1,                
               "minimumCount": 1
          },
          "actionConfigurationProperties": [
               {
                   "secret": false,
                   "required": true,
                   "name": "ProjectName",
                   "key": true,
                   "description": "The name of the build project must be provided when this action is added to the pipeline."
               }
           ],
           "outputArtifactDetails": {               
               "maximumCount": 0,                
               "minimumCount": 0
           },
           "id": {
               "category": "Build",
               "owner": "Custom",
               "version": "1",
               "provider": "My-Build-Provider-Name"
           },
           "settings": {
               "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
               "executionUrlTemplate": "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild/{ExternalExecutionId}/"
           }
       }
   }

   Note

   Dans le cadre de la sortie de la create-custom-action-type commande, la id section inclut"owner": "Custom". CodePipeline désigne automatiquement Custom en tant que propriétaire des types d'actions personnalisés. Cette valeur ne peut pas être attribuée ou modifiée lorsque vous utilisez la commande create-custom-action-type ou la commande update-pipeline.

Pour configurer des EC2 instances Amazon

1. Apprenez-en davantage sur Amazon EC2 et déterminez s'il s'agit du bon choix pour votre intégration. Pour plus d'informations, consultez Amazon EC2 - Hébergement de serveurs virtuels.

2. Commencez à créer vos EC2 instances Amazon. Pour plus d'informations, consultez Getting Started with Amazon EC2 Linux Instances.

Mise en place de la fédération d'identité

1. En savoir plus sur la fédération d'identité IAM. Pour plus d'informations, consultez Gestion de fédération.

2. Passez en revue les exemples fournis dans Scénarios d'attribution d'accès temporaire afin d'identifier le scénario d'accès temporaire qui correspond le mieux aux besoins de votre action personnalisée.

3. Passez en revue les exemples de code de fédération d'identité appropriés à votre infrastructure, tels que :

   • Exemple d'application de fédération d'identité pour un cas d'utilisation d'Active Directory

4. Commencez à configurer la fédération d'identité. Pour plus d'informations, consultez la section Fournisseurs d'identité et fédération dans le guide de IAM l'utilisateur.

1. Ouvrez une session de terminal (Linux, macOS ou Unix) ou une invite de commande (Windows) et exécutez la get-pipeline commande pour copier la structure de pipeline que vous souhaitez modifier dans un JSON fichier. Par exemple, pour un pipeline nommé MyFirstPipeline, saisissez la commande suivante :

   aws codepipeline get-pipeline --name MyFirstPipeline >pipeline.json

   Cette commande ne renvoie rien, mais le fichier que vous avez créé doit apparaître dans le répertoire où vous avez exécuté la commande.

2. Ouvrez le JSON fichier dans n'importe quel éditeur de texte et modifiez la structure du fichier pour ajouter votre action personnalisée à une étape existante.

   Note

   Si vous souhaitez que votre action soit exécutée en parallèle d'une autre action de l'étape, assurez-vous que vous lui attribuez la même valeur runOrder que cette action.

   Par exemple, pour modifier la structure d'un pipeline afin d'ajouter une étape nommée Build et pour ajouter une action personnalisée de génération à cette étape, vous pouvez modifier la JSON pour ajouter l'étape Build avant une étape de déploiement comme suit :

   ,
       {
         "name": "MyBuildStage",
         "actions":  [
                 {
                   "inputArtifacts": [
                   {
                      "name": "MyApp"
                    }
                      ],
                       "name": "MyBuildCustomAction",
                       "actionTypeId": {
                           "category": "Build",
                           "owner": "Custom",
                           "version": "1",
                           "provider": "My-Build-Provider-Name"
                       },
                       "outputArtifacts": [
                           {
                             "name": "MyBuiltApp"
                           }
                       ],
                       "configuration": {
                           "ProjectName": "MyBuildProject"
                       },
                       "runOrder": 1
                   }
               ]
           },      
           {
               "name": "Staging",
               "actions": [
                       {
                           "inputArtifacts": [
                               {
                                   "name": "MyBuiltApp"
                               }
                           ],
                           "name": "Deploy-CodeDeploy-Application",
                           "actionTypeId": {
                               "category": "Deploy",
                               "owner": "AWS",
                               "version": "1",
                               "provider": "CodeDeploy"
                           },
                           "outputArtifacts": [],
                           "configuration": {
                               "ApplicationName": "CodePipelineDemoApplication",
                               "DeploymentGroupName": "CodePipelineDemoFleet"
                           },
                           "runOrder": 1
                       }
                   ]
                }      
       ]
   }

3. Pour appliquer vos modifications, exécutez la update-pipeline commande en spécifiant le JSON fichier de pipeline, comme suit :

   Important

   N'oubliez pas d'inclure file:// devant le nom du fichier. Il est nécessaire dans cette commande.

   aws codepipeline update-pipeline --cli-input-json file://pipeline.json

   Cette commande affiche toute la structure du pipeline mise à jour.

4. Ouvrez la CodePipeline console et choisissez le nom du pipeline que vous venez de modifier.

   Le pipeline affiche vos modifications. La prochaine fois que vous apporterez une modification à l'emplacement source, le pipeline exécutera cette modification via sa structure révisée.