Tutoriel : Configurer un environnement Jenkins pour activer l’intégration/le déploiement continus (CI/CD) pour une application Java sur Service Fabric

Article
10/15/2024

Ce tutoriel est la cinquième partie de la série. Il vous explique comment utiliser Jenkins pour déployer des mises à niveau pour votre application. Dans ce didacticiel, le plug-in Jenkins Service Fabric est utilisé en association avec un référentiel GitHub hébergeant l’application Voting pour déployer l’application vers un cluster.

Dans ce cinquième volet, vous apprenez à :

Déployer un conteneur Jenkins Service Fabric sur votre ordinateur
Configurer un environnement Jenkins pour le déploiement sur Service Fabric
Mettre à niveau votre application

Cette série de tutoriels vous montre comment effectuer les opérations suivantes :

Générer une application Reliable Services Service Fabric de Java
Déployer et déboguer l’application sur un cluster local
Déployer l’application sur un cluster Azure
Configurer la surveillance et les diagnostics pour l’application
Configurer l’intégration continue/le déploiement continu

Prérequis

Installer Git sur votre ordinateur local à partir de la page de téléchargements de Git. Pour plus d’informations sur Git, consultez la documentation Git.
Avoir une connaissance pratique de Jenkins.
Créer un compte GitHub et savoir comment utiliser GitHub.
Installer Docker sur votre ordinateur.

Extraire et déployer l’image du conteneur Jenkins Service Fabric

Vous pouvez configurer Jenkins à l’intérieur ou en dehors d’un cluster Service Fabric. Les instructions suivantes indiquent comment le configurer en dehors d’un cluster à l’aide d’une image Docker fournie. Toutefois, un environnement de build Jenkins préconfiguré peut également être utilisé. L’image conteneur suivante est installée avec le plug-in Service Fabric, et est prête pour une utilisation immédiate avec Service Fabric.

Notes

L’exemple suivant tire (pull) une image conteneur publique à partir de Docker Hub. Nous vous recommandons de vous authentifier avec votre compte Docker Hub (docker login) au lieu de créer une demande de tirage (pull request) anonyme. Pour une plus grande fiabilité lors de l’utilisation de contenu public, importez et gérez l’image dans un registre de conteneurs Azure privé. En savoir plus sur l’utilisation des images publiques.

Extrayez l’image du conteneur Jenkins de Service Fabric : docker pull rapatchi/jenkins:v10. Cette image est fournie avec le plug-in Jenkins de Service Fabric préinstallé.
Exécutez l’image conteneur avec l’emplacement où se trouvent vos certificats sur votre ordinateur local monté.
```
docker run -itd -p 8080:8080 -v /service-fabric-java-quickstart/AzureCluster rapatchi/jenkins:v10
```
Récupérez l’ID de l’instance d’image du conteneur. Vous pouvez répertorier tous les conteneurs Docker avec la commande docker ps –a
Récupérer le mot de passe de votre instance Jenkins en exécutant la commande suivante :
```
docker exec [first-four-digits-of-container-ID] cat /var/jenkins_home/secrets/initialAdminPassword
```
Si l’ID du conteneur est 2d24a73b5964, utilisez 2d24.
- Ce mot de passe est nécessaire pour vous connecter au tableau de bord Jenkins à partir du portail: http://<HOST-IP>:8080
- Après vous être connecté pour la première fois, vous pouvez créer votre propre compte utilisateur ou utiliser le compte administrateur.
Configurez GitHub pour utiliser Jenkins, en suivant les étapes présentées dans Generating a new SSH key and adding it to the SSH agent (Génération d’une clé SSH et ajout de celle-ci à l’agent SSH). Étant donné que les commandes sont exécutées à partir du conteneur Docker, suivez les instructions pour l’environnement Linux.
- Utilisez les instructions fournies par GitHub pour générer la clé SSH. Ensuite, ajoutez la clé SSH pour le compte GitHub qui héberge le référentiel.
- Exécutez les commandes mentionnées dans le lien ci-dessus dans le shell Jenkins Docker (et non sur l’hôte).
- Pour vous connecter au shell Jenkins depuis votre hôte, utilisez les commandes suivantes :
```
docker exec -t -i [first-four-digits-of-container-ID] /bin/bash
```
  Vérifiez que le cluster ou la machine hébergeant l’image de conteneur Jenkins possède une adresse IP publique. Le fait d’avoir une adresse IP publique permet à l’instance Jenkins de recevoir des notifications de GitHub.

Créer et configurer un travail Jenkins

Tout d’abord, si vous n’avez pas de référentiel pour héberger le projet Voting sur GitHub, créez-en un. Le référentiel est appelé dev_test pour le reste de ce tutoriel.
Créez un élément sur votre tableau de bord Jenkins à l’emplacement http://<HOST-IP>:8080.
Entrez un nom d’élément (par exemple, MyJob). Sélectionnez free-style project (projet libre), puis cliquez sur OK.
Accédez à la page du travail, puis cliquez sur Configurer.

a. Dans la section générale, cochez la case GitHub project (Projet GitHub), puis spécifiez l’URL de votre projet GitHub. Cette URL héberge l’application Java Service Fabric que vous souhaitez intégrer au flux d’intégration continue et de déploiement continu Jenkins (CI/CD) (par exemple, https://github.com/testaccount/dev_test).

b. Sous la section Gestion du code source, sélectionnez Git. Spécifiez l’URL du référentiel qui héberge l’application Java Service Fabric que vous souhaitez intégrer au flux Jenkins CI/CD (par exemple, https://github.com/testaccount/dev_test.git). Vous pouvez également spécifier ici la branche à générer (par exemple, /master).
Configurez votre GitHub (qui héberge le référentiel) afin qu’il soit en mesure de communiquer avec Jenkins. Utiliser les étapes suivantes :

a. Accédez à la page de votre référentiel GitHub. Accédez à Settings>Integrations and Services (Paramètres -> Intégrations et services).

b. Sélectionnez Add Service (Ajouter un service), tapez Jenkins et sélectionnez le plug-in Jenkins-Github.

c. Entrez votre URL du webhook Jenkins (par défaut, il doit être http://<PublicIPorFQDN>:8081/github-webhook/). Cliquez sur Add/Update service (Ajouter/Mettre à jour le service).

d. Un événement de test est envoyé à votre instance Jenkins. Vous devez voir une coche verte à côté du webhook dans GitHub et votre projet est généré.
Dans la section Build Triggers (Générer des déclencheurs), sélectionnez l’option de création souhaitée. Pour cet exemple, vous souhaitez déclencher une génération chaque fois qu’un envoi a lieu vers le référentiel. Vous sélectionnez donc GitHub hook trigger for GITScm polling (Déclencher un hook GitHub pour l’interrogation GITScm).
Sous la section Build (Générer), dans la liste déroulante Add build step (Ajouter une étape de génération), sélectionnez l’option Invoke Gradle Script (Appeler le script Gradle). Dans le widget qui apparaît, ouvrez le menu Avancé, spécifiez le chemin d’accès à Root build script (Script de génération racine) pour votre application. Il récupère le Gradle de la génération à partir du chemin spécifié et fonctionne en conséquence.
Dans la liste déroulante Post-Build Actions (Actions post-génération), sélectionnez Deploy Service Fabric Project (Déployer le projet Service Fabric). Ici, vous devez fournir des détails sur le cluster où l’application Service Fabric compilée par Jenkins est déployée. Le chemin d’accès au certificat est l’emplacement où le volume a été monté (/tmp/myCerts).

Vous pouvez également donner des informations supplémentaires pour déployer l’application. Consultez la capture d’écran ci-dessous pour avoir une idée des informations de l’application :

Notes

Le cluster ici peut être identique à celui qui héberge l’application de conteneur Jenkins dans le cas où vous utilisez Service Fabric pour déployer l’image de conteneur Jenkins.
Cliquez sur Enregistrer.

Mettre à jour votre application existante

Mettez à jour le titre du HTML dans le fichier VotingApplication/VotingWebPkg/Code/wwwroot/index.html en le remplaçant par Service Fabric Voting Sample V2.

<div ng-app="VotingApp" ng-controller="VotingAppController" ng-init="refresh()">
    <div class="container-fluid">
        <div class="row">
            <div class="col-xs-8 col-xs-offset-2 text-center">
                <h2>Service Fabric Voting Sample V2</h2>
            </div>
        </div>
    </div>
</div>

Mettez à jour la version ApplicationTypeVersion et ServiceManifestVersion en les remplaçant par 2.0.0 dans le fichier Voting/VotingApplication/ApplicationManifest.xml.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<ApplicationManifest xmlns="http://schemas.microsoft.com/2011/01/fabric" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" ApplicationTypeName="VotingApplicationType" ApplicationTypeVersion="2.0.0">
  <Description>Voting Application</Description>
  <ServiceManifestImport>
    <ServiceManifestRef ServiceManifestName="VotingWebPkg" ServiceManifestVersion="2.0.0"/>
  </ServiceManifestImport>
  <ServiceManifestImport>
        <ServiceManifestRef ServiceManifestName="VotingDataServicePkg" ServiceManifestVersion="1.0.0"/>
    </ServiceManifestImport>
    <DefaultServices>
      <Service Name="VotingWeb">
         <StatelessService InstanceCount="1" ServiceTypeName="VotingWebType">
            <SingletonPartition/>
         </StatelessService>
      </Service>
   <Service Name="VotingDataService">
            <StatefulService MinReplicaSetSize="3" ServiceTypeName="VotingDataServiceType" TargetReplicaSetSize="3">
                <UniformInt64Partition HighKey="9223372036854775807" LowKey="-9223372036854775808" PartitionCount="1"/>
            </StatefulService>
        </Service>
    </DefaultServices>
</ApplicationManifest>

Mettez à jour le champ Version dans ServiceManifest et le champ Version dans la balise CodePackage du fichier Voting/VotingApplication/VotingWebPkg/ServiceManifest.xml en les remplaçant par 2.0.0.
```
<CodePackage Name="Code" Version="2.0.0">
<EntryPoint>
    <ExeHost>
    <Program>entryPoint.sh</Program>
    </ExeHost>
</EntryPoint>
</CodePackage>
```
Pour initialiser un travail Jenkins qui effectue une mise à niveau de l’application, envoyez (par push) vos nouvelles modifications à votre référentiel GitHub.
Dans Service Fabric Explorer, cliquez sur la liste déroulante Applications. Pour afficher l’état de votre mise à niveau, cliquez sur l’onglet Upgrades in Progress (Mises à niveau en cours).
Si vous accédez à http://<Host-IP>:8080 l’application Voting avec toutes ses fonctionnalités est à présent opérationnelle.

Étapes suivantes

Dans ce didacticiel, vous avez appris à :

Déployer un conteneur Jenkins Service Fabric sur votre ordinateur
Configurer un environnement Jenkins pour le déploiement sur Service Fabric
Mettre à niveau votre application

Consulter d’autres exemples Java

Partager via