Application Real-Time Monitoring Service:Utiliser OAuth pour intégrer Jira à ARMS

Étape 1 : Configurer Jira

1. Exécutez les commandes OpenSSL suivantes dans l'interface de ligne de commande (CLI) pour générer une clé publique Rivest–Shamir–Adleman (RSA) et une clé privée RSA.

   Remarque

   Vous pouvez exécuter ces commandes depuis n'importe quel répertoire. Les fichiers générés sont enregistrés dans le répertoire actuel.

   1. Générez une clé privée de 1024 bits :

      openssl genrsa -out jira_privatekey.pem 1024

   2. Créez un certificat X509 :

      openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365

   3. Extrayez la clé privée au format PKCS#8 dans le fichier jira_privatekey.pcks8.

      openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8

   4. Extrayez la clé publique du certificat dans le fichier jira_publickey.pem :

      openssl x509 -pubkey -noout -in jira_publickey.cer  > jira_publickey.pem

2. Créez un lien d'application.

   1. Connectez-vous à Jira, cliquez sur l'icône Paramètres dans le coin supérieur droit de la page Jira, puis cliquez sur Applications.

   2. Dans l'onglet Applications, cliquez sur Application links.

   3. Dans la section Configure Application Links, saisissez une URL et cliquez sur Create new link.

      Remarque

      Cette URL est arbitraire et n'affecte pas l'intégration. Vous pouvez saisir n'importe quelle URL, par exemple http://alerts.console.alibabacloud.com/.

   4. Dans la boîte de dialogue Configure Application URL qui s'affiche, ignorez l'avertissement et cliquez sur Continue.

      Dans la boîte de dialogue, l'Entered URL s'affiche sous la forme http://alerts.console.alibabacloud.com/, et la New URL est automatiquement modifiée en https://alerts.console.alibabacloud.com/.

   5. Dans la boîte de dialogue Link applications qui s'affiche, définissez le paramètre Application Type sur Generic Application, saisissez AlertOauthKey pour la consumer key, cochez la case create incoming link, renseignez les autres paramètres si nécessaire, puis cliquez sur Continue.

   6. Dans la boîte de dialogue Link applications, configurez les paramètres suivants et cliquez sur Continue.

      |
      **Parameter**
      |
      **Value**
      | | --- | --- | |
      Consumer Key
      |
      AlertOauthKey
      | |
      Consumer Name
      |
      alertmanager
      | |
      Public Key
      |
      Le contenu du fichier jira_publickey.pem généré à l'[Étape 1](#step_7gz_0lo_lrm).
      |

      Dans la section Target Application de la boîte de dialogue Link applications, définissez le paramètre Application URL sur https://alerts.console.alibabacloud.com/, configurez les paramètres précédents, puis cliquez sur Continue.

      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      

      Après quelques instants, le nouveau lien d'application apparaît sur la page Configure Application Links. La liste des applications indique que alertmanager a été ajouté avec succès en tant que type Generic Application avec le statut NON-ATLASSIAN.

   7. Dans la colonne Action correspondant au lien d'application, cliquez sur l'icône de modification (). Dans la boîte de dialogue Configure alertmanager, cliquez sur incoming authentication dans le volet de gauche.

   8. Si le statut Status est défini sur Not Configured, saisissez à nouveau la consumer key, le Consumer Name et la public key, puis cliquez sur Save.

   9. Cliquez sur Close.

Étape 2 : Intégrer Jira à ARMS

1. Connectez-vous à la console ARMS. Dans le volet de navigation de gauche, accédez à Alert Management > Integrations.

2. Sur la page Integrations, cliquez sur l'onglet Notification Integration, puis cliquez sur Jira.

3. Dans l'assistant Add Integration, suivez les étapes ci-dessous.

   1. Sur la page Basic Information, configurez les paramètres suivants et cliquez sur Obtain Verification Code.

      Vous êtes redirigé vers la page d'autorisation Jira.

      |
      **Parameter**
      |
      **Value**
      | | --- | --- | |
      Name
      |
      Saisissez un nom pour l'intégration Jira.
      | |
      Description
      |
      Saisissez une description pour l'intégration Jira.
      | |
      URL
      |
      L'URL de votre instance Jira.
      | |
      Verification
      |
      Définissez la méthode Authentication method sur OAuth.
      | |
      Consumer key
      |
      AlertOauthKey
      | |
      Private key
      |
      Le contenu du fichier jira_privatekey.pcks8 généré à l'[Étape 1](#step_7gz_0lo_lrm).
      |
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      

   2. Sur la page Welcome to Jira, cliquez sur Allow.

   3. Sur la page Access Approved, récupérez le code de vérification.

   4. Revenez à l'assistant Add Integration dans la console ARMS. Collez le code dans le champ Verification Code et cliquez sur Obtain Access Token.

   5. Lorsque le message Obtaining Access Token Succeeded s'affiche, cliquez sur Next.

   6. Sur la page Alert Source Configuration, configurez les paramètres de synchronisation des alertes et cliquez sur Save.

      Parameter	Description	Example
      Project	Le projet Jira dans lequel les tâches sont créées lorsqu'une alerte est déclenchée.	Projet de surveillance, de gestion et de contrôle intégré
      Type	Le type de tâche Jira pour l'alerte. Task Subtask Improvement New feature Bug Epic Story	Bug
      Issue closed status	Le statut indiquant qu'une tâche Jira est clôturée. Une fois qu'une tâche atteint ce statut, les opérations d'alerte ultérieures ne sont plus synchronisées avec celle-ci. Statuts disponibles : To Do In Progress In Review Done Remarque Nous vous recommandons de sélectionner Done. Si vous choisissez un autre statut, les opérations d'alerte continueront d'être synchronisées avec la tâche Jira correspondante même après que son statut soit passé à Done.	Done
      Priority	Mappe les niveaux de gravité des alertes aux priorités des tâches Jira. Important Si vous ne configurez pas de mappage pour un niveau de gravité d'alerte, les alertes de ce niveau ne seront pas synchronisées avec Jira. Le niveau de gravité de l'alerte est synchronisé selon ce mappage uniquement lors de son premier envoi vers Jira. Les modifications ultérieures du niveau de gravité de l'alerte dans la gestion des alertes ARMS ne sont pas synchronisées avec la tâche Jira.	P1 : Highest P2 : High P3 : Medium P4 : Low P5 : Lowest

   Une fois la configuration enregistrée, vous pouvez consulter la nouvelle intégration Jira dans l'onglet Notification Integration. La liste affiche des informations telles que le Name, la Integration key, le Type et l'Creation time. Vous pouvez gérer l'intégration depuis la colonne Actions.

Envoyer des alertes vers Jira

Après avoir configuré l'intégration Jira, vous pouvez envoyer des alertes vers Jira de trois manières :

Méthode 1

Configurez une politique de notification pour créer automatiquement une tâche dans Jira lorsqu'une alerte est déclenchée.

1. Dans le volet de navigation de gauche, accédez à Alert Management > Notification Policies.

2. Sur la page Notification Policies, cliquez sur Create Notification Policy ou modifiez une politique de notification existante.

3. Dans la section When an alert is triggered, , spécifiez les Contacts. Vous devez sélectionner au moins un contact ou un groupe de contacts.

   Important

   • Jira attribue la tâche à un utilisateur dont l'adresse e-mail ou le nom d'utilisateur correspond à celui du premier contact de la politique de notification.

   • Si le premier contact de la politique de notification n'a pas d'utilisateur correspondant dans Jira, l'alerte ne sera pas synchronisée avec Jira.

4. Pour le paramètre Ticket system, sélectionnez l'intégration Jira que vous avez créée. Configurez les autres paramètres selon vos besoins. Pour plus d'informations, consultez la section Politiques de notification.

5. Cliquez sur Save.

   Une fois la configuration terminée, les alertes correspondant à cette politique de notification sont envoyées vers Jira.

Méthode 2

Depuis la page Alert Sending History, vous pouvez envoyer manuellement une alerte existante vers Jira pour créer une tâche.

1. Dans le volet de navigation de gauche, accédez à Alert Management > Alert Sending History.

2. Sur la page Alert Sending History, sélectionnez un opérateur dans le coin supérieur droit pour agir en tant que responsable de la tâche Jira, puis cliquez sur le nom de l'alerte cible.

   Important

   • Jira attribue la tâche à un utilisateur dont l'adresse e-mail ou le nom d'utilisateur correspond à celui de l'opérateur sélectionné.

   • Si l'opérateur n'a pas d'utilisateur correspondant dans Jira, l'alerte ne peut pas être synchronisée avec Jira.

3. Sur la page des détails de l'alerte, cliquez sur l'icône dans le coin supérieur droit, puis cliquez sur Push Alerts.

4. Dans la boîte de dialogue qui s'affiche, pour le paramètre Ticket system, sélectionnez l'intégration Jira que vous avez créée et cliquez sur Confirm.

   Une fois l'alerte envoyée avec succès, un lien vers la tâche Jira correspondante, par exemple AL-6, apparaît sur la page des détails de l'alerte.

Méthode 3

Lorsque vous recevez une carte d'alerte dans un groupe DingTalk, vous pouvez envoyer l'alerte correspondante vers Jira directement depuis la carte.

• Sur la carte d'alerte reçue dans le groupe DingTalk, cliquez sur Push Alerts et sélectionnez l'intégration Jira que vous avez créée.

• Sur la carte d'alerte, cliquez sur le nom de l'alerte. Dans le panneau des détails de l'alerte, cliquez sur Settings, puis sur Push ticket, et sélectionnez l'intégration Jira que vous avez créée.

Une fois l'alerte envoyée avec succès, un lien vers la tâche Jira correspondante apparaît sur la page des détails de l'alerte.

Supported alert operations for synchronization

Une fois configurées, les opérations d'alerte suivantes dans la gestion des alertes ARMS sont synchronisées avec le système de tickets Jira.

Opérations sur la page Alert Sending History :

• S'approprier l'alerte : met à jour le responsable de la tâche Jira.

  Remarque

  L'utilisateur qui s'approprie l'alerte doit disposer d'un compte utilisateur correspondant dans Jira.

• Commenter l'alerte : ajoute le commentaire à la tâche Jira.

• Résoudre l'alerte : ajoute la résolution en tant que commentaire à la tâche Jira.

Opérations sur la carte d'alerte dans un groupe DingTalk :

S'approprier l'alerte : met à jour le responsable de la tâche Jira.

Synchroniser les actions Jira vers ARMS

1. Dans la gestion des alertes ARMS, accédez à la page Integrations, cliquez sur l'onglet Notification Integration, et copiez la clé d'intégration de votre intégration Jira.

2. Connectez-vous à votre système de tickets Jira. Dans le coin supérieur droit de la page Jira, cliquez sur l'icône des paramètres, puis cliquez sur OsType.

3. Saisissez votre mot de passe administrateur et cliquez sur Confirm pour accéder à la page de configuration du système.

4. Dans le volet de navigation de gauche de la page OsType, accédez à Alerts > Webhook.

5. Sur la page Webhooks, cliquez sur + Create a webhook.

6. Sur la page Create a webhook, définissez l'URL sur http://alerts.aliyuncs.com/api/jira/receiver/{token}/${project.key}/${issue.key}. Remplacez {token} par la clé d'intégration Jira obtenue à l'Étape 1.

   Définissez le paramètre Name sur ARMS Alert Management et changez le Status en Enabled. Dans la section Issue related events, sélectionnez All issues. Sous la colonne Issue, sélectionnez created, updated et deleted. Sous la colonne Comment, sélectionnez created, updated et deleted.

7. Configurez les autres paramètres selon vos besoins. Pour plus d'informations, consultez la documentation officielle de Jira. Ensuite, cliquez sur Create .

   Une fois ces étapes terminées, les opérations suivantes sur les tâches Jira sont synchronisées avec la gestion des alertes ARMS.

   • Modification du responsable de la tâche : le responsable de l'alerte correspondante est mis à jour.

   • Ajout d'un commentaire à une tâche : un commentaire est ajouté à l'alerte correspondante.