Informationen zu selbstgehosteten Runnern für GitHub Actions
GitHub Actions ermöglicht Personen, die deine GitHub Enterprise Server-Instanz verwenden, die Produktivität zu verbessern, indem jede Phase des Softwareentwicklungsworkflows automatisiert wird. Weitere Informationen findest du unter Informationen zu GitHub Actions für Unternehmen.
Mit GitHub Actions können Entwickler einzelne Tasks schreiben und kombinieren, sogenannte Aktionen, um benutzerdefinierte Workflows zu erstellen. Um GitHub Actions für deine GitHub Enterprise Server-Instanzzu aktivieren, musst du mindestens einen Computer für die Ausführung von Aufträgen hosten. Dieser Computer wird als selbstgehosteter Runner bezeichnet. Selbstgehostete Runner können physisch, virtuell, in einem Container, lokal oder in einer Cloud sein. Your runner machine connects to GitHub using the GitHub Actions self-hosted runner application. Selbstgehostete Runner können Linux, Windows oder macOS ausführen. Weitere Informationen findest du unter Informationen zu selbstgehosteten Runnern.
In diesem Leitfaden erfährst du, wie du einen zentralisierten Verwaltungsansatz für selbstgehostete Runner für GitHub Actions in deinem Unternehmen umsetzt. Für diesen Leitfaden wirst du die folgenden Aufgaben ausführen:
- Konfigurieren einer eingeschränkte Richtlinie, um die Aktionen, die innerhalb deines Unternehmens ausgeführt werden können
- Bereitstellen eines selbstgehosteten Runners für dein Unternehmen
- Erstellen einer Gruppe zum Verwalten des Zugriffs auf die für dein Unternehmen verfügbaren Runner
- Optionales weiteres Einschränken der Repositorys, die den Runner verwenden können
- Optionales Erstellen benutzerdefinierter Tools, um deine selbstgehosteten Runner automatisch zu skalieren
Darüber hinaus findest du hier weitere Informationen zum Überwachen und Sichern deiner selbstgehosteten Runner, zum Zugreifen auf Aktionen aus GitHub.com sowie zum Anpassen der Software auf deinen Runnercomputern.
Nachdem du den Leitfaden durchgearbeitet hast, Benutzer von deine GitHub Enterprise Server-Instanz Workflowaufträge aus GitHub Actions auf einem selbstgehosteten Runnercomputer ausführen.
Voraussetzungen
-
GitHub Actions müssen für GitHub Enterprise Server aktiviert sein. Ein Websiteadministrator kann GitHub Actions für deine Instanz aktivieren und konfigurieren. Weitere Informationen findest du unter Erste Schritte mit GitHub Actions für GitHub Enterprise Server.
-
Du musst Zugriff auf den Computer haben, den du als selbst gehosteten Runner in deiner Umgebung verwendest.
-
Die Verbindung zwischen selbstgehosteten Runnern und GitHub Enterprise Server verläuft über HTTP (Port 80) oder HTTPS (Port 443). Um die Konnektivität über HTTPS sicherzustellen, konfiguriere TLS für deine GitHub Enterprise Server-Instanz. Weitere Informationen findest du unter TLS konfigurieren. Weitere Informationen findest du unter Informationen zu selbstgehosteten Runnern.
-
Dein Unternehmen muss über mindestens eine Organisation verfügen. Weitere Informationen findest du unter Informationen zu Organisationen und unter Eine neue Organisation von Grund auf erstellen.
1. Konfigurieren von Richtlinien für GitHub Actions
Aktiviere zunächst GitHub Actions für alle Organisationen, und konfiguriere eine Richtlinie, um die Aktionen einzuschränken, die auf deine GitHub Enterprise Server-Instanz ausgeführt werden können. Optional können Organisationsbesitzer*innen diese Richtlinien für jede Organisation weiter einschränken.
-
Klicke oben rechts auf GitHub Enterprise Server auf dein Profilfoto und dann auf Unternehmenseinstellungen.
-
Wähle auf der Randleiste des Unternehmenskontos die Option Richtlinien aus. 1. Klicke unter „ Richtlinien“ auf Aktionen.
-
Wähle unter „Richtlinien“ die Option Für alle Organisationen aktivieren aus.
-
Wähle Ausgewählte Aktionen zulassen und dann Von GitHub erstellte Aktionen zulassen aus, um lokale Aktionen sowie Aktionen zuzulassen, die von GitHub erstellt wurden.
-
Klicke auf Speichern.
Du kannst zusätzliche Richtlinien konfigurieren, um die für Benutzer von deine GitHub Enterprise Server-Instanz verfügbaren Aktionen einzuschränken. Weitere Informationen findest du unter Erzwingen von Richtlinien für GitHub Actions in deinem Unternehmen.
2. Bereitstellen des selbstgehosteten Runners für dein Unternehmen
Füge deinem Unternehmen als Nächstes einen selbstgehosteten Runner hinzu. GitHub Enterprise Server leitet dich durch die Installation der erforderlichen Software auf dem Runnercomputer. Nachdem du den Runner bereitgestellt hast, kannst du die Konnektivität zwischen dem Runnercomputer und deine GitHub Enterprise Server-Instanz überprüfen.
Hinzufügen des selbstgehosteten Runners
-
Klicke oben rechts auf GitHub Enterprise Server auf dein Profilfoto und dann auf Unternehmenseinstellungen.
-
Wähle auf der Randleiste des Unternehmenskontos die Option Richtlinien aus. 1. Klicke unter „ Richtlinien“ auf Aktionen. 1. Klicke auf die Registerkarte Runner. 1. Klicke auf Neuer Runner. 1. Wähle das Betriebssystemimage und die Architektur deines selbstgehosteten Runnercomputers aus.
-
Du wirst Anweisungen sehen, wie Du die Läuferanwendung herunterlädst und sie auf Deiner selbst-gehosteten Läufermaschine installierst.
Öffne eine Shell auf Deiner selbst-gehosteten Läufermaschine und führe jeden Shell-Befehl in der angezeigten Reihenfolge aus.
Hinweis: Wenn du unter Windows die selbstgehostete Runneranwendung als Dienst installieren möchtest, musst du eine Shell mit Administratorberechtigungen öffnen. Auch wird empfohlen, dass du
C:\actions-runner
als Verzeichnis für die selbstgehostete Runneranwendung verwendest, damit Windows-Systemkonten auf das Runnerverzeichnis zugreifen können.Die Anweisungen führen Dich durch die Vervollständigung dieser Aufgaben:
- Herunterladen und Extrahieren der selbst-gehosteten Läuferanwendung.
- Ausführen des
config
-Skripts zum Konfigurieren der selbstgehosteten Runneranwendung und die Registrierung mit GitHub Actions Dasconfig
-Skript benötigt die Ziel-URL und ein automatisch generiertes, zeitlich begrenztes Token, um die Anforderung zu authentifizieren.- Unter Windows fragt das
config
-Skript auch, ob du die selbstgehostete Runneranwendung als Dienst installieren möchtest. Für Linux und macOS kannst Du einen Dienst installieren, nachdem Du das Hinzufügen des Läufers beendet hast. Weitere Informationen findest du unter Die Anwendung für selbst-gehostete Runner als Dienst konfigurieren.
- Unter Windows fragt das
- Ausführen der selbst-gehosteten Läuferanwendung zum Verbinden der Maschine mit GitHub Actions.
Überprüfung dass dein selbst-gehosteter Läufer erfolgreich hinzugefügt wurde
Nach Abschluss der Schritte zum Hinzufügen eines selbst gehosteten Runners werden der Runner und sein Status jetzt unter „Selbst-gehostete Runner“ aufgeführt.
Die selbst-gehostete Läuferanwendung muss aktiv sein, damit der Läufer Aufträge annehmen kann. Wenn die Runner-Anwendung mit GitHub Enterprise Server verbunden und bereit ist, Aufträge zu empfangen, siehst du die folgende Meldung auf dem Terminal des Computers.
√ Connected to GitHub
2019-10-24 05:45:56Z: Listening for Jobs
3. Verwalten des Zugriffs auf den selbstgehosteten Runner mithilfe einer Gruppe
Du kannst eine Runnergruppe erstellen, um den Zugriff auf den Runner zu verwalten, den du deinem Unternehmen hinzugefügt hast. Mithilfe der Gruppe kannst du auswählen, welche Organisationen Aufträge aus GitHub Actions auf dem Runner ausführen können.
GitHub Enterprise Server fügt alle neuen Runner einer Gruppe hinzu. Runner können nur jeweils einer Gruppe zugewiesen werden. Standardmäßig fügt GitHub Enterprise Server alle neuen Runner einer Gruppe „Standard“ hinzu.
-
Klicke oben rechts auf GitHub Enterprise Server auf dein Profilfoto und dann auf Unternehmenseinstellungen.
-
Wähle auf der Randleiste des Unternehmenskontos die Option Richtlinien aus. 1. Klicke unter „ Richtlinien“ auf Aktionen. 1. Klicke auf die Registerkarte Runnergruppen.
-
Klicke auf Neue Runner-Gruppe.
-
Gib unter „Gruppenname" einen Namen für deine Runner-Gruppe ein.
-
Um eine Richtlinie für den Organisationszugriff auszuwählen, musst du unter Organisationszugriff das Dropdownmenü „Organisation“ öffnen und auf Ausgewählte Organisationen klicken.
-
Klicke rechts neben dem Dropdownmenü mit der Organisationszugriffsrichtlinie auf .
-
Wähle die Organisationen aus, denen du Zugriff auf die Runnergruppe gewähren möchtest.
-
Um öffentlichen Repositorys in den ausgewählten Organisationen optional die Verwendung von Runnern in der Gruppe zu erlauben, wähle Öffentliche Repositorys zulassen aus.
Warnung:
Es wird empfohlen, nur selbstgehostete Runner mit privaten Repositorys zu verwenden. Der Grund hierfür liegt darin, dass Forks deines öffentlichen Repositorys möglicherweise gefährlichen Code auf deinem selbstgehosteten Runnercomputer ausführen können, indem sie einen Pull Request erstellen, der den Code in einem Workflow ausführt.
Weitere Informationen findest du unter Informationen zu selbstgehosteten Runnern.
-
Klicke auf die Registerkarte „Runner“.
-
Klicke in der Liste der Runner auf den Runner, den du im vorherigen Abschnitt bereitgestellt hast.
-
Klicke auf Bearbeiten.
-
Klicke auf Runnergruppen .
-
Klicke in der Liste der Runnergruppen auf den Namen der zuvor erstellten Gruppe.
-
Klicke auf Speichern, um den Runner in die Gruppe zu verschieben.
Du hast jetzt einen selbstgehosteten Runner bereitgestellt, der Aufträge aus GitHub Actions in den von dir angegebenen Organisationen ausführen kann.
4. Einschränken des Zugriffs auf den selbstgehosteten Runner
Optional können Organisationsbesitzerinnen die Zugriffsrichtlinie der von dir erstellten Runnergruppe weiter einschränken. Beispielsweise kann eine Organisationsbesitzer*in nur bestimmten Repositorys in der Organisation erlauben, die Runnergruppe zu verwenden.
Weitere Informationen findest du unter Verwalten des Zugriffs auf selbstgehostete Runner mithilfe von Gruppen.
5. Automatisches Skalieren deines selbstgehosteten Runners
Optional kannst du benutzerdefinierte Tools erstellen, um die selbstgehosteten Runner automatisch für deine GitHub Enterprise Server-Instanz zu skalieren. Deine Tools können beispielsweise auf Webhookereignisse von deine GitHub Enterprise Server-Instanz reagieren, um automatisch einen Cluster von Runnercomputern zu skalieren. Weitere Informationen findest du unter Automatische Skalierung mit selbstgehosteten Runnern.
Nächste Schritte
-
Du kannst selbstgehostete Runner überwachen und häufige Probleme beheben. Weitere Informationen findest du unter Überwachen und Behandeln von Problemen mit selbstgehosteten Runnern.
-
GitHub empfiehlt, die Sicherheitshinweise für selbstgehostete Runnercomputer zu lesen. Weitere Informationen findest du unter Sicherheitshärtung für GitHub Actions.
-
Du kannst Repositorys, die Aktionen für dein Unternehmen auf GitHub Enterprise Server enthalten, manuell auf GitHub.com synchronisieren. Stattdessen kannst du Mitgliedern deines Unternehmens mithilfe von GitHub Connect den automatischen Zugriff auf Aktionen aus GitHub.com erlauben. Weitere Informationen findest du unter folgenden Themen.
-
Du kannst die auf deinen selbstgehosteten Runnercomputern verfügbare Software anpassen oder deine Runner so konfigurieren, dass für Kunden, die GitHub.com verwenden, Software verfügbar ist, die von GitHub gehosteten Runnern ähnelt. Die Software, die den Runnercomputern für GitHub Actions zugrunde liegt, ist Open Source. Weitere Informationen findest du in den Repositorys
actions/runner
undactions/runner-images
.