Habilitar y programar el modo de mantenimiento

En algunos procedimientos de mantenimiento estándar, como los de actualización de tu instancia de GitHub Enterprise Server o restauración de copias de seguridad, es necesario desconecar la instancia para que se pueda usar normalmente.

En este artículo

Acerca del modo de mantenimiento

Para algunos tipos de operaciones es necesario desconectar tu instancia de GitHub Enterprise Server y ponerlo en modo de mantenimiento:

  • Actualizar a una versión nueva de tu GitHub Enterprise Server
  • Aumentar los recursos de CPU, memoria o almacenamiento asignados a la máquina virtual
  • Migrar datos desde una máquina virtual a otra
  • Restaurar datos desde una instantánea de GitHub Enterprise Server Backup Utilities
  • Solucionar ciertos tipos de problemas críticos de solicitud

Recomendamos que programe una ventana de mantenimiento para, al menos, los siguientes 30 minutos para darle a los usuarios tiempo para prepararse. Cuando está programada una ventana de mantenimiento, todos los usuarios verán un mensaje emergente al acceder al sitio.

Cuando la instancia está en modo de mantenimiento, se rechazan todos los accesos HTTP y Git. Esto incluye solicitudes web y de API, para las que el dispositivo responde con el código de estado 503 (servicio no disponible). Las operaciones de captura, clonación e inserción de Git también se rechazan con un mensaje de error que indica que el sitio no está disponible temporalmente. En las configuraciones de alta disponibilidad, la replicación de Git se pausará. Los trabajos de Acciones de GitHub no se ejecutarán. Al visitar el sitio desde un navegador aparece una página de mantenimiento.

Puedes realizar la validación inicial de la operación de mantenimiento si configuras una lista de excepciones IP para permitir el acceso a tu instancia de GitHub Enterprise Server solo desde las direcciones IP y los intervalos proporcionados. Los intentos de acceder a tu instancia de GitHub Enterprise Server desde direcciones IP no especificadas en la lista de excepciones de IP recibirán una respuesta coherente con las enviadas cuando la instancia está en modo de mantenimiento.

Habilitar el modo de mantenimiento de inmediato o programar una ventana de mantenimiento para más tarde

  1. Desde una cuenta administrativa de GitHub Enterprise Server, en la esquina superior derecha de cualquier página, haga clic en .

  2. Si todavía no está en la página "Administrador del sitio", en la esquina superior izquierda, haga clic en Administrador del sitio.

  3. En la barra lateral " Administrador del sitio", haz clic en Consola de administración .

  4. En la barra de navegación superior, haz clic en Mantenimiento.

    Captura de pantalla del encabezado del Consola de administración. Una pestaña con la etiqueta "Mantenimiento", está resaltada con un contorno naranja.

  5. En "Habilitar y programar", selecciona Habilitar modo de mantenimiento, y, después, decide si habilitas el modo de mantenimiento de inmediato o programas una ventana de mantenimiento para otro momento.

    • Para habilitar el modo de mantenimiento de inmediato, seleccione el menú desplegable y haga clic en ahora.
    • Para programar una ventana de mantenimiento para otro momento, selecione el menú desplegable y haga clic en una hora de inicio.

  6. Opcionalmente, para establecer un mensaje personalizado para que los usuarios vean durante la ventana de mantenimiento, en el campo "Establecer un mensaje de modo de mantenimiento", escriba un mensaje.

  7. Cuando estés satisfecho con el tiempo de la ventana y el mensaje opcional, haz clic en Guardar. Si seleccionaste "ahora", la instancia se pondrá en modo de mantenimiento inmediatamente.

Validación de cambios en modo de mantenimiento mediante la lista de excepciones IP

La lista de excepciones de IP proporciona acceso controlado y restringido a tu instancia de GitHub Enterprise Server, lo que es idóneo para la validación inicial del estado del servidor después de una operación de mantenimiento. Una vez que se habilita, tu instancia de GitHub Enterprise Server se quitará del modo de mantenimiento y solo estará disponible para las direcciones IP configuradas. La casilla del modo de mantenimiento se actualizará para reflejar el cambio en el estado.

Si vuelves a habilitar el modo de mantenimiento, la lista de excepciones de IP se deshabilitará y tu instancia de GitHub Enterprise Server volverá al modo de mantenimiento. Si solo deshabilitas la lista de excepciones de IP, tu instancia de GitHub Enterprise Server volverá a la operación normal.

También puedes usar una utilidad de línea de comandos para configurar la lista de excepciones de IP. Para más información, consulta Utilidades de la ea de comandos y Acceder al shell administrativo (SSH).

  1. Desde una cuenta administrativa de GitHub Enterprise Server, en la esquina superior derecha de cualquier página, haga clic en .

  2. Si todavía no está en la página "Administrador del sitio", en la esquina superior izquierda, haga clic en Administrador del sitio.

  3. En la barra lateral " Administrador del sitio", haz clic en Consola de administración .

  4. En la barra de navegación superior, haz clic en Mantenimiento y, después, confirma que el modo de mantenimiento ya está habilitado.

    Captura de pantalla del encabezado del Consola de administración. Una pestaña con la etiqueta "Mantenimiento", está resaltada con un contorno naranja.

  5. En "Habilitar y configurar la lista de excepciones IP", seleccione Habilitar la lista de excepciones IP.

  6. A la derecha del cuadro de texto para habilitar la lista, escriba una lista válida de direcciones IP o bloques CIDR separados por espacios a los que se debe permitir el acceso a tu instancia de GitHub Enterprise Server.

  7. Opcionalmente, para establecer un mensaje personalizado para que los usuarios vean durante la ventana de mantenimiento, en el campo "Establecer un mensaje de modo de mantenimiento", escriba un mensaje.

  8. Haga clic en Save(Guardar).

Administración del modo de mantenimiento mediante la API REST

Puedes administrar el modo de mantenimiento en tu instancia de GitHub Enterprise Server mediante la API REST. Para más información, consulta Puntos de conexión de API de REST para administrar GitHub Enterprise Server.

Administración del modo de mantenimiento con GitHub CLI

Puedes administrar el modo de mantenimiento en tu instancia de GitHub Enterprise Server mediante la extensión gh es de GitHub CLI. Para más información, consulta la documentación de utilización de la CLI de GHES para gh es maintenance set y gh es maintenance get.

Para más información, consulta Administración de la instancia mediante la CLI de GitHub.

Administración del modo de mantenimiento mediante SSH

Si tienes acceso SSH, puedes usar la utilidad de la línea de comandos ghe-maintenance para establecer o anular el modo de mantenimiento para una instancia GitHub Enterprise Server con uno o varios nodos en una configuración de alta disponibilidad. Para más información, consulta Acceder al shell administrativo (SSH) y Utilidades de la ea de comandos.

Administración del modo de mantenimiento de un clúster mediante SSH

Si tienes acceso SSH a la instancia de GitHub Enterprise Server, puedes usar la utilidad de la línea de comandos ghe-cluster-maintenance para establecer o anular el modo de mantenimiento para cada nodo de un clúster. Para más información, consulta Acceder al shell administrativo (SSH) y Utilidades de la ea de comandos.

$ 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