Richten Sie einen Webhook ein

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 4 Minuten Lesedauer

    • Richten Sie die Webhook-Anwendung ein, um die erforderlichen Updates von Jenkins in Ihrer ServiceNow -Instanz 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 wird 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 ServiceNow -Instanz 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 im Formular die folgenden Werte aus:
      Tabelle : 1. Formular „Jenkins-Webhook-Client-Details“.
      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 angeben.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Melden Sie sich bei Ihrem Jenkins-Konto an.
    2. Klicken Sie auf die Aufgabe, für die Sie Ihren Webhook konfigurieren möchten, und öffnen Sie sie.
    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 Bindung von Anmeldeinformationen.

      Jenkins-Anmeldeinformationsanbieter
    5. Füllen Sie die Felder des Formulars aus.
      Tabelle : 2. Formular „Jenkins-Anmeldeinformationsanbieter“.
      Feld Beschreibung
      Art Wählen Sie Geheimer Textaus.
      Geheimnis 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 Post-Build-Aktionen die Aufgabe, und geben Sie das Skript an, das Updates in Ihrer ServiceNow -Instanz erhalten soll.
      • Beispielskript: Windows curl"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: curl "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_Nummer\":\"${BUILD_NUMBER}\" }"
      Hinweis:
      Die ID im Skript ist die ID, die Sie im Formular „Anmeldeinformationsanbieter von Jenkins“ angegeben haben.
      Weitere Informationen zur Verwendung des Plugins durch finden Sie unter Post-Build-Aufgabe.
    8. Klicken Sie auf Übernehmen.

    Geben Sie eine Beschreibung für den Subflow an

    Geben Sie benutzerfreundliche Beschreibungen für die Subflows in Jenkins v2-Spoke.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > Jenkins v2 > Webhook-Antwort-Subflows.
    2. Klicken Sie auf Neu.
    3. Füllen Sie im Formular die folgenden Werte 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 im Formular die folgenden Werte aus:
      Tabelle : 3. Formular „Entscheidung“
      Feld Beschreibung
      Bezeichnung Eindeutige Bezeichnung zur Identifizierung der Routing-Richtlinie.
      Standardantwort Option, um anzugeben, ob dies die Standardantwort ist. Die Standardantwort gilt, wenn die Bedingungen nicht erfüllt sind.
      Bedingung Bedingungen, die erfüllt sein müssen, wenn die erforderlichen Events in Jenkins auftreten. Weitere 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 erforderlichen 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 gemäß Ihren 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 Subflow „Jenkins Webhook-Antwort-Subflow: Prozess-Build-Informationen“ gemäß Ihren Anforderungen an, und veröffentlichen Sie ihn.
      Weitere Informationen zum Erstellen und Verwenden von Subflows finden Sie unter Subflows erstellen. Weitere Informationen zu den Feldern, die von den Routing-Richtlinien und Subflows unterstützt werden, finden Sie unter Jenkins v2-Spoke.
    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 im Formular die folgenden Felder aus:
      Tabelle : 4. Formular „Entscheidung“
      Feld Beschreibung
      Bezeichnung Eindeutige Bezeichnung zur Identifizierung der Routing-Richtlinie.
      Standardantwort Option, um anzugeben, ob dies die Standardantwort ist. Die Standardantwort gilt, wenn die Bedingungen nicht erfüllt sind.
      Bedingung Bedingungen, die erfüllt sein müssen, wenn die erforderlichen Events in Jenkins auftreten. Weitere 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 erforderlichen 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.