Richten Sie einen Webhook ein

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 4 Minuten Lesedauer

    • Richten Sie die Webhook-Anwendung ein, um die erforderlichen Updates von Jenkins in Ihrer Instanz ServiceNow zu erhalten.

    Vorbereitungen

    Erforderliche Rolle: admin

    Erstellen Sie einen Autorisierungsschlüssel für Jenkins v2-Spoke

    Erstellen Sie einen Autorisierungsschlüssel, um Anforderungen von Jenkins zu autorisieren.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > Systemdefinition > Skripts – Hintergrund.
    2. Geben Sie diesen Befehl in das Textfeld „Skript ausführen (JavaScript auf dem Server ausgeführt)“ ein:
      gs.info(GlideSecureRandomUtil.getSecureRandomString(32));
    3. Klicken Sie auf Skript ausführen.
    4. Kopieren Sie den generierten Wert, und notieren Sie ihn zur späteren Verwendung.
      Geheimer Clientschlüssel oder Autorisierungsschlüssel

    Geben Sie den Autorisierungsschlüssel für den Webhook an

    Autorisieren Sie Anforderungen von Jenkins, indem Sie den Autorisierungsschlüssel für den Webhook in Ihrer Instanz ServiceNow bereitstellen.

    Vorbereitungen

    Erforderliche Rolle: admin

    Prozedur

    1. Navigieren zu Alle > Jenkins v2 > Details zum Webhook-Client.
    2. Klicken Sie auf Neu.
    3. Füllen Sie diese Werte im Formular aus:
      Tabelle : 1. Formular „Details zum Jenkins-Webhook-Client“.
      Feld Beschreibung
      Autorisierungsschlüssel Autorisierungsschlüssel, den Sie generiert haben. Weitere Informationen finden Sie unter Erstellen Sie einen Autorisierungsschlüssel für Jenkins v2-Spoke.
      Name Name zur Identifizierung des Webhook-Client-Datensatzes.
    4. Klicken Sie auf Absenden.

    Geben Sie den Autorisierungsschlüssel in Jenkins an

    Erhalten Sie Updates von Jenkins, indem Sie den Autorisierungsschlüssel in Jenkins bereitstellen.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Melden Sie sich bei Ihrem Jenkins-Konto an.
    2. Klicken Sie auf den Auftrag, für den Sie Ihren Webhook konfigurieren möchten, und öffnen Sie ihn.
    3. Klicken Sie auf Konfigurieren.
    4. Klicken Sie auf der Registerkarte Bindungen auf Hinzufügen, und wählen Sie Jenkinsaus.

      Weitere Informationen zur Verwendung des Plugins finden Sie unter Anmeldeinformationsbindung.

      Jenkins-Anmeldeinformationsanbieter
    5. Füllen Sie die Felder des Formulars aus.
      Tabelle : 2. Formular für den Jenkins-Anmeldeinformationsanbieter
      Feld Beschreibung
      Art Wählen Sie Geheimer Textaus.
      Geheimer Schlüssel Geben Sie den Autorisierungsschlüssel ein. Weitere Informationen finden Sie unter Erstellen Sie einen Autorisierungsschlüssel für Jenkins v2-Spoke.
      ID Geben Sie einen eindeutigen Bezeichner an, um den Datensatz zu identifizieren.
    6. Klicken Sie auf Hinzufügen.
    7. Konfigurieren Sie auf der Registerkarte Aktionen nach dem Build die Aufgabe, und geben Sie das Skript an, das Updates in Ihrer Instanz ServiceNow erhalten soll.
      • Beispielskript: Rollen „ Windows https://“<instance-name> .service-now.com/api/sn_jenkinsv2_spoke/jenkins_v2_webhook/build_status" -X POST -H "content-type:application/json" -H "jenkinsKey: %<ID> %" -d "{\"Job_Name\":\"%JOB_NAME%\",\"Job_Path\":\"%JOB_URL%\",\"Build_Number\":\"%BUILD_NUMBER%\"}"
      • Beispiel-Shell -Skript: Rollen "https://<instance-name> .service-now.com/api/sn_jenkinsv2_spoke/jenkins_v2_webhook/build_status" -X POST -H "content-type:application/json" -H "jenkinsKey: ${<ID> }" -d "{\"Job_Name\":\"${JOB_NAME}\",\"Job_Path\":\"${JOB_URL}\",\"Build_Number\":\"${BUILD_NUMBER}\" }"
      Hinweis:
      Die ID im Skript ist die ID, die Sie im Formular für den Jenkins-Anmeldeinformationsanbieter angegeben haben.
      Weitere Informationen zur Verwendung des Plugins finden Sie unter Aufgabe nach dem Build.
    8. Klicken Sie auf Übernehmen.

    Geben Sie eine Beschreibung für den Subflow an

    Geben Sie anwenderfreundliche Beschreibungen für die Subflows im Jenkins v2-Spokean.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > Jenkins v2 > Webhook-Antwort-Subflows.
    2. Klicken Sie auf Neu.
    3. Füllen Sie diese Werte im Formular aus:
      Feld Beschreibung
      Beschreibung Beschreibung des Subflows.
      Subflow Erforderlicher Subflow in Jenkins v2-Spoke.
    4. Klicken Sie auf Absenden.

    Geben Sie Antworten für die Entscheidungstabelle an

    Geben Sie Subflows als Antworten auf die in der Entscheidungstabelle genannten Bedingungen an. Wenn die angegebenen Bedingungen erfüllt sind, wird der zugehörige Subflow ausgelöst.

    Vorbereitungen

    Erforderliche Rolle: admin

    Prozedur

    1. Navigieren zu Alle > Systemdefinition > Entscheidungstabellen.
    2. Öffnen Sie den Datensatz für die Jenkins v2-Spoke.
    3. Klicken Sie auf der Registerkarte Entscheidungen auf Neu.
    4. Füllen Sie diese Werte im Formular aus:
      Tabelle : 3. Formular „Entscheidung“
      Feld Beschreibung
      Bezeichnung Eindeutige Bezeichnung zur Identifizierung der Weiterleitungsrichtlinie.
      Standardantwort Option zum Angeben, ob dies die Standardantwort ist. Die Standardantwort ist anwendbar, wenn die Bedingungen nicht erfüllt sind.
      Bedingung Bedingungen, die erfüllt werden müssen, wenn die erforderlichen Ereignisse in Jenkins auftreten. Informationen zu den unterstützten Feldern finden Sie unter Jenkins v2-Spoke.
      Antwort Subflow, der ausgelöst werden muss, wenn die angegebenen Bedingungen erfüllt sind.
      1. Klicken Sie auf das Suchsymbol ( Suchsymbol).
      2. Wählen Sie den gewünschten Subflow aus der Dokumentliste aus.
        Hinweis:
        Stellen Sie sicher, dass der TabellennameJenkins v2 Webhook-Antwort-Subflow [sn_jenkinsv2_spoke_webhook_answer_subflow] lautet.
    5. Klicken Sie auf Absenden.

    Passen Sie einen Webhook an

    Erstellen Sie eine Webhook-Routing-Richtlinie, und passen Sie den Subflow an Ihre Anforderungen an.

    Vorbereitungen

    Erforderliche Rolle: admin

    Prozedur

    1. Navigieren zu Alle > Flow Designer > Designer.
    2. Klicken Sie auf Subflows.
    3. Erstellen Sie eine Kopie des erforderlichen Standard-Subflows.
    4. Passen Sie den Jenkins-Webhook-Antwort-Subflow an: Verarbeiten Sie den Subflow für Build-Informationen gemäß Ihren Anforderungen, und veröffentlichen Sie ihn.
      Unter Subflows erstellen finden Sie weitere Informationen zum Erstellen und Verwenden von Subflows und Jenkins v2-Spoke für Informationen zu den Feldern, die von Weiterleitungsrichtlinien und Subflows unterstützt werden.
    5. Navigieren zu Jenkins v2 > WebHook-Antwort-Subflows.
    6. Klicken Sie auf Neu.
    7. Füllen Sie die Felder des Formulars aus.
      Feld Beschreibung
      Beschreibung Beschreibung des Subflows.
      Subflow Erforderlicher Subflow in Jenkins v2-Spoke.
    8. Klicken Sie auf Absenden.
      Hinweis:
      Diese Weiterleitungsrichtlinien werden in den Entscheidungstabellen gespeichert. Benutzer werden davor gewarnt, Daten in diesen Tabellen direkt zu aktualisieren oder zu ändern.
    9. Navigieren zu Systemdefinition > Entscheidungstabellen.
    10. Öffnen Sie den Datensatz für die Jenkins v2 -Spoke.
    11. Klicken Sie auf der Registerkarte Entscheidungen auf Neu.
    12. Füllen Sie diese Felder im Formular aus:
      Tabelle : 4. Formular „Entscheidung“
      Feld Beschreibung
      Bezeichnung Eindeutige Bezeichnung zur Identifizierung der Weiterleitungsrichtlinie.
      Standardantwort Option zum Angeben, ob dies die Standardantwort ist. Die Standardantwort ist anwendbar, wenn die Bedingungen nicht erfüllt sind.
      Bedingung Bedingungen, die erfüllt werden müssen, wenn die erforderlichen Ereignisse in Jenkins auftreten. Informationen zu den unterstützten Feldern finden Sie unter Jenkins v2-Spoke.
      Antwort Subflow, der ausgelöst werden muss, wenn die angegebenen Bedingungen erfüllt sind.
      1. Klicken Sie auf das Suchsymbol ( Suchsymbol).
      2. Wählen Sie den gewünschten Subflow aus der Dokumentliste aus.
        Hinweis:
        Stellen Sie sicher, dass der TabellennameJenkins v2 Webhook-Antwort-Subflow [sn_jenkinsv2_spoke_webhook_answer_subflow] lautet.
    13. Klicken Sie auf Absenden.