À propos du mode de maintenance
Certains types d’opérations vous imposent de mettre votre instance GitHub Enterprise Server en mode hors connexion et de le basculer en mode maintenance :
- Mise à niveau vers une nouvelle version de GitHub Enterprise Server
- Accroissement des ressources de processeur, de mémoire ou de stockage allouées à la machine virtuelle
- Migration de données d’une machine virtuelle vers une autre
- Restauration de données à partir d’un instantané GitHub Enterprise Server Backup Utilities
- Résolution de certains types de problèmes d’application critiques
Nous vous recommandons dans l’avenir de planifier une fenêtre de maintenance d’au moins 30 minutes pour laisser le temps aux utilisateurs de se préparer. Quand une fenêtre de maintenance est planifiée, tous les utilisateurs voient une bannière au moment d’accéder au site.
Quand l’instance est en mode maintenance, tous les accès HTTP et Git normaux sont refusés. Cela inclut les requêtes web et d’API, pour lesquelles l’appliance répond avec le code d’état 503 (service indisponible). Les opérations Git de récupération (fetch), de clonage et d’envoi (push) sont également rejetées avec un message d’erreur indiquant que le site est temporairement indisponible. Les travaux GitHub Actions ne sont pas exécutés. La visite du site dans un navigateur entraîne l’affichage d’une page de maintenance.
Vous pouvez effectuer la validation initiale de votre opération de maintenance en configurant une liste d’exceptions IP pour autoriser l’accès à votre instance GitHub Enterprise Server uniquement à partir des adresses IP et des plages fournies. Les tentatives d’accès à votre instance GitHub Enterprise Server à partir d’adresses IP non spécifiées dans la liste d’exceptions IP reçoivent une réponse cohérente avec celles envoyées lorsque l’instance est en mode maintenance.
Activation immédiate du mode maintenance ou planification d’une fenêtre de maintenance ultérieure
-
À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.
-
Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.
-
Dans la barre latérale « Site admin », cliquez sur Management Console.
-
Dans la barre de navigation supérieure, cliquez sur Maintenance.
-
Sous « Activer et planifier », sélectionnez Activer le mode maintenance, puis choisissez entre une activation immédiate du mode maintenance ou la planification d’une fenêtre de maintenance ultérieure.
- Pour une activation immédiate du mode maintenance, sélectionnez le menu déroulant, puis cliquez sur maintenant.
- Pour planifier une fenêtre de maintenance à un moment ultérieur, sélectionnez le menu déroulant et cliquez sur une heure de début.
-
Si vous souhaitez définir un message personnalisé que les utilisateurs verront pendant la fenêtre de maintenance, saisissez un message dans le champ « Définir un message pour le mode de maintenance ».
-
Lorsque vous êtes satisfait du minutage de la fenêtre et du message facultatif, cliquez sur Enregistrer. Si vous avez sélectionné « maintenant », votre instance est placée en mode maintenance immédiatement.
Validation des modifications en mode maintenance à l’aide de la liste d’exceptions IP
La liste des exceptions IP fournit un accès contrôlé et restreint à votre instance GitHub Enterprise Server, ce qui est idéal pour la validation initiale de l’intégrité du serveur après une opération de maintenance. Une fois activé,votre instance GitHub Enterprise Server sera supprimé du mode maintenance et disponible uniquement pour les adresses IP configurées. La case à cocher du mode de maintenance est mise à jour pour refléter le changement d’état.
Si vous réactivez le mode maintenance, la liste des exceptions IP est désactivée et votre instance GitHub Enterprise Server retourne en mode maintenance. Si vous désactivez simplement la liste d’exceptions IP, votre instance GitHub Enterprise Server retrouve son fonctionnement normal.
Vous pouvez également utiliser un utilitaire en ligne de commande pour configurer la liste d’exceptions IP. Pour plus d’informations, consultez « Utilitaires de ligne de commande » et « Accès à l’interpréteur de commandes d’administration (SSH) ».
-
À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.
-
Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.
-
Dans la barre latérale « Site admin », cliquez sur Management Console.
-
Dans la barre de navigation supérieure, cliquez sur Maintenance, puis vérifiez que le mode de maintenance est déjà activé.
-
Sous « Activer et configurer la liste d’exceptions IP », sélectionnez Activer la liste d’exceptions IP.
-
À droite de la case à cocher permettant d’activer la liste, entrez une liste valide d’adresses IP séparées par un espace ou de blocs CIDR qui doivent être autorisés à accéder à votre instance GitHub Enterprise Server.
-
Si vous souhaitez définir un message personnalisé que les utilisateurs verront pendant la fenêtre de maintenance, saisissez un message dans le champ « Définir un message pour le mode de maintenance ».
-
Cliquez sur Enregistrer.
Gestion du mode maintenance à l’aide de l’API REST
Vous pouvez gérer le mode maintenance sur votre instance GitHub Enterprise Server à l’aide de l’API REST. Pour plus d’informations, consultez « Points de terminaison d’API REST pour la gestion de GitHub Enterprise Server ».
Gestion du mode maintenance à l'aide des données GitHub CLI
Vous pouvez gérer le mode maintenance sur votre instance GitHub Enterprise Server à l'aide de l'extension GitHub CLI gh es. Pour plus d'informations, reportez-vous à la documentation sur l'utilisation de GH ES CLI pour gh es maintenance set et gh es maintenance get.
Pour plus d’informations, consultez « Administration de votre instance à l’aide de l’interface CLI GitHub ».
Gestion du mode maintenance à l'aide de SSH
Si vous disposez d'un accès SSH, vous pouvez utiliser l'utilitaire de ligne de commande ghe-maintenance pour définir ou annuler le mode maintenance d'une instance GitHub Enterprise Server avec un nœud ou plusieurs nœuds dans une configuration à haute disponibilité. Pour plus d’informations, consultez « Accès à l’interpréteur de commandes d’administration (SSH) » et « Utilitaires de ligne de commande ».
Gestion du mode maintenance d'un cluster à l'aide de SSH
Si vous disposez d'un accès SSH à votre instance GitHub Enterprise Server, vous pouvez utiliser l'utilitaire de ligne de commande ghe-cluster-maintenance pour définir ou annuler le mode maintenance pour chaque nœud d'un cluster. Pour plus d’informations, consultez « Accès à l’interpréteur de commandes d’administration (SSH) » et « Utilitaires de ligne de commande ».
$ 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