Configurer le Jenkins module d’extension

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 4 minutes de lecture

    • Configurez Jenkins pour envoyer des notifications en temps réel pour vos exécutions de pipeline à Vélocité de changement DevOps.

    Avant de commencer

    Rôle requis : administrateur Jenkins

    Procédure

    1. Installez le module d’extension ServiceNow DevOps à partir de Jenkins Marketplace en accédant à Gérer Jenkins > Configuration système > modules d’extension dans votre instance Jenkins.
    2. Recherchez le module d’extension ServiceNow DevOps et sélectionnez-le, puis sélectionnez Installer.

    Configurer manuellement les webhooks pour Jenkins

    Configurez les webhooks dans Jenkins pour envoyer des notifications de synchronisation à l’application Vélocité de changement DevOps .

    Avant de commencer

    Rôle requis : sn_devops.admin ou sn_devops.tool_owner dans Vélocité de changement DevOps, administrateur Jenkins

    Pourquoi et quand exécuter cette tâche

    Vous pouvez ajouter un total de dix configurations ServiceNow DevOps. Par exemple, vous pouvez configurer Jenkins les connexions pour vos instances de développement, de test, de production, etc.

    Si vous effectuez une mise à niveau, vous devez télécharger et installer le dernier module d’extension Jenkins pour activer plusieurs ServiceNow configurations. Après l’installation, votre configuration existante sera conservée et deviendra la configuration par défaut.

    Dans la section Configuration de ServiceNow DevOps dans Jenkins, les valeurs du champ Nom et la combinaison des champs URL d’instance et ID de l’outil d’orchestration doivent être uniques.

    Si vous choisissez de configurer automatiquement un outil à partir de ServiceNow, la configuration existante pour ServiceNow la configuration DevOps sera remplacée dans Jenkins.

    Si Configuration DevOps est installée, vous pourrez uniquement configurer Jenkins manuellement.

    Procédure

    1. Dans Vélocité de changement DevOps, choisissez Configurer manuellement lors de la configuration de l’instance d’outil pour envoyer des données.
      Configurez automatiquement les webhooks.
    2. Sélectionnez Copier dans le champ approprié pour copier la valeur dans le presse-papiers.

      L’étiquette du champ bascule sur Copié, mais vous pouvez copier plusieurs fois.

      Configurez les webhooks manuellement.
    3. Dans Jenkins, accédez à Gérer Jenkins > Configuration système > Gérer les modules d’extension > Configurer le système.
    4. Dans la section Configuration de ServiceNow DevOps, sélectionnez Ajouter.
      Remarque :
      Vous pouvez ajouter plusieurs connexions en sélectionnant Ajouter pour chaque nouvelle configuration.
    5. Configurez le module d’extension en remplissant les champs.

      Lorsqu’elle est activée, Jenkins elle commence à envoyer des événements en tant qu’événements DevOps entrants.

      Remarque :
      Les valeurs sont sensibles à la casse.

      Champs à configurer dans Jenkins.

      Champ Description
      Actif Sélectionnez cette option pour activer la connexion. Par défaut, cette option est sélectionnée lorsque vous sélectionnez Ajouter pour une nouvelle connexion.
      Remarque :
      Toutes les connexions pour lesquelles l’activation est activée envoient des notifications webhook pour l’exécution de votre pipeline. Toutefois, pour l’étape de changement, seule la connexion spécifiée sera prise en compte.
      Par défaut Sélectionnez cette option pour utiliser la connexion par défaut lorsque le nom de la connexion n’est pas transmis dans une étape existante sur un pipeline.
      Remarque :
      Ne pas sélectionner cette option lorsqu’une seule connexion est disponible entraînera une erreur.
      Nom Nom unique de la connexion.
      Remarque :
      La valeur du nom est générée automatiquement lorsque vous configurez automatiquement une connexion à partir de ServiceNow.
      URL de l'instance

      Entrez l’URL de votre instance ServiceNow que vous avez copiée à l’étape 2. Par exemple, https://<votre-instance>.service-now.com.
      ID de l'outil d'orchestration

      Le sys_id de l’outil d’orchestration que vous avez copié à l’étape 2.

      Vous pouvez également copier cette valeur à partir de l’URL Webhook (valeur toolid ) ou l’obtenir directement à l’aide de la commande Copier sys_id de l’enregistrement de l’outil d’orchestration.

      Remarque :
      La combinaison des valeurs de l’URL d’instance et de l’ID de l’outil d’orchestration doit être unique pour chaque connexion.
      ID de l’outil d’artefact

      Le sys_id de l’outil d’artefact.
      Informations d'identification

      Sélectionnez les informations d’identification d’authentification de base que vous souhaitez utiliser pour la connexion à Jenkins.

      1. Pour ajouter des informations d’identification, sélectionnez Ajouter.
      2. Dans le champ Nom d’utilisateur , saisissez les détails de votre utilisateur d’intégration DevOps. Par défaut, il s’agit de devops.integration.user.
      3. Dans le champ Mot de passe , saisissez votre mot de passe d’utilisateur d’intégration DevOps.
      Informations d’identification secrètes

      Sélectionnez le jeton secret que vous avez copié à l’étape 2. Vous pouvez également effectuer les étapes suivantes pour obtenir le jeton secret à partir de l’enregistrement de l’outil.

      1. Copiez le jeton secret de votre Jenkins outil dans Changement DevOps.
        • Espace de travail : accédez à l’enregistrement de l’outil, sélectionnez Configurer et copiez le jeton secret.
        • Interface utilisateur classique : accédez à l’enregistrement de l’outil et sélectionnez Copier le jeton.
      2. Pour ajouter des jetons, sélectionnez Ajouter.
      3. Dans la liste Aimable , sélectionnez Texte secret.
      4. Dans le champ Secret , saisissez le jeton secret généré lors de la création de la connexion de l’outil Jenkins dans DevOps.
      5. Dans le champ ID , saisissez un nom pour le jeton.
      Niveau de journal Le niveau des messages de journal que vous souhaitez stocker dans Jenkins les journaux/ ServiceNow l’enregistreur de journaux.
      Sélectionnez l'une des options suivantes :
      • héritage
      • arrêt
      • severe
      • avertissement
      • info
      • config
      • bien
      • plus fin
      • Meilleurs
      • tous

      Pour plus d’informations sur les niveaux de journal et les enregistreurs de journaux, voir Jenkins niveaux de journal et enregistreurs de journaux
      Forcer la vérification du suivi

      Cochez la case pour effectuer un appel Jenkins d’API REST (POST) pour chaque exécution de pipeline afin de déterminer si le pipeline est suivi ou non.

      Décochez la case pour stocker les détails dans le fichier et arrêter de faire des appels d’API snPipelineInfo.json pour chaque exécution de pipeline.

      Remarque :
      Lorsqu’un pipeline est suivi, toutes les configurations Jenkins actives reçoivent des notifications de tâches.
      Vérification du suivi du pipeline de demande d’extraction

      Cochez cette case pour activer le suivi des pipelines de demande d’extraction.

      Remarque :
      Lorsqu’un pipeline est suivi, toutes les configurations Jenkins actives reçoivent des notifications de tâches.
    6. Sélectionnez Tester la connexion.
      Vérifiez que le message Connexion réussie s’affiche.
      • Si vous avez ajouté des informations d’identification d’authentification de base, une fois la connexion réussie, vous verrez le message suivant : La connexion à l’aide des « informations d’identification » est réussie.
      • Si vous avez ajouté le jeton secret, en cas de connexion réussie, vous verrez le message suivant : La connexion à l’aide des « Informations d’identification secrètes » est réussie.
    7. Sélectionnez Appliquer pour appliquer les modifications, puis sélectionnez Enregistrer.