Konfigurieren Sie das Plugin Jenkins

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 4 Minuten Lesedauer

    • Konfigurieren Sie Jenkins, um Echtzeitbenachrichtigungen für Ihre Pipeline-Ausführungen an DevOps Change-Geschwindigkeitzu senden.

    Vorbereitungen

    Erforderliche Rolle: Jenkins-Administrator

    Prozedur

    1. Installieren Sie das ServiceNow DevOps- Plugin aus dem Jenkins-Marketplace, indem Sie in Ihrer Jenkins-Instanz zu Jenkins verwalten > Systemkonfiguration > Plugins navigieren.
    2. Suchen Sie nach dem ServiceNow DevOps-Plugin, wählen Sie es aus, und wählen Sie dann Installierenaus.

    Konfigurieren Sie Webhooks für Jenkins manuell

    Konfigurieren Sie Webhooks in Jenkins, um Synchronisierungsbenachrichtigungen an die Anwendung DevOps Change-Geschwindigkeit zu senden.

    Vorbereitungen

    Erforderliche Rolle: sn_devops.admin oder sn_devops.tool_owner in DevOps Change-Geschwindigkeit, Jenkins-Administrator

    Warum und wann dieser Vorgang ausgeführt wird

    Sie können insgesamt zehn ServiceNow DevOps-Konfigurationen hinzufügen. Beispielsweise können Sie Jenkins -Verbindungen für Ihre Entwicklungs-, Test-, Produktionsinstanzen usw. konfigurieren.

    Wenn Sie ein Kunde sind, der ein Upgrade durchführt, müssen Sie das neueste Jenkins-Plugin herunterladen und installieren, um mehrere ServiceNow -Konfigurationen zu aktivieren. Nach der Installation wird Ihre vorhandene Konfiguration beibehalten und zur Standardkonfiguration gemacht.

    Im Abschnitt ServiceNow DevOps-Konfiguration in Jenkinsmüssen die Werte im Feld Name und die Kombination aus den Feldern Instanz-URL und Orchestration-Tool-ID eindeutig sein.

    Wenn Sie ein Tool automatisch aus ServiceNowkonfigurieren, wird das vorhandene Setup für die DevOps-Konfiguration ServiceNow in Jenkinsüberschrieben.

    Wenn DevOps Config installiert ist, können Sie Jenkins nur manuell konfigurieren.

    Prozedur

    1. Wählen Sie in DevOps Change-Geschwindigkeitdie Option Manuell konfigurieren, wenn Sie die Toolinstanz zum Senden von Daten konfigurieren.
      Konfigurieren Sie Webhooks automatisch.
    2. Wählen Sie im entsprechenden Feld Kopieren aus, um den Wert in die Zwischenablage zu kopieren.

      Die Feldbezeichnung ändert sich in Kopiert, Sie können jedoch mehrmals kopieren.

      Konfigurieren Sie Webhooks manuell.
    3. Navigieren Sie in Jenkins zu Verwalten Sie Jenkins > Systemkonfiguration > Verwalten Sie Plugins > Konfigurieren Sie das System.
    4. Wählen Sie im Abschnitt ServiceNow DevOps-Konfiguration die Option Hinzufügen aus.
      Hinweis:
      Sie können mehrere Verbindungen hinzufügen, indem Sie für jede neue Konfiguration Hinzufügen wählen.
    5. Konfigurieren Sie das Plugin, indem Sie die Felder ausfüllen.

      Wenn diese Option aktiviert ist, beginnt Jenkins, Ereignisse als eingehende Ereignisse an DevOps zu senden.

      Hinweis:
      Bei den Werten wird die Groß- und Kleinschreibung beachtet.

      Felder, die in Jenkins konfiguriert werden sollen.

      Feld Beschreibung
      Aktiv Wählen Sie diese Option aus, um die Verbindung zu aktivieren. Standardmäßig ist diese Option ausgewählt, wenn Sie Hinzufügen für eine neue Verbindung auswählen.
      Hinweis:
      Alle Verbindungen, für die „Aktiv“ aktiviert ist, senden Webhook-Benachrichtigungen für Ihre Pipeline-Ausführung. Für den Change-Schritt wird jedoch nur die angegebene Verbindung berücksichtigt.
      Standard Wählen Sie diese Option aus, um die Verbindung als Standardverbindung festzulegen, wenn der Verbindungsname nicht in einem vorhandenen Schritt in einer Pipeline übergeben wird.
      Hinweis:
      Wenn Sie diese Option nicht auswählen, wenn nur eine Verbindung verfügbar ist, führt dies zu einem Fehler.
      Name Eindeutiger Name der Verbindung.
      Hinweis:
      Der Namenswert wird automatisch generiert, wenn Sie eine Verbindung automatisch über ServiceNowkonfigurieren.
      Instanz-URL

      Geben Sie die URL Ihrer ServiceNow-Instanz ein, die Sie in Schritt 2 kopiert haben. Beispiel: https://.<your-instance> .service-now.com .
      ID des Orchestration-Tools

      Die sys_id des Orchestration-Tools, das Sie in Schritt 2 kopiert haben.

      Alternativ können Sie diesen Wert aus der Webhook-URL (toolid- Wert) kopieren oder direkt mit dem Befehl sys_id kopieren im Datensatz des Orchestration-Tools abrufen.

      Hinweis:
      Die Kombination aus den Werten für Instanz-URL und Orchestration-Tool-ID muss für jede Verbindung eindeutig sein.
      Artefakt-Tool-ID

      Die sys_id des Artefakt-Tools.
      Anmeldeinformationen

      Wählen Sie die Anmeldeinformationen für die Standardauthentifizierung aus, die Sie für die Verbindung mit Jenkinsverwenden möchten.

      1. Um Anmeldeinformationen hinzuzufügen, wählen Sie Hinzufügen.
      2. Geben Sie im Feld Anwendername die Details Ihres DevOps-Integrationsanwenders ein. Standardmäßig lautet er „devops.integration.user“.
      3. Geben Sie im Feld Passwort das Passwort Ihres DevOps-Integrationsanwenders ein.
      Geheime Anmeldeinformationen

      Wählen Sie das geheime Token aus, das Sie in Schritt 2 kopiert haben. Alternativ können Sie die folgenden Schritte ausführen, um das geheime Token aus dem Tooldatensatz zu erhalten.

      1. Kopieren Sie das geheime Token für Ihr Tool Jenkins in DevOps Change.
        • Arbeitsbereich: Navigieren Sie zum Tooldatensatz, wählen Sie Konfigurieren, und kopieren Sie das geheime Token.
        • Klassische UI: Navigieren Sie zum Tooldatensatz, und wählen Sie Token kopierenaus.
      2. Um Token hinzuzufügen, wählen Sie Hinzufügen.
      3. Wählen Sie in der Liste Artdie Option Geheimer Textaus.
      4. Geben Sie im Feld Geheimnis das geheime Token ein, das beim Erstellen der Jenkins -Tool-Verbindung in DevOpsgeneriert wurde.
      5. Geben Sie im Feld ID einen Namen für das Token ein.
      Protokollebene Die Ebene der Protokollnachrichten, die Sie in Jenkins Protokollen/ ServiceNow Protokoll-Recorder speichern möchten.
      Wählen Sie eine der folgenden Optionen aus:
      • Übernahme
      • aus
      • Schwer
      • Warnung
      • Info
      • Konfiguration
      • Prima
      • feiner
      • am besten
      • alle

      Weitere Informationen zu Protokollebenen und Protokollaufzeichnungen finden Sie unter Jenkins Protokollebenen und Protokoll-Recorder
      Prüfung zur Nachverfolgung erzwingen

      Aktivieren Sie das Kontrollkästchen, um für jede Pipeline-Ausführung einen REST (POST)-API-Aufruf an Jenkins durchzuführen und zu bestimmen, ob die Pipeline nachverfolgt wird oder nicht.

      Deaktivieren Sie das Kontrollkästchen, um Details in der Datei snPipelineInfo.json zu speichern und die Durchführung von API-Aufrufen für jede Pipeline-Ausführung zu beenden.

      Hinweis:
      Wenn eine Pipeline nachverfolgt wird, erhalten alle aktiven Jenkins-Konfigurationen Job-Benachrichtigungen.
      Nachverfolgungsprüfung für Pipeline der Abrufanforderung

      Aktivieren Sie das Kontrollkästchen, um die Nachverfolgung für Pull-Anforderungs-Pipelines zu aktivieren.

      Hinweis:
      Wenn eine Pipeline nachverfolgt wird, erhalten alle aktiven Jenkins-Konfigurationen Job-Benachrichtigungen.
    6. Wählen Sie Verbindung testen.
      Vergewissern Sie sich, dass die Meldung „Verbindung erfolgreich“ angezeigt wird.
      • Wenn Sie Anmeldeinformationen für die Standardauthentifizierung hinzugefügt haben, wird bei einer erfolgreichen Verbindung die folgende Meldung angezeigt: Verbindung mit Anmeldeinformationen erfolgreich.
      • Wenn Sie das geheime Token hinzugefügt haben, wird bei einer erfolgreichen Verbindung die folgende Meldung angezeigt: Verbindung mit geheimen Anmeldeinformationen erfolgreich.
    7. Wählen Sie Übernehmen, um die Änderungen anzuwenden, und wählen Sie Speichern.