Integration mit GitHub Enterprise Cloud

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

    • Durch die Integration Ihrer Anwendung Software Asset Management in die Anwendung GitHub Enterprise Cloud können Sie Ihre Softwareabonnements nachverfolgen und nicht verwendete Lizenzen zurückfordern.

    Wichtig:
    Minimieren Sie Sicherheitsrisiken und schützen Sie Informationen, indem Sie nur den erforderlichen Anwender- oder API-Berechtigungen Zugriff gewähren.
    Tabelle : 1. Minimale Benutzerberechtigungen
    Prozess Erforderliche Anwenderrolle in der Anwendung GitHub Enterprise Cloud Authentifizierungsbereiche
    Abonnements herunterladen Organisationsbesitzer lesen:org
    Rufen Sie die Anwenderaktivität ab Organisationsbesitzer
    • lesen:org
    • Repository
    Abonnement zurückfordern Organisationsbesitzer write:org

    Generieren Sie ein API-Zugriffstoken für GitHub Enterprise Cloud

    Generieren Sie ein Token, das Sie für den Zugriff auf die Enterprise Cloud-API GitHub verwenden können.

    Vorbereitungen

    GitHub Erforderliche Rolle: Organisationsbesitzer

    Der Anwenderaccount, den Sie für die Authentifizierung verwenden, sollte in der Lage sein, alle Repositorys in der Organisation zu lesen, der er angehört.

    Warum und wann dieser Vorgang ausgeführt wird

    Der Hosting-Service für GitHub das -Repository verwendet persönliche Zugriffstoken, um Benutzern Zugriff auf die GitHub -API zu gewähren. Persönliche Zugriffstoken funktionieren ähnlich wie OAuth-Zugriffstoken, indem sie API-Anforderungen autorisieren. Durch Generieren eines persönlichen Zugriffstokens zur Autorisierung Ihrer GitHub Enterprise Cloud-API-Anforderungen können Sie auf die GitHub Enterprise Cloud-API zugreifen.

    Prozedur

    1. Öffnen Sie in einem Webbrowser GitHub.
    2. Melden Sie sich bei Ihrem Konto GitHub an.
    3. Wählen Sie im Header der Seite GitHub Ihr Profilfoto und dann Einstellungenaus.
      Ihre Profileinstellungen werden geöffnet.
    4. Wählen Sie im linken Navigationsbereich Entwicklereinstellungenaus.
      Ihre Entwicklereinstellungen werden geöffnet.
    5. Wählen Sie im linken Navigationsbereich Persönliche Zugriffstokenaus.
    6. Wählen Sie Token (klassisch)aus.
    7. Wählen Sie auf der Seite Persönliche Zugriffstoken die Option Neues Token generieren aus.
    8. Wählen Sie Neues Token generieren (klassisch)aus.
    9. Wenn Sie aufgefordert werden, Ihr Passwort zu bestätigen, bevor Sie fortfahren, geben Sie Ihr Passwort GitHub ein, und wählen Sie dann Passwort bestätigenaus.
    10. Beschreiben Sie im Formular Neues persönliches Zugriffstoken den Zweck des Tokens im Feld Notiz.
    11. Um Ihrem Token einen Ablauf zuzuweisen, wählen Sie das Dropdown-Menü Ablauf und dann einen Standardwert aus, oder verwenden Sie die Kalenderauswahl.
    12. Aktivieren Sie im Formularabschnitt „Bereiche auswählen“ die OAuth-Bereiche „repo“, „write:org“ und „read:org“.
      OAuth-Bereiche schränken die Zugriffsebene ein, die die Anwendung auf Ihre geschützten Ressourcen hat. Mit dem OAuth-Bereich des -Repositorys haben Sie vollständige Kontrolle über Ihre privaten Repositorys. Mit den OAuth-Bereichen „write:org“ und „read:org“ können Sie Ihre gesamte Organisation verwalten, einschließlich aller Teams, Projekte und Mitgliedschaften. Weitere Informationen zu GitHub OAuth-Bereichen finden Sie unter Bereiche für OAuth-Apps.
      1. Aktivieren Sie den OAuth-Bereich des Repositorys, indem Sie das Kontrollkästchen Repository aktivieren.
        Durch Aktivieren dieses OAuth-Bereichs aktivieren Sie automatisch die OAuth-Bereiche „repo:status“, „repo_deployment“, „public_repo“, „repo:invite“ und „security_events“.
      2. Aktivieren Sie den OAuth-Bereich „write:org“ und „read:org“.
    13. Wählen Sie Token generierenaus.
      Ihr persönliches Zugriffstoken wird generiert.
    14. Kopieren Sie das Zugriffstoken, und speichern Sie es zur späteren Verwendung an einem sicheren Ort.
    15. Autorisieren Sie das Token, um mit Ihrem Token auf Ressourcen zuzugreifen, die einer Organisation gehören, die Single Sign-on für SAML verwendet.
      Weitere Informationen hierzu finden Sie unter Persönliches Zugriffstoken zur Verwendung mit SAML Single Sign-on autorisieren.

    Erstellen Sie eine GitHub Enterprise Cloud-Verbindung

    Erstellen Sie eine Verbindung zwischen Ihren GitHub Enterprise Cloud-Anwendungen und Ihrer ServiceNow -Instanz.

    Vorbereitungen

    Wenn Sie einen MID-Server für die Kommunikation zwischen Ihrer Instanz ServiceNow und Ihren GitHub Enterprise Cloud-Anwendungen verwenden möchten, müssen Sie zuerst einen MID-Server in Ihrer Instanz einrichten. Ausführliche Anweisungen finden Sie unter MID-Server.

    ServiceNow Erforderliche Rolle: admin

    Prozedur

    1. Navigieren Sie in Ihrer Instanz von ServiceNow zu Prozessautomatisierung > Flow Designer.
      Die Registerkarte „Flow Designer“ wird erstellt.
    2. Wählen Sie die Registerkarte Verbindungen.
    3. Wählen Sie Details für Ihre GitHub -Verbindung anzeigen.
    4. Suchen Sie in der Liste der verfügbaren Verbindungen nach GitHub, und wählen Sie dann Konfigurierenaus.
    5. Füllen Sie die Felder im Dialogfeld „Verbindung konfigurieren“ aus.
      Tabelle : 2. Dialogfeld „Verbindung konfigurieren“.
      Feld Beschreibung
      Verbindungsname Name der GitHub -Verbindung.
      Verbindungs-URL URL des GitHub API-Endpunkts.

      Geben Sie https://api.github.comein.
      MID-Server verwenden Option, die Ihrer -Instanz ServiceNow die Verwendung eines MID-Server für die Kommunikation mit Ihren GitHub Enterprise Cloud-Anwendungen ermöglicht.
      • Wenn Ihre Instanz MID-Servererfordert, legen Sie dieses Feld auf truefest.
      • Lassen Sie dieses Feld leer, wenn für Ihre Instanz kein MID-Servererforderlich ist.
      Wichtig:
      Um diese Option zu aktivieren, müssen Sie in Ihrer -Instanz bereits ein -Element MID-Server eingerichtet haben. Ausführliche Anweisungen finden Sie unter MID-Server.
      API-Schlüssel Persönliches Zugriffstoken, mit dem Sie auf die Enterprise Cloud-API GitHub zugreifen können.
      • Wenn die installierte GitHub -Spoke-Version 2.2.5 oder höher ist, geben Sie ein<api-key> .
      • Wenn die installierte Spoke-Version GitHub niedriger als 2.2.5 ist, geben Sie Bearerein<api-key> .
      Der <api-key> ist das persönliche Zugriffstoken, das Sie in Generieren Sie ein API-Zugriffstoken für GitHub Enterprise Cloudgeneriert haben.
    6. Wählen Sie Verbindung konfigurierenaus.

    Erstellen Sie ein GitHub Enterprise Cloud-Integrationsprofil

    Erstellen Sie ein GitHub Enterprise Enterprise Cloud-Integrationsprofil, um -Softwareabonnements nachzuverfolgen und die Lizenzierung für Ihre GitHub Enterprise Cloud-Anwendungen zu optimieren.

    Vorbereitungen

    Zum Erstellen eines GitHub Enterprise Cloud-Integrationsprofils fordern Sie das Plugin Software Asset Management - SaaS-Lizenzmanagement (sn_sam_saas_int) im ServiceNow Storean.

    ServiceNow Erforderliche Rolle: sam_integrator oder admin

    Wichtig:
    Sie müssen das Kontrollkästchen GitHub-Spoke für diese Integration aktivieren, während Sie optionale Funktionen auf der Seite Application Manager installieren. Weitere Informationen zur Auswahl der erforderlichen SaaS-Anwendungen finden Sie unter SaaS-Lizenzmanagement anfordern.

    Warum und wann dieser Vorgang ausgeführt wird

    Wenn Sie Software-Asset-Arbeitsbereichverwenden, ist die Option zum Erstellen des Cloud-Integrationsprofils GitHub in Core-UI inaktiv.

    Prozedur

    1. Navigieren Sie zum -Integrationsprofil.
      SchnittstelleAktion
      Core-UI
      1. Navigieren zu Alle > Software Asset > SaaS-Lizenz > Profile für direkte Integration.
      2. Wählen Sie Neu.
      3. Wählen Sie GitHub-Cloud-Integrationsprofilaus.
      Software-Asset-Arbeitsbereich
      1. Navigieren zu Lizenzvorgänge > Anwenderabonnements > Direkte Integrationsprofile.
      2. Wählen Sie Neu.
      3. Wählen Sie in der Dropdown-Liste GitHub-Cloud aus.
      4. Wählen Sie Fortsetzen.
    2. Füllen Sie die Felder des Formulars aus.
      Tabelle : 3. Formular „Integrationsprofil“.
      Feld Beschreibung
      Anzeigename Name des Integrationsprofils. Beispiel: GitHub Cloud Integration.
      Status Status des Integrationsprofils.
      • Wenn Sie das Integrationsprofil nicht veröffentlicht haben, wird dieses Feld automatisch auf Entwurffestgelegt.
      • Wenn Sie das Integrationsprofil bereits veröffentlicht haben, wird dieses Feld automatisch auf Veröffentlichtgesetzt.
      Profiltyp Integrationsprofiltyp.

      Dieses Feld wird automatisch auf github_cloud_subscriptionfestgelegt.
    3. Überprüfen Sie die erforderlichen Anwenderrollen oder API-Berechtigungen, die im Feld Lieferantenkonfiguration für jeden Prozess angegeben sind, um Sicherheitsrisiken zu minimieren und SaaS -Lizenzen zu optimieren.
      Hinweis:
      Weitere Informationen finden Sie unter Tabelle der minimalen Benutzerberechtigungen.
      1. Stellen Sie im Abschnitt „Subflow zum Herunterladen des Abonnements“ sicher, dass das Feld „Subflow“ auf GitHub Cloud-Download-Abonnementsfestgelegt ist.
        Hinweis:
        Das Kontrollkästchen Abonnements herunterladen ist standardmäßig aktiviert und kann nicht deaktiviert werden.
        Software Asset Management ruft die Mitglieder, externen Mitarbeitenden, ausstehenden Einladungen und ausstehenden externen Mitarbeitenden ab, um eine vollständige Ansicht Ihrer GitHub Enterprise Cloud-Abonnements zu bieten.
        Wichtig:
        Um ausstehende externe Mitarbeitende abzurufen, aktivieren Sie die Systemeigenschaft sn_sam_saas_int.pull_pending_collaborator_github. Eine höhere Anzahl von Repositorys würde zu einer höheren Anzahl von API-Transaktionen führen.
      2. Stellen Sie im Abschnitt „Subflow für Aktivitätsberechnung“ sicher, dass das Feld „Subflow“ auf GitHub-Cloud-Update-Anwenderaktivitätfestgelegt ist.
        Hinweis:
        Das Kontrollkästchen Download-Aktivität ist standardmäßig aktiviert. Wenn Sie diese Option löschen, wird die geplante Aktivitätsaufgabe SAM - Refresh <displayname> Activity nicht erstellt.
        Im Feld Anwenderaktivität analysieren können Sie auch das Datum und die Uhrzeit auswählen, ab dem Sie die Anwenderaktivität analysieren möchten. Standardmäßig können Sie die Anwenderaktivität bis zu 60 Tage vor dem aktuellen Datum analysieren und Ereignisse anzeigen, die von einzelnen Anwendern ab dem Zeitpunkt der Erstellung dieses Profils durchgeführt wurden.
        Hinweis:
        Software Asset Management ruft die Ereignisse ab dem Zeitpunkt ab, zu dem Sie die Analyse der Anwenderaktivität starten, unabhängig vom Datum der Profilerstellung.
        Sie können diesen Wert im Feld Letzter Aktivitätsschwellenwert Ihrer Softwarereklamationsregeln ändern. Weitere Informationen finden Sie unter Überprüfen Sie eine Softwarereklamationsregel.
        Tipp:
        Um Leistungsprobleme mit diesem Subflow zu vermeiden, setzen Sie am besten das Feld Anwenderaktivität analysieren von auf maximal sieben Tage vor dem aktuellen Datum.
      3. Stellen Sie im Abschnitt „Subflow zum Zurückfordern des Abonnements“ sicher, dass das Feld „Subflow“ auf GitHub Cloud Reclaim Subscription (Abonnement zurückfordern)festgelegt ist.
        Hinweis:
        Das Kontrollkästchen Abonnements zurückfordern ist standardmäßig aktiviert. Wenn Sie Abonnements nicht zurückfordern möchten, können Sie dieses Kontrollkästchen deaktivieren. Wenn Sie diese Option löschen, werden die Entfernungskandidaten erstellt, aber der Subflow zum Zurückfordern des Abonnements wird nicht ausgelöst oder der Reklamationsprozess nicht initiiert.
    4. Wählen Sie Speichern.
      Ihre Instanz ServiceNow erstellt einen Integrationsprofilentwurf.

      Das Feld Verbindung und Anmeldeinformationen wird angezeigt und wird automatisch auf sn_github_spoke.GitHubfestgelegt.

    5. Wählen Sie im Formular „Integrationsprofil“ Verbindung validieren aus, um die Verbindungs- und Anmeldeinformationsdetails dieser Integration zu überprüfen.

      Durch das Validieren der Verbindung werden die APIs zum Herunterladen von Abonnements und zum Berechnen von Aktivitäten überprüft, nicht jedoch die APIs zum Zurückfordern von Abonnements.

    6. Nachdem die Verbindung verifiziert wurde, wählen Sie Veröffentlichenaus.
    7. Wählen Sie im Dialogfeld „Bestätigung veröffentlichen“ die Option OKaus.
      Hinweis:
      Wenn Sie das Kontrollkästchen Download-Aktivität deaktivieren, nachdem das Integrationsprofil veröffentlicht wurde, müssen Sie die Verbindungen erneut validieren und das Integrationsprofil anschließend erneut veröffentlichen, da die folgenden Ereignisse eintreten:
      • Das Feld Status im Formular „Integrationsprofil“ ändert sich in Entwurf.
      • Im Formular wird die Schaltfläche „Verbindung validieren“ angezeigt.
      • Der aktuelle Auftrag SAM - Refresh <displayname> Activity wird gelöscht.

    Nächste Maßnahme

    Nachdem die Integration hergestellt wurde, erstellt Ihre Instanz ServiceNow automatisch Softwaremodelle, Reklamationsregeln und Softwareabonnements, die täglich aktualisiert werden.

    Wenn Sie mehrere Integrationsprofile mit eindeutigen Verbindungen einrichten möchten, erstellen Sie untergeordnete Aliasse, um verschiedene Konfigurationen und Einstellungen für jedes Integrationsprofil zu verwalten. Weitere Informationen finden Sie unter Erstellen Sie einen untergeordneten Alias, um mehrere Integrationsprofile einzurichten.

    Überprüfen Sie alle automatisch generierten Reklamationsregeln, um Anwenderabonnements zurückzufordern. Weitere Informationen finden Sie unter Überprüfen Sie eine Softwarereklamationsregel.

    Erstellen Sie Softwareberechtigungen für die automatisch generierten Softwaremodelle, um verwendete Software im Vergleich zu eigener Software nachzuverfolgen.
    Der Abgleich wird für Ihre Abonnements auch als geplante Aufgabe oder bei Bedarf ausgeführt. Sie können Ihre Abgleichergebnisse in der Lizenz-Workbench (Software Asset Management klassische Anwendung) oder in der Ansicht Lizenznutzung (Software Asset Workspace) anzeigen. Verwenden Sie diese Ergebnisse, um Ihre Position bei der Lizenz-Compliance zu bestimmen und etwaige Nichteinhaltungen zu beheben.