Intégrer GitHub à Vélocité de changement DevOps — Espace de travail
Connectez-vous à votre GitHub instance à l’aide du playbook de l’espace de travail de changement DevOps pour détecter, configurer et importer des référentiels, des plans et des pipelines.
Avant de commencer
Effectuez les tâches spécifiées dans la Premiers pas avec Vélocité de changement DevOps rubrique.
Rôle requis : sn_devops.admin ou sn_devops.tool_owner
Procédure
-
Accédez à la et utilisez l’une des options suivantes pour ouvrir le Playbook à intégrer GitHub.
Option Étapes Page d'accueil - Sélectionnez Connecter un outil.
- Dans la fenêtre modale Connecter à un outil, sélectionnez l’outil dans la catégorie appropriée (Orchestration, Code, Plan ou Qualité logicielle). Par exemple, si vous souhaitez vous connecter en GitHub tant qu’outil de codage, vous devez sélectionner la catégorie Outils de codage .
Module Applications - Sélectionnez Applications (icône
dans la navigation primaire. - Sélectionnez une application existante ou créez-en une. Pour créer une application, reportez-vous à la section Créer une application : espace de travail.
- Dans le volet Actions recommandées, sélectionnez la carte Connecter un outil .
- Dans la fenêtre modale Connecter à un outil, sélectionnez l’outil dans la catégorie appropriée. Par exemple, si vous souhaitez vous connecter en tant qu’outil GitHub de codage, sélectionnez GitHub dans la catégorie Code .
Module Outils - Sélectionnez Outils (icône
dans la navigation primaire. - Dans la liste des options, sélectionnez la catégorie appropriée. Par exemple, si vous souhaitez vous connecter en GitHub tant qu’outil de codage, vous devez sélectionner la catégorie Codage .
- Sélectionnez Connecter un outil.
- Dans la fenêtre modale Se connecter à un outil, sélectionnez GitHub.
Important :Si vous souhaitez détecter et suivre des objets d’outil tels que des pipelines, des plans ou des référentiels lors de la connexion à l’outil, vous devez connecter votre outil à partir du module Application. -
Dans le champ Nom de l’outil, saisissez un nom pour l’outil.
-
Terminez la connexion et la configuration à l’aide du playbook.
-
Saisissez les informations d’identification.
Authentification de base Entrez le nom d’utilisateur et le mot de passe/jeton d’accès de votre GitHub instance.
OAuth 2.0 avec code d'autorisation Sélectionnez un OAuth 2.0 existant avec un enregistrement d’informations d’identification du code d’autorisation ou créez un OAuth 2.0 avec un enregistrement d’informations d’identification du code d’autorisation. Pour plus d'informations, consultez Créer un enregistrement d’informations d’identification pour GitHub le fournisseur d’application (code d’autorisation).
Remarque :Si vous vous connectez à l’aide d’une application GitHub et que vous rencontrez des problèmes lors de la vérification des autorisations, assurez-vous que le préfixe d’ID client de votre application GitHub est disponible dans la propriété DevOps : spécifieur d’ID client pour l’application GitHub. Pour plus d'informations, consultez Ajouter un ID client à la propriété DevOps.OAuth 2.0 avec jeton Web JSON (JWT) Pour vous connecter à l’aide d’OAuth 2.0 avec un JWT, vous devez d’abord effectuer les opérations suivantes :Une fois les conditions préalables remplies, vous pouvez poursuivre l’activité du playbook de Vélocité de changement DevOps Connexion :- Sélectionnez l’option Utiliser un enregistrement d’informations d’identification JWT existant si vous souhaitez utiliser un enregistrement d’informations d’identification JWT déjà existant. Si cette option n’est pas sélectionnée, les champs permettant de créer un nouvel enregistrement d’informations d’identification JWT s’affichent. Passez à l’étape suivante.
- Dans le champ Certificat JKS , sélectionnez un certificat JKS existant. Il s’agit du nom que vous avez saisi pour identifier de façon unique le fournisseur JWT. Les certificats JKS sont créés à l’aide de commandes shell pour créer un enregistrement sys_certificate.
Pour plus d'informations, consultez Créer une clé de signature JWT pour le GitHub certificat JKS.
- Dans le champ Clé de signature , entrez la clé de signature à affecter à votre certificat JKS. Il s’agit du mot de passe d’exportation saisi lors de la génération du certificat JKS.
- Dans le champ ID de l’application GitHub , sélectionnez l’ID de l’application de votre application GitHub (disponible dans la section À propos de votre configuration d’application GitHub dans GitHub). L’image suivante montre un exemple de la section À propos d’une configuration d’application GitHub à partir de laquelle vous pouvez accéder à l’ID d’application GitHub, à l’ID client et au secret client.
- Dans le champ ID client , sélectionnez l’ID client de votre application GitHub (disponible dans la section À propos de votre configuration d’application GitHub dans GitHub).
- Dans le champ Secret client , sélectionnez le secret client de votre application GitHub (disponible dans la section À propos de votre configuration d’application GitHub dans GitHub).
- Dans le champ URL du jeton , sélectionnez l’emplacement du point de terminaison de jeton que l’instance utilise pour récupérer et actualiser les jetons.
Pour la version cloud, saisissez : https://api.github.com/app/installations/<installation_id>/access_tokens.
Pour la version d’entreprise, saisissez : https://<HOST_URL>/api/v3/app/installations/<installation_id>/access_tokens.
Pour l’ID d’installation, accédez à la section Installer l’application dans votre configuration d’application GitHub dans GitHub et sélectionnez l’icône d’engrenage pour configurer votre application. L’ID d’installation se trouve dans l’URL de la page Web. Par exemple, https://github.com/settings/installations/<installation_id>.
Si les informations d’identification OAuth sont créées à l’aide de GitHub Apps - JWT, l’option Configurer avec l’application GitHub est disponible sur la page d’enregistrement de l’outil.
Remarque :Si vous vous connectez à l’aide d’une application GitHub et que vous rencontrez des problèmes lors de la vérification des autorisations, assurez-vous que le préfixe d’ID client de votre application GitHub est disponible dans la propriété DevOps : spécifieur d’ID client pour l’application GitHub. Pour plus d'informations, consultez Ajouter un ID client à la propriété DevOps.Pour plus d’informations sur les informations d’identification OAuth2.0, reportez-vous à la section Configuration des informations d’identification GitHub OAuth 2.0 pour Vélocité de changement DevOps.
-
Sélectionnez Connexion.
-
Sélectionnez Suivant.
-
Saisissez les informations d’identification.
-
Spécifiez l’accès pour l’outil.
- Si vous souhaitez contrôler l’accès à l’outil, ajoutez les groupes qui doivent avoir accès à l’outil dans le champ Géré par .Les tâches que ces utilisateurs dans les groupes peuvent effectuer dépendent du rôle qui leur est affecté.
- DevOps Rôle du propriétaire de l’outil : peut afficher et modifier l’outil.
- DevOps Rôle du propriétaire de l’application : peut afficher l’outil et peut associer, détecter, importer des données historiques et modifier les étapes de pipeline (le cas échéant) des objets de l’outil (tels que les plans, les référentiels et les pipelines).
- DevOps Rôle d’administrateur : peut modifier tous les outils.
- Autres DevOps rôles : Peut afficher l’outil.
Remarque :Si vous ne sélectionnez pas de groupe et ignorez cette étape, tous les utilisateurs ayant le rôle Propriétaire de l’outil DevOps pourront modifier l’outil. - Si vous choisissez de contrôler l’accès à l’outil, l’option Tous les propriétaires d’applications peuvent afficher et associer des objets d’outil aux applications devient disponible pour la sélection.
Cette option permet à tous les utilisateurs ayant le rôle de propriétaire d’application DevOps d’accéder à l’outil. S’ils sont sélectionnés, ils pourront afficher, associer, découvrir, importer des données historiques et modifier les étapes du pipeline (le cas échéant) des objets de l’outil.
- Sélectionnez Affecter.
- Si vous souhaitez contrôler l’accès à l’outil, ajoutez les groupes qui doivent avoir accès à l’outil dans le champ Géré par .
-
Configurez automatiquement les webhooks dans votre GitHub instance pour envoyer des données à Vélocité de changement DevOps.
Cette action configure les webhooks suivants :
- push: pour collecter les validations, les branches et les balises du référentiel
- workflow_job: pour collecter les données du pipeline
- issues: pour collecter les données des problèmes (élément de travail)
Remarque :Il est recommandé de terminer la configuration dans le cadre de cette tâche, car les notifications en temps réel sont idéales pour maintenir les informations à jour, en particulier pour automatiser les demandes de changement. Sinon, vous pouvez configurer le webhook en le configurant manuellement ultérieurement en activant l’interrogation nocturne pour extraire le système de données pour tous les référentiels ou pipelines suivis en définissant la Enable Polling propriété sur Oui.Sélectionnez les référentiels pour lesquels vous souhaitez configurer des webhooks, puis sélectionnez Configurer.
Pour effectuer une configuration manuelle, sélectionnez Configurer manuellement. Consultez Configurer manuellement les webhooks GitHub pour plus d'informations.
Important :- Si vous vous connectez à partir de la page d’accueil ou du module Outils, la connexion est terminée et vous êtes redirigé vers la page Résumé.
- Si vous vous connectez à partir du module Applications, les référentiels et les pipelines disponibles sont détectés. Vous pouvez suivre et importer des données historiques à partir de ces données.
-
Sélectionnez les plans à suivre.
Sélectionnez les plans pour lesquels vous souhaitez suivre les mises à jour et associez-les à l’application.
Une fois l’intégration de l’outil terminée, les éléments de travail uniquement pour ces plans sélectionnés sont automatiquement importés.
Sélectionnez Suivant.
-
Sélectionnez les référentiels à suivre.
- Sélectionnez les référentiels pour lesquels vous souhaitez suivre les mises à jour et associez-les à l’application.
Sélectionnez Suivant.
Si vous souhaitez importer des données de référentiel, sélectionnez la plage de dates, puis sélectionnez Soumettre.
Vous pouvez importer jusqu’à 90 jours de données. Les workflows associés aux référentiels seront également importés.
-
Sélectionnez les pipelines à suivre.
Sélectionnez les pipelines pour lesquels vous souhaitez suivre les mises à jour et associez-les à l’application.
Sélectionnez Suivant.
- Pour chaque pipeline sélectionné, toutes les étapes ou étapes sont importées pour la dernière exécution réussie. Dans l’activité Affecter des services à des étapes de pipeline, vous pouvez sélectionner les éléments suivants pour chaque étape de pipeline :
Type d’étape du pipeline : sélectionnez un type d’étape pour lequel vous souhaitez affecter un service.
Conseil :Spécifiez au moins le type d’étape Prod deploy des étapes qui représente le déploiement de production à activer DevOps pour identifier les exécutions de pipeline correctes en tant que déploiements de production.Service : sélectionnez le service d’application CMDB auquel l’étape de pipeline est mappée.
Le service d’application est mappé approximativement à l’environnement. Si vous utilisez la même étape de pipeline pour le déploiement dans différents environnements, laissez le champ vide. Les informations de service permettent DevOps d’identifier et de signaler des mesures opérationnelles telles que les incidents, les pannes, et ainsi de suite.
Sélectionnez Suivant.
-
Dans la page Résumé , sélectionnez Afficher l’enregistrement de l’outil pour examiner les détails de l’outil connecté GitHub .
Pour GitHub Actions les pipelines, vous devez effectuer des étapes supplémentaires telles que la création de secrets, la définition de la configuration du workflow dans GitHub, etc. Pour plus d'informations, consultez Configurations GitHub Actions.
Résultats
Vous avez intégré votre GitHub outil avec succès à Vélocité de changement DevOps.
Que faire ensuite
Vous pouvez également détecter manuellement les plans une fois votre outil GitHub intégré. Comme il n’existe aucune entité de plan dans GitHub, les référentiels seront pris en compte pour détecter les enregistrements de plan correspondants dans ServiceNow.
- Sur la page d’enregistrement de l’outil, sélectionnez Détecter pour détecter des plans.
- Sélectionnez Configurer. Les plans sont suivis et un webhook est créé issues pour envoyer des notifications en temps réel pour les éléments de travail.
- Changement dans le titre du problème
- Mise à jour des délégataires
- Problème de transfertRemarque :Lorsqu’un problème est transféré, il sera marqué comme transféré dans le référentiel à partir duquel il est transféré et ouvert dans le référentiel vers lequel il est transféré.
- Supprimer le problèmeRemarque :Lorsqu’un problème est supprimé dans GitHub, l’élément de travail correspondant n’est pas supprimé dans ServiceNow, mais l’état de l’élément de travail est marqué comme supprimé.
Si vous effectuez une mise à niveau, les plans seront découverts pour vos référentiels via la tâche planifiée pour une détection périodique ou via une détection manuelle. Une fois vos plans détectés, vous pouvez activer la sn_devops.track.github.issues propriété pour reconfigurer tous les référentiels précédemment configurés à la fois afin que tous les plans soient suivis et que le webhook des problèmes soit créé pour les éléments de travail.