Didacticiel : Création d'un pipeline à quatre étapes

Pour cloner l'échantillon et le transférer vers un GitHub référentiel

1. Téléchargez l'exemple de code depuis le GitHub référentiel ou clonez les référentiels sur votre ordinateur local. Il y a deux modèles de modules :

   • Si vous comptez déployer votre échantillon sur des instances Amazon Linux, RHEL ou Ubuntu Server, choisissez codepipeline-jenkins-aws-codedeploy_linux.zip.

   • Si vous comptez déployer votre échantillon sur des instances Windows Server, choisissez CodePipeline-Jenkins- AWSCodeDeploy_Windows .zip.

2. Dans le référentiel, choisissez Fork pour cloner le modèle de référentiel dans un référentiel de votre compte Github. Pour plus d’informations, consultez la documentation GitHub.

1. Connectez-vous à la console IAM AWS Management Console et ouvrez-la à https://console.aws.amazon.com/iam/l'adresse.

2. Dans le panneau de navigation de la console IAM, choisissez Rôles, puis Créer un rôle.

3. Sous Select type of trusted entity (Sélectionner le type d'entité approuvée), choisissez Service AWS. Sous Choose the service that will use this role (Choisir le service qui utilisera ce rôle), choisissez EC2. Sous Sélectionnez votre cas d'utilisation, choisissez EC2.

4. Choisissez Suivant : Autorisations. Sur la page Attach permissions policies (Attacher des stratégies d'autorisations), sélectionnez la stratégie gérée AWSCodePipelineCustomActionAccess, puis choisissez Next: Tags (Suivant : balises). Choisissez Suivant : Vérification.

5. Dans la page Vérification, dans Nom du rôle, entrez le nom du rôle à créer spécifiquement pour l'intégration Jenkins (par exemple, JenkinsAccess), puis choisissez Créer un rôle.

Pour installer Jenkins et le CodePipeline plugin pour Jenkins

1. Créez une EC2 instance dans laquelle vous installerez Jenkins, et dans Étape 3 : Configuration des détails de l'instance, assurez-vous de choisir le rôle d'instance que vous avez créé (par exemple,JenkinsAccess). Pour plus d'informations sur la création d' EC2instances, consultez Lancer une EC2 instance Amazon dans le guide de EC2 l'utilisateur Amazon.

   Note

   Si vous souhaitez déjà utiliser des ressources Jenkins, vous pouvez le faire, mais vous devez créer un utilisateur IAM spécial, appliquer la politique AWSCodePipelineCustomActionAccess gérée à cet utilisateur, puis configurer et utiliser les informations d'identification d'accès de cet utilisateur sur votre ressource Jenkins. Si vous souhaitez que l'interface utilisateur Jenkins fournisse les informations d'identification, configurez Jenkins de sorte à uniquement autoriser les connexions HTTPS. Pour de plus amples informations, veuillez consulter Résolution des problèmes CodePipeline.

2. Installez Jenkins sur l' EC2 instance. Pour plus d'informations, consultez la documentation de Jenkins relative à l’installation de Jenkins et à la mise en route et à l’accès à Jenkins, ainsi que details of integration with Jenkins dans Intégrations de produits et de services avec CodePipeline.

3. Lancez Jenkins et sur la page d'accueil, choisissez Manage Jenkins.

4. Sur la page Manage Jenkins, choisissez Manage Plugins.

5. Choisissez l'onglet Disponible et, dans la zone de recherche Filtre, entrez AWS CodePipeline. Choisissez CodePipeline Plugin for Jenkins dans la liste, puis choisissez Télécharger maintenant et installer après le redémarrage.

6. Sur la page Installing Plugins/Upgrades, sélectionnez Restart Jenkins when installation is complete and no jobs are running.

7. Choisissez Back to Dashboard.

8. Sur la page principale, choisissez New Item.

9. Dans Nom de l'élément, entrez le nom du projet Jenkins (par exemple,MyDemoProject). Choisissez Freestyle project, puis OK.

   Note

   Assurez-vous que le nom de votre projet répond aux exigences relatives à CodePipeline. Pour de plus amples informations, veuillez consulter Quotas dans AWS CodePipeline.

10. Sur la page de configuration du projet, cochez la case Execute concurrent builds if necessary. Dans Gestion du code source, choisissez AWS CodePipeline. Si vous avez installé Jenkins sur une EC2 instance et que vous l'avez configurée AWS CLI avec le profil de l'utilisateur IAM que vous avez créé pour l'intégration entre Jenkins CodePipeline et Jenkins, laissez tous les autres champs vides.

11. Choisissez Avancé, puis dans Fournisseur, entrez le nom du fournisseur de l'action tel qu'il apparaîtra dans CodePipeline (par exemple,MyJenkinsProviderName). Assurez-vous que ce nom est unique et facile à retenir. Vous l'utiliserez lorsque vous ajouterez une action de génération à votre pipeline un peu plus tard dans ce didacticiel, et à nouveau lorsque vous ajouterez une action de test.

    Note

    Le nom de cette action doit respecter les exigences d'attribution de noms pour les actions dans CodePipeline. Pour de plus amples informations, veuillez consulter Quotas dans AWS CodePipeline.

12. Dans Build Triggers, décochez toutes les cases et sélectionnez Poll SCM. Dans Schedule, tapez cinq astérisques séparés par des espaces, comme suit :

    * * * * *

    Ce sondage CodePipeline toutes les minutes.

13. Dans Build, choisissez Add build step. Choisissez Execute shell (Amazon Linux, RHEL ou Ubuntu Server) Exécuter la commande batch (Windows Server), puis entrez ce qui suit :

    rake

    Note

    Assurez-vous que votre environnement est configuré avec les variables et les paramètres requis pour exécuter Rake ; dans le cas contraire, la génération échouera.

14. Choisissez Ajouter une action après la génération, puis choisissez AWS CodePipeline Publisher. Choisissez Add et dans Build Output Locations, laissez l'emplacement vide. Il s'agit de la configuration par défaut. Celle-ci crée un fichier compressé à la fin du processus de génération.

15. Choisissez Save pour enregistrer votre projet Jenkins.

Pour créer un processus de publication CodePipeline automatisé

1. Connectez-vous à la CodePipeline console AWS Management Console et ouvrez-la à l'adresse http://console.aws.amazon. com/codesuite/codepipeline/home.

2. Si nécessaire, utilisez le sélecteur de région pour définir la même région que celle où se trouvent vos ressources de pipeline. Par exemple, si vous avez créé des ressources pour le didacticiel précédent dansus-east-2, assurez-vous que le sélecteur de région est défini sur USA East (Ohio).

   Pour plus d'informations sur les régions et les points de terminaison disponibles CodePipeline, consultez la section AWS CodePipeline Points de terminaison et quotas.

3. Sur la page Bienvenue, la page Démarrez ou la page Pipelines, choisissez Créer un pipeline.

4. Sur la page Étape 1 : Choisir une option de création, sous Options de création, choisissez l'option Créer un pipeline personnalisé. Choisissez Suivant.

5. Sur la page Étape 2 : Choisir les paramètres du pipeline, dans Nom du pipeline, entrez le nom de votre pipeline.

6. CodePipeline fournit des pipelines de type V1 et V2, dont les caractéristiques et le prix diffèrent. Le type V2 est le seul type que vous pouvez choisir dans la console. Pour plus d'informations, consultez la section Types de pipelines. Pour plus d'informations sur la tarification CodePipeline, consultez la section Tarification.

7. Dans Rôle de service, choisissez Nouveau rôle de service pour autoriser CodePipeline la création d'un rôle de service dans IAM.

8. Conservez les valeurs par défaut sous Advanced settings (Paramètres avancés), puis choisissez Suivant.

9. Sur la page Étape 3 : Ajouter une étape source, dans Source provider, sélectionnez GitHub.

10. Sous Connexion, choisissez une connexion existante ou créez-en une nouvelle. Pour créer ou gérer une connexion pour votre action GitHub source, consultezGitHub connexions.

11. À l'étape 4 : Ajouter une phase de construction, choisissez Ajouter Jenkins. Dans Nom du fournisseur, entrez le nom de l'action que vous avez fournie dans le CodePipeline plugin pour Jenkins (par exempleMyJenkinsProviderName). Ce nom doit correspondre exactement au nom du CodePipeline plugin pour Jenkins. Dans URL du serveur, entrez l'URL de l' EC2instance sur laquelle Jenkins est installé. Dans Nom du projet, entrez le nom du projet que vous avez créé dans Jenkins, par exempleMyDemoProject, puis choisissez Next.

12. À l'étape 5 : Ajouter une phase de test, choisissez Ignorer l'étape de test, puis acceptez le message d'avertissement en choisissant à nouveau Ignorer.

    Choisissez Suivant.

13. À l'étape 6 : Ajouter une phase de déploiement, réutilisez l' CodeDeploy application et le groupe de déploiement dans lesquels vous avez crééDidacticiel : Création d'un pipeline simple (compartiment S3). Dans Fournisseur de déploiement, choisissez CodeDeploy. Dans Nom de l'application, entrez CodePipelineDemoApplication, ou choisissez le bouton d'actualisation et choisissez le nom de l'application dans la liste. Dans Groupe de déploiement, entrez CodePipelineDemoFleet ou choisissez-le dans la liste, puis choisissez Suivant.

    Note

    Vous pouvez utiliser vos propres CodeDeploy ressources ou en créer de nouvelles, mais cela peut entraîner des coûts supplémentaires.

14. À l'étape 7 : Passez en revue, passez en revue les informations, puis choisissez Créer un pipeline.

15. Le pipeline démarre automatiquement et exécute le modèle à travers le pipeline. Vous pouvez consulter les messages de progression et de réussite et d'échec au fur et à mesure que le pipeline construit l'exemple Haml au format HTML et le déploie sur une page Web sur chacune des EC2 instances Amazon du CodeDeploy déploiement.

Pour vérifier l'adresse IP d'une instance où vous avez déployé votre code

1. Lorsque l'état du pipeline affiche Succeeded dans la zone d'état de l'étape Intermédiaire, choisissez Details.

2. Dans la section Deployment Details, sous Instance ID, choisissez l'identifiant d'instance de l'une des instances déployées avec succès.

3. Copiez l'adresse IP de l'instance (par exemple,192.168.0.4). Vous utiliserez cette adresse IP dans votre test Jenkins.

Création d'un projet Jenkins

1. Dans l'instance où vous avez installé Jenkins, ouvrez Jenkins et choisissez New Item sur la page d'accueil.

2. Dans Nom de l'élément, entrez le nom du projet Jenkins (par exemple,MyTestProject). Choisissez Freestyle project, puis OK.

   Note

   Assurez-vous que le nom de votre projet répond aux CodePipeline exigences. Pour de plus amples informations, veuillez consulter Quotas dans AWS CodePipeline.

3. Sur la page de configuration du projet, cochez la case Execute concurrent builds if necessary. Dans Gestion du code source, choisissez AWS CodePipeline. Si vous avez installé Jenkins sur une EC2 instance et que vous l'avez configurée AWS CLI avec le profil de l'utilisateur IAM que vous avez créé pour l'intégration entre Jenkins CodePipeline et Jenkins, laissez tous les autres champs vides.

   Important

   Si vous configurez un projet Jenkins et qu'il n'est pas installé sur une EC2 instance Amazon, ou s'il est installé sur une EC2 instance qui exécute un système d'exploitation Windows, complétez les champs requis par les paramètres de votre hôte proxy et de votre port, et fournissez les informations d'identification de l'utilisateur ou du rôle IAM que vous avez configuré pour l'intégration entre Jenkins et. CodePipeline

4. Choisissez Advanced et dans Category, choisissez Test.

5. Dans Fournisseur, entrez le même nom que celui que vous avez utilisé pour le projet de construction (par exemple,MyJenkinsProviderName). Vous utiliserez ce nom lorsque vous ajouterez l'action de test à votre pipeline un peu plus tard dans ce didacticiel.

   Note

   Ce nom doit répondre aux exigences de CodePipeline dénomination des actions. Pour de plus amples informations, veuillez consulter Quotas dans AWS CodePipeline.

6. Dans Build Triggers, décochez toutes les cases et sélectionnez Poll SCM. Dans Schedule, tapez cinq astérisques séparés par des espaces, comme suit :

   * * * * *

   Ce sondage CodePipeline toutes les minutes.

7. Dans Build, choisissez Add build step. Si vous effectuez un déploiement sur des instances Amazon Linux, RHEL ou Ubuntu Server, choisissez Execute shell. Entrez ensuite ce qui suit, où l'adresse IP est l'adresse de l' EC2 instance que vous avez copiée précédemment :

   TEST_IP_ADDRESS=192.168.0.4 rake test

   Si vous effectuez un déploiement sur des instances Windows Server, choisissez Exécuter la commande par lots, puis entrez ce qui suit, où l'adresse IP est l'adresse de l' EC2 instance que vous avez copiée précédemment :

   set TEST_IP_ADDRESS=192.168.0.4 rake test

   Note

   Ce test suppose la présence d'un port 80 par défaut. Si vous souhaitez spécifier un port différent, ajoutez une instruction de port de test, comme suit :

   TEST_IP_ADDRESS=192.168.0.4 TEST_PORT=8000 rake test

8. Choisissez Ajouter une action après la génération, puis choisissez AWS CodePipeline Publisher. Ne choisissez pas Add.

9. Choisissez Save pour enregistrer votre projet Jenkins.

Pour ajouter une étape à votre pipeline qui inclut l'action de test Jenkins

1. Connectez-vous à la CodePipeline console AWS Management Console et ouvrez-la à l'adresse http://console.aws.amazon. com/codesuite/codepipeline/home.

2. Dans Nom, choisissez le nom du pipeline que vous avez créé, MySecondPipeline.

3. Sur la page des détails du pipeline, choisissez Edit.

4. Sur la page Edit (Modifier), choisissez + Stage (+ étape) pour ajouter une étape immédiatement après l'étape de génération.

5. Dans le champ du nom de la nouvelle étape, entrez un nom (par exemple, Testing), puis choisissez + Add action group (+ Ajouter un groupe d'actions).

6. Dans Nom de l'action, entrezMyJenkinsTest-Action. Dans Fournisseur de test, choisissez le nom du fournisseur que vous avez spécifié dans Jenkins (par exemple,MyJenkinsProviderName). Dans Nom du projet, entrez le nom du projet que vous avez créé dans Jenkins (par exemple,MyTestProject). Dans Artefacts d'entrée, choisissez l'artefact de la version Jenkins dont le nom par défaut estBuildArtifact, puis cliquez sur Terminé.

   Note

   Comme l'action de test Jenkins fonctionne sur l'application générée dans l'étape de génération Jenkins, utilisez l'artefact de génération pour l'artefact d'entrée vers l'action de test.

   Pour en savoir plus sur les artéfacts d'entrée et de sortie et sur la structure des pipelines, consultez CodePipeline référence de structure de pipeline.

7. Sur la page Edit choisissez Save pipeline changes. Dans la boîte de dialogue Save pipeline changes, choisissez Save and continue.

8. Bien que la nouvelle étape a été ajoutée à votre pipeline, son état affiche No executions yet pour cette étape, car aucune modification n'a déclenché une autre exécution du pipeline. Pour faire passer l'échantillon dans le pipeline révisé, sur la page des détails du pipeline, choisissez Release change.

   Le pipeline affiche ses étapes et ses actions, ainsi que l'état de la révision en cours d'exécution à travers ces quatre étapes. Le temps nécessaire à l'exécution du pipeline dans toutes les étapes dépendra de la taille des artéfacts, de la complexité de votre génération et des actions de test, en plus d'autres facteurs.

Pour nettoyer les ressources utilisées dans ce didacticiel

1. Ouvrez une session de terminal sur votre machine Linux, macOS ou Unix locale, ou une invite de commande sur votre machine Windows locale, puis exécutez la delete-pipeline commande pour supprimer le pipeline que vous avez créé. Pour MySecondPipeline, entrez la commande suivante :

   aws codepipeline delete-pipeline --name "MySecondPipeline"

   Cette commande ne donne aucun résultat.

2. Pour nettoyer vos CodeDeploy ressources, suivez les instructions de la section Nettoyage.

3. Pour nettoyer les ressources de votre instance, supprimez l' EC2 instance sur laquelle vous avez installé Jenkins. Pour plus d'informations, consultez Nettoyez votre instance.

4. Si vous n'avez pas l'intention de créer d'autres pipelines ou de les CodePipeline réutiliser, supprimez le compartiment Amazon S3 utilisé pour stocker les artefacts de votre pipeline. Pour supprimer le compartiment, veuillez suivre les instructions contenues dans Suppression d'un compartiment.

5. Si vous ne souhaitez pas réutiliser les autres ressources pour ce pipeline, pensez à les supprimer en suivant les instructions propres à chacune d'elles. Par exemple, si vous souhaitez supprimer le GitHub référentiel, suivez les instructions de la section Supprimer un référentiel sur le GitHub site Web.