Konfigurieren API Service Graph Connector für Kong Gateway Wird verwendet SGC Central

  • Freigeben Version: Australia
  • Aktualisiert 12. März 2026
  • 6 Minuten Lesedauer

    • Richten Sie geplante Importaufträge zum Abrufen ein Kong Gateway Daten in Ihrem Configuration Management Database (CMDB).

    Vorbereitungen

    Installieren API Service Graph Connector für Kong Gateway Version 2.0.0 oder höher aus ServiceNow Store. Für ServiceNow Store Installationsschritte, siehe Installieren Sie eine ServiceNow Store-Anwendung .

    Wenn Sie die Prometheus-Verbindung einrichten, aktivieren Sie das Prometheus-Plugin auf Kong Gateway Und stellen Sie sicher, dass alle erforderlichen Anmeldeinformationen verfügbar sind. Weitere Informationen zum Prometheus-Plugin finden Sie unter Prometheus Auf Kong Entwicklerdokumentationswebsite.

    Erforderliche Rolle: Die folgende Tabelle zeigt die Rollen an, die für jede Phase des Playbooks erforderlich sind.
    Tabelle : 1. Für jede Playbook-Phase erforderliche Rolle
    Phase Rolle
    Voraussetzungen Administrator
    Einrichtung SGC-Administrator (sn_cmdb_int_util.sgc_admin) oder admin
    Hinweis:
    Die Administratoranwenderrolle ist erforderlich, um Hintergrundskripts auszuführen und dem SGC-Administrator-Anwender Zugriff auf globale Tabellen zu gewähren. Um Informationen zu den Anwenderrollen für zu erhalten Service Graph Connectors, Siehe Service Graph Connector -Anwenderrollen.

    Warum und wann dieser Vorgang ausgeführt wird

    Die Playbook-Experience für Onboarding-Connectors wird mit aktiviert SGC Central In CMDB-Arbeitsbereich. Zum Konfigurieren von SGC Central Anwendung, siehe SGC Central konfigurieren Weitere Informationen zur Interaktion mit einem Playbook finden Sie unter Interagieren Sie mit Playbook .

    Hinweis:
    Alternativ können Sie eine Standardverbindung konfigurieren, die bereits über die installierten oder Entwurfsverbindungen in verfügbar ist SGC Central. Gehe zu Alle > Service Graph Connectors, Und wählen Sie dann aus Setup Für den Connector aus dem Menü. Informationen zu installierten Verbindungen und Entwurfsverbindungen finden Sie unter Verwalten von Verbindungen, die für hinzugefügt wurden Service Graph Connectors In SGC Central.

    Prozedur

    1. Navigieren zu Arbeitsbereiche > CMDB-Arbeitsbereichan.
    2. In CMDB-Arbeitsbereich, Wählen Sie aus SGC Central.
    3. Wählen Sie auf der Seite „Übersicht“ die Option aus Verbindung erstellen .
      Tipp:
      Alternativ können Sie auswählen Verbindung erstellen Auf der Seite „alle Verbindungen“.
    4. Wählen Sie im Fenster Verbindung erstellen die aus Kong Connector-Typ und dann auswählen Verbindung erstellen .
    5. Erfüllen Sie die ersten Voraussetzungen, wenn Sie eine Verbindung zum ersten Mal mit einem Connector einrichten.
      Hinweis:
      Dieser Schritt ist nur beim erstmaligen Setup erforderlich. Weitere Informationen finden Sie unter Führen Sie erste Setup-Aufgaben durch, wenn Sie eine Verbindung in erstellen SGC Central.
    6. Wählen Sie eine Vorlage für den Authentifizierungstyp aus, um eine Verbindung zu erstellen.
      1. In Setup Phase des Playbooks wählen Sie aus Wählen Sie die Aliasvorlage aus Aktivität.
      2. Wählen Sie einen Vorlagentyp aus.
        • Kong-RBAC-Authentifizierung : Wählen Sie diese Option aus, wenn Sie die tokenbasierte Authentifizierung verwenden.
        • Kong-Standardauthentifizierung : Wählen Sie diese Option aus, wenn Sie die Standardauthentifizierung verwenden.
    7. Geben Sie Verbindungsdetails ein, und testen Sie die API-Verbindung für den Import Kong Gateway Daten.
      1. In Setup Phase des Playbooks wählen Sie aus Verbindung erstellen und testen Aktivität.
      2. Füllen Sie im Formular die Felder aus.
        Tabelle : 2. Verbindungsformular erstellen und testen
        Feld Beschreibung
        Verbindungsname Name zur Identifizierung von Kong Gateway Verbindungsdatensatz.
        Host-Name Administrator-URL-Adresse von Kong-Administrator API-Server.
        Protokoll Protokoll, das für die Verbindung verwendet wird, um eine gesicherte Kommunikation zwischen dem Client und dem sicherzustellen Kong Server.
        Standardport überschreiben Von verwendeter Port Kong-Administrator API.
        API-Schlüssel Geheimer Authentifizierungsschlüssel für die Verbindung mit Kong Gateway Service. Dieses Feld wird nur angezeigt, wenn Kong-RBAC-Authentifizierung Ist in ausgewählt Wählen Sie die Aliasvorlage aus Aktivität.
        Anwendername Anwendername, der zum Authentifizieren von Anforderungen an erforderlich ist Kong-Gateway-Administrator API. Dieses Feld wird nur angezeigt, wenn Kong-Standardauthentifizierung Ist in ausgewählt Wählen Sie die Aliasvorlage aus Aktivität.
        Passwort Passwort, das dem Anwendernamen zugeordnet ist, der für die Authentifizierung von Anforderungen erforderlich ist. Dieses Feld wird nur angezeigt, wenn Kong-Standardauthentifizierung Ist in ausgewählt Wählen Sie die Aliasvorlage aus Aktivität.
      3. Wählen Sie Aus Verbindung erstellen und testen .
      4. Sobald der Verbindungstest abgeschlossen ist, wählen Sie aus Fahren Sie Fort .
    8. Wahlweise: Legen Sie die Konfigurationseigenschaften für die Verbindung fest.
      1. In Setup Phase des Playbooks wählen Sie aus Legen Sie Konfigurationseigenschaften fest Aktivität.
      2. In Expand HTTP Method TypesFeld verfügbar im Abschnitt „Konfiguration des Datenabrufs“. Geben Sie die HTTP-Methoden einschließlich ein ABRUFEN , VERÖFFENTLICHEN , PLATZIEREN , PATCH , LÖSCHEN , OPTIONEN , KOPF , VERBINDEN , Und ABLAUFVERFOLGUNG , Für Routen zu berücksichtigen.
        Trennen Sie mehrere Methoden durch Kommas. Wenn leer gelassen, wird ein einzelnes API-Frontend mit erstellt ALLE Methode, die die Unterstützung aller Standard-HTTP-Methoden angibt.
      3. In Exclude workspacesFeld verfügbar im Abschnitt „Eigenschaftseinstellungen“ geben Sie den Arbeitsbereich ein, der vom Import ausgeschlossen werden muss.

        Trennen Sie mehrere Arbeitsbereiche durch Kommas. Beispiel: Arbeitsbereich1,Arbeitsbereich2 . Wenn Sie dieses Feld leer lassen, importieren die Datenquellen im Connector Daten aus allen Arbeitsbereichen.

      4. Wählen Sie aus Importieren Sie Tags Kontrollkästchen im Abschnitt „Tag-Einstellungen“ verfügbar, um Tags von aufzunehmen Kong Gateway Service.
        Wenn diese Option ausgewählt ist, geben Sie das Schlüssel-Wert-Paartrennzeichen für Tags in an Tag-Werttrennzeichen Feld. Wenn diese Option nicht ausgewählt ist, werden keine Tags abgerufen.
      5. In Tag-Werttrennzeichen Feld, das im Abschnitt „Tag-Einstellungen“ verfügbar ist, geben Sie das Trennzeichen für Schlüssel und Wert in Tags ein.
        Beispiel: Wenn das Tag-Werttrennzeichen auf festgelegt ist = , Das Tag env=prod Wird mit gespeichert umgebung Als Schlüssel und prod Als Wert.

        Wenn leer gelassen, werden keine Tags erfasst.

      6. Wählen Sie aus Sammeln Sie Nutzungsdaten Kontrollkästchen im Abschnitt „Metrikeinstellungen“ verfügbar, um die Erfassung von Nutzungsdaten zu aktivieren, um API-Nutzungsdaten über eine angegebene Dauer abzurufen.
      7. In Sammlungszeitraum (in Tagen) Geben Sie im Abschnitt „Metrikeinstellungen“ die Dauer in Tagen für die Erfassung von API-Nutzungsdaten ein.
      8. Wählen Sie Fortsetzen.
    9. Wahlweise: Eingabetaste Prometheus Verbindungsdetails und testen Sie die API-Verbindung für den Import Kong Gateway Metrikdaten mit dem Prometheus-Plugin.
      Hinweis:
      Sie können diesen Schritt überspringen, wenn die Überwachung der API-Nutzung mit Prometheus nicht erforderlich ist oder wenn Sie eine vorhandene Prometheus-Instanz verwenden. Um diesen Schritt zu überspringen, wählen Sie aus Überspringen Für Erstellen und testen Sie eine Prometheus-Verbindung Aktivität.
      1. In Setup Phase des Playbooks: Wählen Sie aus Erstellen und testen Sie eine Prometheus-Verbindung Aktivität.
      2. Füllen Sie im Formular die Felder aus.
        Tabelle : 3. Erstellen und testen Prometheus Verbindungsformular
        Feld Beschreibung
        Verbindungsname Name zur Identifizierung von Prometheus Verbindungsdatensatz.
        Verbindungs-URL Basis-URL von Prometheus HTTP-API, die zum Abrufen von Metriken verwendet wird.
        Anwendername Anwendername, der zum Authentifizieren von Anforderungen an erforderlich ist Prometheus Server.
        Passwort Passwort, das dem Anwendernamen zugeordnet ist, der für die Authentifizierung von Anforderungen an erforderlich ist Prometheus Server.
      3. Wählen Sie Aus Verbindung erstellen und testen .
      4. Sobald der Verbindungstest abgeschlossen ist, wählen Sie aus Fahren Sie Fort .
    10. Wahlweise: Ordnen Sie die Prometheus-Verbindung einem zu Kong Gateway Verbindung.
      Hinweis:
      Sie können diesen Schritt überspringen, wenn die Überwachung der API-Nutzung mit Prometheus nicht erforderlich ist. Um diesen Schritt zu überspringen, wählen Sie aus Überspringen Für Kong Prometheus-Zuordnung Aktivität.
      1. In Setup Phase des Playbooks: Wählen Sie aus Kong Prometheus-Zuordnung Aktivität.
      2. In Prometheus-Verbindungen Suchen Sie nach einer Prometheus-Verbindung, und wählen Sie sie aus, die zugeordnet werden soll.
        Sie können die in Schritt erstellte Prometheus-Verbindung auswählen 9 Oder wählen Sie während dieses Schritts eine vorhandene Prometheus-Verbindung aus. Wenn Sie Schritt überspringen 9, Wählen Sie eine vorhandene Prometheus-Verbindung aus.
      3. Wählen Sie Absenden.
      Eine Prometheus-Verbindung kann mehreren zugeordnet werden Kong Gateway Verbindungen. Sie können die Prometheus-Zuordnung in aktualisieren Kong Gateway Verbindung von SGC Central Jederzeit anzeigen. Weitere Informationen finden Sie unter Aktualisieren Sie eine Verbindung für einen Service Graph Connector In SGC Central.
    11. Konfigurieren Sie den Importzeitplan, um Daten in regelmäßigen Abständen zu importieren.
      1. In Setup Phase des Playbooks wählen Sie aus Konfigurieren Sie den Importzeitplan Aktivität.
      2. Wählen Sie Aus Konfigurieren Sie den Importzeitplan .
      3. Erweitern Sie den übergeordneten geplanten Datenimport in der Liste „Zeitpläne importieren“, um auszuwählen SG-Kong-Gateway Importzeitplan, der Ihrer Verbindung zugeordnet ist.
        Hinweis:
        Der Verbindungsname wird dem Zeitplannamen vorangestellt.
      4. In Konfigurieren Sie den Importzeitplan Wählen Sie das Dialogfeld aus Aktiv Aktivieren Sie das Kontrollkästchen, und geben Sie dann den Zeitplan und die Zeitdetails der Ausführung ein.

        Weitere Informationen finden Sie unter Schedule a data import.

      5. Wählen Sie Speichern.
        Alternativ wählen Sie aus Jetzt Ausführen Um den Importzeitplan sofort auszuführen.
      6. Wählen Sie Fortsetzen.
    12. In Setup Phase des Playbooks: Wählen Sie aus Bestätigen Sie die Verbindungserstellung Aktivität zum Überprüfen, ob die Verbindung konfiguriert wurde.

    Nächste Maßnahme

    Wählen Sie Aus Zeigen Sie alle Verbindungen an Dient zum Überprüfen der Verbindungsdetails. Die konfigurierten Verbindungen, einschließlich Kong Gateway Die Verbindung und die Prometheus-Verbindung, falls erstellt, werden in der Liste der installierten Verbindungen angezeigt.

    Sie können dann Verbindungen über verwalten SGC Central Ansicht von CMDB-Arbeitsbereich. Weitere Informationen finden Sie unter Verwalten von Verbindungen, die für hinzugefügt wurden Service Graph Connectors In SGC Central.