Automatische Skalierung mit selbstgehosteten Runnern

Du kannst deine selbstgehosteten Runner als Reaktion auf Webhookereignisse automatisch skalieren.

In diesem Artikel

Note

Auf GitHub gehostete Runner werden aktuell nicht auf GitHub Enterprise Server unterstützt. Weitere Informationen zur geplanten zukünftigen Unterstützung findest Du in der GitHub public roadmap.

Informationen zur automatischen Skalierung

Du kannst die Anzahl selbstgehosteter Runner in deiner Umgebung als Reaktion auf Webhookereignisse, die du mit einer bestimmten Bezeichnung erhältst, automatisch erhöhen oder verringern. Beispielsweise kannst du eine Automatisierung erstellen, die jedes Mal einen neuen selbstgehosteten Runner hinzufügt, wenn du ein workflow_job-Webhookereignis mit der queued-Aktivität erhältst, wodurch du darüber benachrichtigt wirst, dass ein neuer Auftrag verarbeitet werden kann. Die Webhooknutzdaten enthalten Bezeichnungsdaten, damit du die Art des Runners identifizieren kannst, den der Auftrag anfordert. Nachdem der Auftrag abgeschlossen ist, kannst du eine Automatisierung erstellen, durch die der Runner als Reaktion auf die workflow_job-completed-Aktivität entfernt wird.

Unterstützte Lösungen für automatische Skalierung

Das Projekt actions-runner-controller (ARC) ist ein Kubernetes-basierter Runner-Autoskalierer. GitHub empfiehlt ARC, wenn das Team, das es bereitstellt, über Expertenwissen und -erfahrung verfügt.

Weitere Informationen findest du unter Informationen zum Actions Runner Controller und Informationen zur Unterstützung von Actions Runner Controller.

Verwenden von kurzlebigen Runnern für die automatische Skalierung

GitHub empfiehlt die Implementierung der automatischen Skalierung mit kurzlebigen selbstgehosteten Runnern. Die automatische Skalierung mit beständigen selbstgehosteten Runnern wird nicht empfohlen. In bestimmten Fällen kann GitHub nicht garantieren, dass Aufträge keinen beständigen Runnern zugewiesen werden, während sie heruntergefahren werden. Bei kurzlebigen Runnern kann dies garantiert werden, da GitHub nur einen Auftrag pro Runner zuweist.

Mit diesem Ansatz kannst du deine Runner als kurzlebige Systeme verwalten, da du die Automatisierung dafür verwenden kannst, eine bereinigte Umgebung für jeden Auftrag bereitzustellen. Dadurch kann die Gefährdung von vertraulichen Ressourcen aus vorherigen Aufträgen begrenzt und auch das Risiko der Kompromittierung eines Runners, der neue Aufträge erhält, verringert werden.

Warning

Die Runner-Anwendungsprotokolldateien für kurzlebige Runner müssen zur Problembehandlung und Diagnose an eine externe Protokollspeicherlösung weitergeleitet werden. Es ist zwar nicht erforderlich, dass kurzlebige Runner bereitgestellt werden, GitHub empfiehlt jedoch, sicherzustellen, dass Runner-Protokolle extern weitergeleitet und beibehalten werden, bevor sie eine kurzlebige Autokalierungslösung in einer Produktionsumgebung bereitstellen. Weitere Informationen finden Sie unter Überwachen und Behandeln von Problemen mit selbstgehosteten Runnern.

Wenn du deiner Umgebung einen kurzlebigen Runner hinzufügen möchtest, füge den --ephemeral-Parameter beim Registrieren deines Runners mit config.sh ein. Beispiel:

./config.sh --url https://github.com/octo-org --token example-token --ephemeral

Der GitHub Actions-Dienst hebt die Registrierung des Runners automatisch auf, nachdem ein Auftrag verarbeitet wurde. Anschließend kannst du deine eigene Automatisierung erstellen, die den Runner löscht, sobald die Registrierung aufgehoben wurde.

Note

Wenn ein Auftrag für eine bestimmte Art von Runner gekennzeichnet ist, aber kein passender Runner verfügbar ist, schlägt der Auftrag nicht sofort in der Warteschlange fehl. Stattdessen bleibt der Auftrag bis zum Ablauf des Timeoutzeitraums von 24 Stunden in der Warteschlange.

Alternativ kannst du mit der REST-API kurzlebige Just-In-Time-Runner erstellen. Weitere Informationen finden Sie unter REST-API-Endpunkte für selbst gehostete Runner.

Steuern von Softwareupdates für selbstgehostete Runner

Standardmäßig werden Softwareupdates für selbstgehostete Runner automatisch ausgeführt, wenn eine neue Version der Runnersoftware verfügbar ist. Wenn du kurzlebige Runner in Containern verwendest, kann dies bei der Veröffentlichung einer neuen Runnerversion zu wiederholten Softwareupdates führen. Durch das Deaktivieren automatischer Updates kannst du die Runnerversion im Containerimage direkt zum gewünschten Zeitpunkt aktualisieren.

Um automatische Softwareupdates zu deaktivieren und sie selbst zu installieren, musst du das Flag --disableupdate beim Registrieren deines Runners mit config.sh angeben. Beispiel:

./config.sh --url https://github.com/YOUR-ORGANIZATION --token EXAMPLE-TOKEN --disableupdate

Auch wenn du automatische Updates deaktivierst, musst du deine Runnerversion regelmäßig aktualisieren. Aufgrund der neuen Funktion in GitHub Actions müssen sowohl am GitHub Actions-Dienst als auch an der Runnersoftware Änderungen vorgenommen werden. Ohne ein Softwareupdate kann der Runner möglicherweise keine Aufträge verarbeiten, bei denen die neuen Features in GitHub Actions verwendet werden.

Wenn du automatische Updates deaktivierst, musst du deine Runnerversion innerhalb von 30 Tagen nach der Veröffentlichung einer neuen Version aktualisieren. Du solltest die Benachrichtigungen zu Releases im actions/runner-Repository abonnieren. Weitere Informationen finden Sie unter Benachrichtigungen konfigurieren.

Anweisungen zum Installieren der neuesten Runnerversion findest du in den Installationsanweisungen für das neueste Release.

Warning

Alle Updates, die für die Software veröffentlicht werden, einschließlich Haupt-, Neben- oder Patch-Versionen, werden als verfügbares Update betrachtet. Wenn Sie innerhalb von 30 Tagen kein Softwareupdate durchführen, reiht der GitHub Actions-Dienst keine Aufträge in die Warteschlange Ihres Runners ein. Wenn ein kritisches Sicherheitsupdate durchgeführt werden muss, reiht der GitHub Actions-Dienst keine Aufträge in die Warteschlange deines Runners ein, bis dieser aktualisiert wurde.

Verwenden von Webhooks für die automatische Skalierung

Du kannst mithilfe der vom workflow_job-Webhook empfangenen Nutzdaten deine eigene Umgebung für die automatische Skalierung erstellen. Dieser Webhook ist auf Repository-, Organisations- und Unternehmensebene verfügbar, und die Nutzdaten für dieses Ereignis enthalten einen action-Schlüssel, der den Phasen des Lebenszyklus eines Workflowauftrags entspricht, z. B. wenn Aufträge queued, in_progress und completed sind. Anschließend musst du deine eigene Skalierungsautomatisierung als Reaktion auf diese Webhooknutzdaten erstellen.

Authentifizierungsanforderungen

Du kannst selbstgehostete Runner für Repositorys und Organisationen mit der API registrieren und löschen. Deine Implementierung für die automatische Skalierung kann ein Zugriffstoken oder eine GitHub-App verwenden, um sich bei der API zu authentifizieren.

Dein Zugriffstoken benötigt den folgenden Geltungsbereich:

Um sich mithilfe einer GitHub-App zu authentifizieren, muss sie über die folgenden Berechtigungen verfügen:

  • Weise für Repositorys die Berechtigung administration zu.
  • Weise für Organisationen die Berechtigung organization_self_hosted_runners zu.

Du kannst selbstgehostete Runner für Unternehmen mithilfe der API registrieren und löschen. Die Implementierung zur automatischen Skalierung kann ein Zugriffstoken verwenden, um sich bei der API zu authentifizieren.

Dein Zugriffstoken benötigt den manage_runners:enterprise-Geltungsbereich.