Habilitar y programar el modo de mantenimiento

Algunos procedimientos de mantenimiento estándar, como actualizar tu instancia de GitHub Enterprise Server o restaurar copias de seguridad, requieren que la instancia se desconecte para su uso normal.

En este artículo

Acerca del modo de mantenimiento

Algunos tipos de operaciones requieren que se tu instancia de GitHub Enterprise Server desconecte y se ponga en modo de mantenimiento:

  • Actualización a la nueva versión de 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
  • Restauración de datos a partir de una GitHub Enterprise Server Backup Utilities instantánea
  • 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 extracción, clonación y subida de Git también se rechazan con un mensaje de error que indica que temporalmente el sitio no se encuentra disponible. Los trabajos de Acciones de GitHub no se ejecutarán. Al visitar el sitio desde un navegador aparece una página de mantenimiento.

Puede realizar una validación inicial de la operación de mantenimiento configurando una lista de excepciones de IP para permitir el acceso a tu instancia de GitHub Enterprise Server únicamente desde las direcciones y rangos IP proporcionados. Los intentos de acceso tu instancia de GitHub Enterprise Server desde direcciones IP no especificadas en la lista de excepciones 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, haz 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 " Site admin", 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", seleccione Habilitar modo de mantenimiento, y, después, decida si habilita el modo de mantenimiento de inmediato o programa 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 ip proporciona acceso controlado y restringido a tu instancia de GitHub Enterprise Server, que es ideal para la validación inicial del estado del servidor después de una operación de mantenimiento. Una vez habilitado, 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 vuelve a habilitar el modo de mantenimiento, la lista de excepciones ip se deshabilitará y tu instancia de GitHub Enterprise Server volverá al modo de mantenimiento. Si solo deshabilita 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 línea 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, haz 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 " Site admin", 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 de la casilla para habilitar la lista, escriba una lista válida de direcciones IP separadas por espacios o bloques CIDR a los que se debe permitir acceder 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. Haz clic en Guardar.

Administración del modo de mantenimiento mediante la API REST

Puede 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 la API REST para administrar GitHub Enterprise Server.

Administración del modo de mantenimiento mediante GitHub CLI

Puede administrar el modo de mantenimiento en tu instancia de GitHub Enterprise Server mediante la extensión GitHub CLIgh es. 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 tiene acceso SSH, puede usar la ghe-maintenance utilidad de línea de comandos para establecer o anular el modo de mantenimiento de una GitHub Enterprise Server instancia con un nodo 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 línea de comandos.

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

Si tiene acceso SSH a la GitHub Enterprise Server instancia, puede usar la ghe-cluster-maintenance utilidad de línea de comandos 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 línea 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