Wartungsmodus aktivieren und planen

Für einige Standardwartungsprozeduren, beispielsweise für das Upgrade von Ihre GitHub Enterprise Server-Instance oder für das Wiederherstellen von Backups, muss die Instanz für die normale Verwendung offline genommen werden.

In diesem Artikel

Informationen zum Wartungsmodus

Bei einigen Vorgangstypen musst du Ihre GitHub Enterprise Server-Instance offlineschalten und in den Wartungsmodus versetzen:

  • Upgrade auf eine neue Version von GitHub Enterprise Server
  • Die der virtuellen Maschine zugeordneten CPU-, Arbeitsspeicher- oder Speicherressourcen erhöhen
  • Daten von einer virtuelle Maschine zu einer anderen migrieren
  • Daten aus einem GitHub Enterprise Server Backup Utilities-Snapshot wiederherstellen
  • Fehlerbehebung bei bestimmten Typen kritischer Anwendungsprobleme

Du solltest ein Wartungsfenster für mindestens 30 Minuten in der Zukunft planen, um Benutzern Vorbereitungszeit zu geben. Nach der Planung eines Wartungsfensters wird allen Benutzern beim Zugriff auf die Website ein Banner angezeigt.

Wenn sich die Instanz im Wartungsmodus befindet, wird der gesamte normale HTTP- und Git-Zugriff abgelehnt. Dazu gehören Web- und API-Anforderungen, auf die die Appliance mit Statuscode 503 (Dienst nicht verfügbar) antwortet. Abruf-, Klon- und Push-Vorgänge von Git werden ebenfalls mit einer Fehlermeldung abgelehnt, wonach die Site vorübergehend nicht verfügbar ist. Bei Konfigurationen mit Hochverfügbarkeit wird die Git-Replikation angehalten. werden GitHub Actions-Aufträge nicht ausgeführt. Wenn die Website in einem Browser aufgerufen wird, wird eine Wartungsseite angezeigt.

Du kannst die anfängliche Überprüfung deines Wartungsvorgangs durchführen, indem du eine IP-Ausnahmeliste konfigurierst, um den Zugriff auf Ihre GitHub Enterprise Server-Instance nur von den angegebenen IP-Adressen und Bereichen aus zu ermöglichen. Zugriffsversuche auf Ihre GitHub Enterprise Server-Instance über IP-Adressen, die nicht in der IP-Ausnahmeliste angegeben sind, erhalten dieselbe Antwort, die auch gesendet wird, wenn sich die Instanz im Wartungsmodus befindet.

Wartungsmodus sofort aktiviert oder Wartungsfenster für späteren Zeitpunkt planen

  1. Klicke in einem Verwaltungskonto auf GitHub Enterprise Server und dann in der rechten oberen Ecke einer beliebigen Seite auf „“.

  2. Wenn du dich nicht bereits auf der Seite „Websiteadministrator“ befindest, klicke in der oberen linken Ecke auf Websiteadministrator.

  3. Wähle auf der Randleiste „ Websiteadministrator“ die Option Verwaltungskonsole aus.

  4. Klicke auf der oberen Navigationsleiste auf Wartung.

    Screenshot der Kopfzeile der Verwaltungskonsole. Eine Registerkarte mit der Bezeichnung „Wartung“ ist orange umrandet.

  5. Wählen Sie unter "Aktivieren und planen" die Option Wartungsmodus aktivieren aus und entscheiden Sie dann , ob der Wartungsmodus sofort aktiviert oder ein Wartungsfenster für einen späteren Zeitpunkt geplant werden soll.

    • Wähle zum sofortigen Aktivieren des Wartungsmodus das Dropdownmenü aus, und klicke auf Jetzt.
    • Wenn du ein Wartungsfenster für einen künftigen Zeitpunkt planen möchtest, wähle das Dropdownmenü aus, und klicke auf eine Startzeit.

  6. Wenn Sie optional eine benutzerdefinierte Nachricht festlegen möchten, die Benutzern während des Wartungsfensters angezeigt werden soll, geben Sie im Feld "Wartungsmodusnachricht festlegen" eine Nachricht ein.

  7. Wenn Sie mit der Anzeigedauer des Fensters und der optionalen Meldung zufrieden sind, klicken Sie auf Speichern. Wenn Sie "Jetzt" ausgewählt haben, wird Ihre Instanz sofort in den Wartungsmodus versetzt.

Überprüfen von Änderungen im Wartungsmodus mithilfe der IP-Ausnahmeliste

Die IP-Ausnahmeliste bietet kontrollierten und eingeschränkten Zugriff auf Ihre GitHub Enterprise Server-Instance und eignet sich daher ideal für die anfängliche Überprüfung der Serverintegrität nach einem Wartungsvorgang. Nach der Aktivierung wird Ihre GitHub Enterprise Server-Instance aus dem Wartungsmodus entfernt und steht nur für die konfigurierten IP-Adressen zur Verfügung. Das Kontrollkästchen für den Wartungsmodus wird aktualisiert und spiegelt die Zustandsänderung wider.

Wenn du den Wartungsmodus erneut aktivierst, wird die IP-Ausnahmeliste deaktiviert, und Ihre GitHub Enterprise Server-Instance kehrt zum Wartungsmodus zurück. Wenn du einfach die IP-Ausnahmeliste deaktivierst, kehrt Ihre GitHub Enterprise Server-Instance zum normalen Vorgang zurück.

Du kannst auch ein Befehlszeilen-Hilfsprogramm verwenden, um die IP-Ausnahmeliste zu konfigurieren. Weitere Informationen findest du unter Befehlszeilenprogramme und Auf die Verwaltungsshell (SSH) zugreifen.

  1. Klicke in einem Verwaltungskonto auf GitHub Enterprise Server und dann in der rechten oberen Ecke einer beliebigen Seite auf „“.

  2. Wenn du dich nicht bereits auf der Seite „Websiteadministrator“ befindest, klicke in der oberen linken Ecke auf Websiteadministrator.

  3. Wähle auf der Randleiste „ Websiteadministrator“ die Option Verwaltungskonsole aus.

  4. Klicke auf der oberen Navigationsleiste auf Wartung, und vergewissere dich, dass der Wartungsmodus bereits aktiviert ist.

    Screenshot der Kopfzeile der Verwaltungskonsole. Eine Registerkarte mit der Bezeichnung „Wartung“ ist orange umrandet.

  5. Wähle unter „IP-Ausnahmeliste aktivieren und konfigurieren“ die Option IP-Ausnahmeliste aktivieren aus.

  6. Gib rechts neben dem Kontrollkästchen zum Aktivieren der Liste eine gültige Liste mit durch Leerzeichen getrennten IP-Adressen oder CIDR-Blöcken ein, denen der Zugriff auf Ihre GitHub Enterprise Server-Instance gestattet werden soll.

  7. Wenn Sie optional eine benutzerdefinierte Nachricht festlegen möchten, die Benutzern während des Wartungsfensters angezeigt werden soll, geben Sie im Feld "Wartungsmodusnachricht festlegen" eine Nachricht ein.

  8. Klicken Sie auf Speichern.

Verwalten des Wartungsmodus mithilfe der REST-API

Sie können den Wartungsmodus für Ihre GitHub Enterprise Server-Instance mithilfe der REST-API verwalten. Weitere Informationen finden Sie unter REST-API-Endpunkte zum Verwalten von GitHub Enterprise Server.

Verwalten des Wartungsmodus mit den GitHub CLI

Sie können Wartungsmodus für Ihre GitHub Enterprise Server-Instance mithilfe der GitHub CLI gh es-Erweiterung verwalten. Weitere Informationen finden Sie in der Dokumentation zur Verwendung von GH ES CLI für gh es maintenance set und gh es maintenance get.

Weitere Informationen finden Sie unter Verwalten Ihrer Instanz mithilfe der GitHub CLI.

Verwalten des Wartungsmodus mit SSH

Wenn Sie über SSH-Zugriff verfügen, können Sie das ghe-maintenance-Befehlszeilen-Hilfsprogramm verwenden, um den Wartungsmodus für eine GitHub Enterprise Server-Instanz mit einem Knoten oder für mehrere Knoten in einer Hochverfügbarkeitskonfiguration zu aktivieren oder zu deaktivieren. Weitere Informationen findest du unter Auf die Verwaltungsshell (SSH) zugreifen und Befehlszeilenprogramme.

Verwalten des Wartungsmodus für einen Cluster mithilfe von SSH

Wenn Sie über SSH-Zugriff auf Ihre GitHub Enterprise Server-Instanz verfügen, können Sie das ghe-cluster-maintenance-Befehlszeilen-Hilfsprogramm verwenden, um für jeden Knoten in einem Cluster den Wartungsmodus festzulegen oder abzugleichen. Weitere Informationen findest du unter Auf die Verwaltungsshell (SSH) zugreifen und Befehlszeilenprogramme.

$ ghe-cluster-maintenance -h
# Shows options
$ ghe-cluster-maintenance -q
# Queries the current mode
$ ghe-cluster-maintenance -s
# Sets maintenance mode
$ ghe-cluster-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-cluster-maintenance -m "MESSAGE"
# Updates the custom message
$ ghe-cluster-maintenance -u
# Unsets maintenance mode