GitHub-App konfigurieren

In Umgebungen, die GitHub verwenden, können Sie den neuen GitHub-App-Authentifizierungsanbieter in Rancher konfigurieren, der es Benutzern ermöglicht, sich mit einem GitHub-Organisationskonto über eine dedizierte GitHub-App zu authentifizieren. Dieser neue Anbieter läuft neben dem bestehenden Standard-GitHub-Authentifizierungsanbieter und bietet erhöhte Sicherheit sowie eine bessere Verwaltung der Berechtigungen basierend auf den Teams der GitHub-Organisation.

Voraussetzungen

Der GitHub-App-Authentifizierungsanbieter funktioniert nur mit GitHub-Organisationskonten. Er funktioniert nicht mit individuellen GitHub-Benutzerkonten.

Bevor Sie den Anbieter in Rancher konfigurieren, müssen Sie zunächst eine GitHub-App für Ihre Organisation erstellen, ein Client-Geheimnis für Ihre GitHub-App generieren und einen privaten Schlüssel für Ihre GitHub-App erstellen. Siehe Registrierung einer GitHub-App für Details.

GitHub-App erstellen

  1. Öffnen Sie Ihre GitHub-Organisationseinstellungen.

  2. Rechts von der Organisation wählen Sie Einstellungen aus.

  3. Klicken Sie im linken Seitenbereich auf Entwicklereinstellungen > GitHub-Apps.

  4. Klicken Sie auf Neue GitHub-App.

  5. Füllen Sie das Konfigurationsformular für die GitHub-App mit diesen Werten aus:

    • GitHub-App-Name: Alles, was Sie möchten, z.B. My Rancher.

    • Anwendungsbeschreibung: Optional, kann leer gelassen werden.

    • Homepage-URL: https://localhost:8443.

    • Callback-URL: https://localhost:8443/verify-auth.

  6. Wählen Sie GitHub-App erstellen aus.

Generieren Sie ein Client-Geheimnis

Generieren Sie ein Client-Geheimnis auf der Einstellungsseite Ihrer App.

  1. Gehen Sie zu Ihrer GitHub-App.

  2. Neben Client-Geheimnissen wählen Sie Ein neues Client-Geheimnis generieren aus.

Generieren Sie einen privaten Schlüssel

Generieren Sie einen privaten Schlüssel auf der Einstellungsseite Ihrer App.

  1. Gehen Sie zu Ihrer GitHub-App.

  2. Neben Privaten Schlüsseln klicken Sie auf Privaten Schlüssel generieren.

Konfiguration des GitHub-App-Auth-Anbieters

Um den GitHub-App-Auth-Anbieter in Rancher einzurichten, befolgen Sie diese Schritte:

  1. Navigieren Sie zum Abschnitt Benutzer & Authentifizierung in der Rancher-Benutzeroberfläche.

  2. Wählen Sie Auth-Anbieter aus.

  3. Wählen Sie die Kachel GitHub-App aus.

  4. Sammeln und geben Sie die Details Ihrer GitHub-App in die Felder des Konfigurationsformulars ein.

    Feldname Beschreibung

    Client-ID (Erforderlich)

    Die Client-ID Ihrer GitHub-App.

    Client-Geheimnis (Erforderlich)

    Das Client-Geheimnis Ihrer GitHub-App.

    GitHub-App-ID (Erforderlich)

    Die numerische ID, die mit Ihrer GitHub-App verknüpft ist.

    Installations-ID (Optional)

    Wenn Sie die Authentifizierung auf eine einzelne Installation der App beschränken möchten, geben Sie die spezifische numerische Installations-ID an.

    Privater Schlüssel (Erforderlich)

    Der Inhalt der Datei mit dem privaten Schlüssel (im PEM-Format), die von GitHub für Ihre GitHub-App generiert wurde.

    Eine GitHub-App kann in mehreren Organisationen installiert werden, und jede Installation hat eine eindeutige Installations-ID. Wenn Sie die Authentifizierung auf eine einzelne App-Installation und GitHub-Organisation beschränken möchten, geben Sie die Installations-ID während der Konfiguration an. Wenn Sie keine Installations-ID angeben, werden die Berechtigungen des Benutzers über alle Installationen aggregiert.

  5. Wählen Sie Aktivieren aus. Rancher versucht, die Anmeldeinformationen zu validieren, und aktiviert bei Erfolg den GitHub-App-Anbieter.

Nachdem es aktiviert wurde, werden Benutzer, die sich über den GitHub-App-Anbieter anmelden, automatisch identifiziert, und Sie können die Teams und Benutzer Ihrer GitHub-Organisation nutzen, um die rollenbasierte Zugriffskontrolle (RBAC) zu konfigurieren und Berechtigungen für Projekte und Cluster zuzuweisen.

Stellen Sie sicher, dass die Benutzer und Teams, die Sie für die Autorisierung verwenden möchten, innerhalb der GitHub-Organisation existieren, die von der GitHub-App verwaltet wird.

  • Benutzer: Einzelne GitHub-Benutzer, die Mitglieder der GitHub-Organisation sind, in der die GitHub-App installiert ist, können sich anmelden.

  • Gruppen: Die Teams der GitHub-Organisation werden den Rancher-Gruppen zugeordnet, sodass Sie gesamten Teams Berechtigungen innerhalb von Rancher-Projekten und -Clustern zuweisen können.