Wartungsmodus aktivieren und planen

Einige Standardwartungsverfahren, z. B. das Aktualisieren Ihre GitHub Enterprise Server-Instance oder Wiederherstellen von Sicherungen, erfordern, dass die Instanz für die normale Verwendung offline geschaltet wird.

In diesem Artikel

Informationen zum Wartungsmodus

Einige Vorgänge erfordern, dass Sie Ihre GitHub Enterprise Server-Instance offline nehmen und in den Wartungsmodus versetzen:

  • Aktualisierung 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
  • Wiederherstellen von Daten aus einem GitHub Enterprise Server Backup Utilities Snapshot
  • 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. Git-Abruf-, -Klon- und -Push-Vorgänge werden ebenfalls mit einer Fehlermeldung abgelehnt, die angibt, dass die Webseite temporär nicht verfügbar ist. GitHub Actions Aufträge werden nicht ausgeführt. Wenn die Website in einem Browser aufgerufen wird, wird eine Wartungsseite angezeigt.

Sie können eine erste Validierung Ihres Wartungsvorgangs durchführen, indem Sie eine IP-Ausnahmeliste konfigurieren, um den Zugriff auf Ihre GitHub Enterprise Server-Instance ausschließlich von den angegebenen IP-Adressen und -Bereichen aus zuzulassen. Versuche, von IP-Adressen zuzugreifen Ihre GitHub Enterprise Server-Instance , die nicht in der IP-Ausnahmeliste angegeben sind, erhalten eine Antwort, die mit den gesendeten Adressen übereinstimmt, wenn sich die Instanz im Wartungsmodus befindet.

Aktivieren des Wartungsmodus sofort oder Planen eines Wartungsfensters für einen späteren Zeitpunkt.

  1. Klicke in einem Verwaltungskonto für GitHub Enterprise Server 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. Klicke in der Randleiste „ Site admin“ auf Verwaltungskonsole.

  4. Klicke auf der oberen Navigationsleiste auf Wartung.

    Screenshot der Kopfzeile von Verwaltungskonsole. Die Registerkarte mit der Bezeichnung „Wartung“ ist mit einem orangefarbenen Rahmen hervorgehoben.

  5. Wähle unter „Aktivieren und planen“ die Option Wartungsmodus aktivieren aus, und entscheide dann, ob der Wartungsmodus sofort aktiviert oder ein Wartungsfenster für einen künftigen 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, eingeschränkten Zugriff auf Ihre GitHub Enterprise Server-Instance, was sich ideal für die erste Überprüfung des Serverzustands nach einer Wartungsmaßnahme eignet. Nach der Aktivierung Ihre GitHub Enterprise Server-Instance wird der Wartungsmodus aufgehoben und nur für die konfigurierten IP-Adressen verfügbar. Das Kontrollkästchen für den Wartungsmodus wird aktualisiert und spiegelt die Zustandsänderung wider.

Wenn Sie den Wartungsmodus wieder aktivieren, wird die IP-Ausnahmeliste deaktiviert und Ihre GitHub Enterprise Server-Instance kehrt zum Wartungsmodus zurück. Wenn Sie einfach die IP-Ausnahmeliste deaktivieren, kehrt Ihre GitHub Enterprise Server-Instance zum normalen Betrieb zurück.

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

  1. Klicke in einem Verwaltungskonto für GitHub Enterprise Server 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. Klicke in der Randleiste „ Site admin“ auf Verwaltungskonsole.

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

    Screenshot der Kopfzeile von Verwaltungskonsole. Die Registerkarte mit der Bezeichnung „Wartung“ ist mit einem orangefarbenen Rahmen hervorgehoben.

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

  6. Geben Sie rechts neben dem Kontrollkästchen zum Aktivieren der Liste eine gültige, durch Leerzeichen getrennte Liste von IP-Adressen oder CIDR-Blöcken ein, die auf Ihre GitHub Enterprise Server-Instance zugreifen dürfen.

  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 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 GitHub CLI

Sie können den Wartungsmodus auf Ihre GitHub Enterprise Server-Instance mit der GitHub CLIgh 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 mit dem ghe-maintenance Befehlszeilenprogramm den Wartungsmodus für eine Instanz mit einem GitHub Enterprise Server Knoten oder mehrere Knoten in einer Hochverfügbarkeitskonfiguration festlegen oder aufheben. Weitere Informationen findest du unter Auf die Verwaltungsshell (SSH) zugreifen und Befehlszeilenwerkzeuge.

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 Befehlszeilenprogramm verwenden, um den Wartungsmodus für jeden Knoten in einem Cluster festzulegen oder aufzuheben. Weitere Informationen findest du unter Auf die Verwaltungsshell (SSH) zugreifen und Befehlszeilenwerkzeuge.

$ 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