Utilidades de la línea de comandos

          GitHub Enterprise Server incluye una variedad de utilidades para ayudar a resolver problemas concretos o realizar tareas específicas.

En este artículo

Puedes ejecutar estos comandos desde cualquier lugar en la VM después de iniciar sesión como usuario administrador de SSH. Para más información, consulta Acceder al shell administrativo (SSH).

General

ghe-announce

Esta utilidad establece un banner en la parte superior de cada GitHub Enterprise página. Puedes usarlo para difundir un mensaje entre tus usuarios.

# Sets a message that's visible to everyone
$ ghe-announce -s MESSAGE
> Announcement message set.
# Removes a previously set message
$ ghe-announce -u
> Removed the announcement message

Para permitir que cada usuario descarte el anuncio por sí mismo, usa la marca -d.

# Sets a user-dismissible message that's visible to everyone
$ ghe-announce -d -s MESSAGE
> Announcement message set.
# Removes a previously set message
$ ghe-announce -u
> Removed the announcement message, which was user
> dismissible: MESSAGE

También puede establecer un banner de anuncio mediante la configuración de empresa en GitHub Enterprise Server. Para más información, consulta Personalizar los mensajes de usuario para tu empresa.

ghe-aqueduct

Esta utilidad muestra información sobre los trabajos en segundo plano, tanto activos como en cola. Proporciona los mismos números de recuento de trabajos que la barra de estadísticas del administrador que aparece en la parte superior de cada página.

Esta utilidad puede ayudarte a identificar si el servidor de Aqueduct está teniendo problemas para procesar jobs en segundo plano. Cualquiera de los siguientes casos puede indicar un problema con Aqueduct:

  • Aumenta la cantidad de trabajos de segundo plano, pero los trabajos activos siguen siendo los mismos.
  • Las fuentes de eventos no se actualizan.
  • Los webhooks no se están activando.
  • La interfaz web no se actualiza después de una subida de Git.

Si sospecha que el aqueducto falla, visite Soporte técnico para GitHub Enterprise para obtener ayuda.

Con este comando, también puedes detener o reanudar los trabajos en cola.

$ ghe-aqueduct status
# lists queues and the number of currently queued jobs
# for all queues
$ ghe-aqueduct queue_depth --queue QUEUE
# lists the number of currently queued jobs for the
# specified queue
$ ghe-aqueduct pause --queue QUEUE
# pauses the specified queue
$ ghe-aqueduct resume --queue QUEUE
# resumes the specified queue

ghe-verificar-uso-de-disco

Esta utilidad busca en el disco los archivos grandes o los archivos que se han eliminado, pero siguen teniendo identificadores de archivo abiertos. Esto se debería ejecutar cuando intentes liberar espacio en la partición raíz.

ghe-check-disk-usage

ghe-cleanup-caches

Esta utilidad borra una variedad de cachés que podrían ocupar espacio extra del disco en el volumen raíz. Si notas que el uso del espacio de disco del volumen raíz aumenta de manera considerable con el tiempo, sería una buena idea ejecutar esta utilidad para ver si ayuda a reducir el uso general.

ghe-cleanup-caches

ghe-cleanup-settings

Esta utilidad borra toda la configuración existente Consola de administración .

Sugerencia

Por lo general, solo hará esto si ha contactado con el equipo de soporte y le han solicitado que lo haga.

ghe-cleanup-settings

ghe-config

Con esta utilidad, puede recuperar y modificar los valores de configuración de tu instancia de GitHub Enterprise Server.

$ ghe-config core.github-hostname
# Gets the configuration value of `core.github-hostname`
$ ghe-config core.github-hostname URL
# Sets the configuration value of `core.github-hostname`
# to the specified URL
$ ghe-config -l
# Lists all the configuration values

Permite encontrar el identificador único universal (UUID) del nodo en cluster.conf.

  ghe-config HOSTNAME.uuid

Te permite eximir una lista de usuarios de los límites de tasa de la API REST. Aún se aplicará un límite estricto de 120,000 solicitudes a estos usuarios. Los nombres de usuario que proporciones para este comando son sensibles a las mayúsculas y minúsculas. Para más información, consulta Límites de tasa de la API REST.

$ ghe-config app.github.rate-limiting-exempt-users "hubot github-actions[bot]"
# Exempts the users hubot and github-actions[bot] from rate limits.
# Usernames are case-sensitive.

ghe-config-apply

Esta utilidad aplica la configuración de Consola de administración, recarga los servicios del sistema, prepara un dispositivo de almacenamiento, vuelve a cargar los servicios de aplicaciones y ejecuta las migraciones de base de datos pendientes. Equivale a hacer clic en Guardar configuración en la Consola de administracióninterfaz de usuario web de o enviar una solicitud POST al /manage/v1/config/apply punto de conexión. A partir de la versión 3.16, esta utilidad aplica los cambios de configuración condicionalmente a la configuración pertinente. Puede forzar que se ejecute incondicionalmente mediante la marca -f.

ghe-config-apply

ghe-crypto

Esta utilidad se usa para comprobar y enumerar Consola de administracióngithub-ssl la configuración criptográfica de las conexiones TLS y SSH.

La lista de campos configurables github-ssl se puede ver a través de ghe-crypto --help.

Enumeración de conjuntos de cifrado y algoritmos predeterminados

El list comando devuelve la configuración de cifrado predeterminada para un campo determinado. Use la -o json marca para generar los resultados en formato JSON.

Para enumerar conjuntos de cifrado TLS 1.2:

ghe-crypto list tlsv12-ciphersuites

Para enumerar conjuntos de cifrado TLS 1.3:

ghe-crypto list tlsv13-ciphersuites

Para enumerar cifrados SSH:

ghe-crypto list ssh-ciphers

Para enumerar los algoritmos MAC de SSH:

ghe-crypto list ssh-mac-algorithms

Para enumerar los algoritmos de intercambio de claves SSH:

ghe-crypto list ssh-kex-algorithms

Para enumerar los tipos de firma SSH:

ghe-crypto list ssh-signature-types

Salida de ejemplo en formato JSON:

$ ghe-crypto list tlsv12-ciphersuites -o json
> [
>  "ECDHE-ECDSA-AES128-GCM-SHA256",
>  "ECDHE-ECDSA-CHACHA20-POLY1305",
>  "ECDHE-ECDSA-AES256-GCM-SHA384",
>  "ECDHE-RSA-AES128-GCM-SHA256",
>  "ECDHE-RSA-CHACHA20-POLY1305",
>  "ECDHE-RSA-AES256-GCM-SHA384"
> ]

Comprobación de conjuntos de cifrado y algoritmos

El check comando valida una sola línea de configuración criptográfica delimitada por ,. Esto resulta útil antes de aplicar los cambios de configuración.

Para comprobar los conjuntos de cifrado TLS 1.2:

ghe-crypto check tlsv12-ciphersuites CIPHER1,CIPHER2,CIPHER3

Para comprobar los conjuntos de cifrado TLS 1.3:

ghe-crypto check tlsv13-ciphersuites TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256

Para comprobar los cifrados SSH:

ghe-crypto check ssh-ciphers chacha20-poly1305@openssh.com,aes256-gcm@openssh.com,aes128-gcm@openssh.com

Para obtener más información sobre cómo configurar conjuntos de cifrado y algoritmos criptográficos, consulte Configuración de cifrados TLS y SSH.

ghe-console

Esta utilidad abre la consola de GitHub Rails en el dispositivo GitHub Enterprise. No use este comando sin indicaciones de Soporte técnico para GitHub Enterprise. El uso incorrecto podría causar daño o pérdida de datos.

ghe-console

ghe-dbconsole

Esta utilidad abre una sesión de base de datos MySQL en el GitHub Enterprise dispositivo. No use este comando sin indicaciones de Soporte técnico para GitHub Enterprise. El uso incorrecto podría causar daño o pérdida de datos.

ghe-dbconsole

ghe-es-index-status

Esta utilidad genera un resumen de los índices de Elasticsearch en formato CSV.

Imprima un resumen de índice con una fila de encabezado en STDOUT:

$ ghe-es-index-status -do
> warning: parser/current is loading parser/ruby23, which recognizes
> warning: 2.3.3-compliant syntax, but you are running 2.3.4.
> warning: please see https://github.com/whitequark/parser#compatibility-with-ruby-mri.
> Name,Primary,Searchable,Writable,UpToDate,RepairProgress,Version
> code-search-1,true,true,true,true,100.0,72e27df7c631b45e026b42bfef059328fa040e17
> commits-5,true,true,true,true,100.0,7ed28813100c47813ef654c0ee2bb9abf21ab744
> gists-4,true,true,true,true,100.0,cf8e7d04fcf2564c902e2873c424a279cc41079d
> issues-4,false,false,false,true,100.0,d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> issues-5,true,true,true,true,100.0,d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> projects-2,true,true,true,true,100.0,c5cac1c4b3c66d42e609d088d174dbc3dd44469a
> pull-requests-6,true,true,true,true,100.0,6a466ad6b896a3499509990979bf9a18d7d41de3
> repos-6,true,true,true,true,100.0,6c8b5fbba0fc1e409558db411d05e092c1387082
> users-5,true,true,true,true,100.0,38984875552bb826c9ec42999f409cb2e95556eb
> wikis-4,true,true,true,true,100.0,2613dec44bd14e14577803ac1f9e4b7e07a7c234

Imprima un resumen de índice y canalice los resultados hacia column para mejorar la legibilidad:

$ ghe-es-index-status -do | column -ts,
> warning: parser/current is loading parser/ruby23, which recognizes
> warning: 2.3.3-compliant syntax, but you are running 2.3.4.
> warning: please see https://github.com/whitequark/parser#compatibility-with-ruby-mri.
> Name             Primary  Searchable  Writable  UpToDate  RepairProgress  Version
> code-search-1    true     true        true      true      100.0           72e27df7c631b45e026b42bfef059328fa040e17
> commits-5        true     true        true      true      100.0           7ed28813100c47813ef654c0ee2bb9abf21ab744
> gists-4          true     true        true      true      100.0           cf8e7d04fcf2564c902e2873c424a279cc41079d
> issues-4         false    false       false     true      100.0           d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> issues-5         true     true        true      true      100.0           d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> projects-2       true     true        true      true      100.0           c5cac1c4b3c66d42e609d088d174dbc3dd44469a
> pull-requests-6  true     true        true      true      100.0           6a466ad6b896a3499509990979bf9a18d7d41de3
> repos-6          true     true        true      true      100.0           6c8b5fbba0fc1e409558db411d05e092c1387082
> users-5          true     true        true      true      100.0           38984875552bb826c9ec42999f409cb2e95556eb
> wikis-4          true     true        true      true      100.0           2613dec44bd14e14577803ac1f9e4b7e07a7c234

ghe-legacy-github-services-report

Esta utilidad enumera los repositorios del dispositivo que usan GitHub Servicios, una integración que se descontinuó el 1 de octubre de 2018. Es posible que los usuarios de su aparato hayan configurado GitHub Servicios para crear notificaciones para los envíos a determinados repositorios. Para obtener más información, vea Anuncio del desuso de GitHub los servicios en the GitHub Blog. Para obtener más información acerca de este comando o para conocer otras opciones, use la marca -h.

ghe-legacy-github-services-report

ghe-logs-tail

Esta utilidad te permite hacer un registro final de todos los archivos de registro relevantes desde tu instalación. Puedes aprobar opciones para limitar los registros a conjuntos específicos. Utiliza la marca -h para más opciones.

ghe-logs-tail

ghe-maintenance

Esta utilidad te permite controlar el estado del modo de mantenimiento de la instalación. Está diseñado para usarse principalmente tras bambalinas Consola de administración, pero se puede usar directamente. Para más información, consulta Habilitar y programar el modo de mantenimiento.

ghe-maintenance -h

ghe-motd

Esta utilidad vuelve a mostrar el mensaje del día (MOTD) en el que los administradores ven cuando se accede a la isntancia a través del shell administrativo. El resultado contiene un resumen del estado de la instancia.

ghe-motd

ghe-nwo

Esta utilidad devuelve el nombre y el propietario de un repositorio en función del identificador del repositorio.

ghe-nwo REPOSITORY_ID

ghe-org-admin-promote

Usa este comando para otorgarles privilegios de propietario de la organización a los usuarios con privilegios de administrador del sitio sobre el aparato o para otorgarle privilegios de propietario de la organización a cualquier usuario único de una organización única. Debes especificar un usuario o una organización. El comando ghe-org-admin-promote siempre solicita confirmación antes de ejecutarse a menos que use la marca -y para omitir la confirmación.

Puedes usar las siguientes opciones con la utilidad:

  • La marca -u especifica un nombre de usuario. Usa esta marca para otorgarle privilegios de propietario de la organización a un usuario específico. Omita la marca -u para promover todos los administradores del sitio a la organización especificada.
  • La marca -o especifica una organización. Usa esta marca para otorgar privilegios de propietario en una organización específica. Omita la marca -o para otorgarle permisos de propietario en todas las organizaciones al administrador del sitio especificado.
  • La marca -a otorga privilegios de propietario en todas las organizaciones a todos los administradores del sitio.
  • La marca -y omite la confirmación manual.

Esta utilidad no puede promover a un no-administrador del sitio para ser propietario de todas las organizaciones. Puede promover una cuenta de usuario normal a administrador del sitio con ghe-user-promote.

Otorga privilegios de propietario de organización a un administrador de sitio específico en una organización específica

ghe-org-admin-promote -u USERNAME -o ORGANIZATION

Otorga privilegios de propietario de la organización en todas las organizaciones a un administrador del sitio específico

ghe-org-admin-promote -u USERNAME

Otorga privilegios de propietario de la organización en una organización específica a todos los administradores del sitio

ghe-org-admin-promote -o ORGANIZATION

Otorga privilegios de propietario de la organización en todas las organizaciones a todos los administradores del sitio

ghe-org-admin-promote -a

ghe-reactivar-inicio-de-sesión-de-administrador

Usa este comando para desbloquear inmediatamente el Consola de administración tras un bloqueo de cuenta. Para configurar directivas de autenticación para tu instancia de GitHub Enterprise Server, consulte Configuración de los límites de frecuencia.

ghe-reactivate-admin-login

ghe-saml-mapping-csv

Nota:

Esta utilidad no funciona con configuraciones que usan SAML con el aprovisionamiento de SCIM. Para obtener la versión SCIM de esta herramienta, consulta la utilidad ghe-scim-identities-csv.

Esta utilidad permite a los administradores generar o actualizar las asignaciones de SAML NameID para los usuarios de una instancia. La utilidad puede generar un archivo CSV que muestre todas las asignaciones existentes. También puedes actualizar las asignaciones para los usuarios de la instancia editando el archivo resultante y usando luego la utilidad para asignar nuevas asignaciones desde el archivo.

Para generar un archivo CSV que contenga una lista de todas las asignaciones de SAML NameID de usuario en la instancia, ejecuta el siguiente comando.

ghe-saml-mapping-csv -d

De manera predeterminada, la utilidad escribe el archivo en /data/user/tmp.

Si tienes previsto actualizar las asignaciones, para asegurarse de que la utilidad pueda acceder al archivo, se recomienda mantener el archivo en la ubicación predeterminada.

Para prepararse para actualizar los mapeos, edite el archivo y realice los cambios deseados. Para ver el resultado de actualizar las asignaciones mediante los nuevos valores del archivo CSV editado, haz un simulacro. Ejecuta el siguiente comando, reemplazando /PATH/TO/FILE por la ruta de acceso real al archivo que has editado.

ghe-saml-mapping-csv -u -n -f /PATH/TO/FILE

Para actualizar las asignaciones de SAML en la instancia con nuevos valores del archivo, ejecuta el siguiente comando, reemplazando /PATH/TO/FILE por la ruta de acceso real al archivo que has editado.

ghe-saml-mapping-csv -u -f /PATH/TO/FILE

ghe-scim-identities-csv

Nota:

Esta utilidad solo funciona con configuraciones que usan SAML con el aprovisionamiento de SCIM. Para la versión única de SAML de esta herramienta, consulte la utilidad ghe-saml-mapping-csv.

Esta utilidad permite a los administradores generar las identidades SCIM para los usuarios de una instancia. La utilidad puede generar un archivo CSV que muestre todas las identidades existentes y los grupos de los que son miembros.

Para generar datos CSV que contengan una lista de todas las identidades SCIM de usuario en la instancia, ejecuta el siguiente comando. Esto creará un archivo ubicado en /data/user/tmp/scim-identities-DATE.csv que contiene las identidades SCIM.

ghe-scim-identities-csv

O bien, si deseas especificar el archivo, ejecuta el siguiente comando.

ghe-scim-identities-csv -f /PATH/TO/FILE

Se recomienda escribir en un archivo en /data/user/tmp.

ghe-service-list

Esta utilidad enumera todos los servicios que se han iniciado o detenido (en ejecución o en espera) en tu aparato.

$ ghe-service-list
active
  - alambic
  - alive
  - aqueduct-lite
  - authzd
  - babeld
  - codeload
  - consul, process 17114
  - consul-template, process 19493
  - driftwood
  - elasticsearch
  - enterprise-manage-unicorn, process 9359
  - ghe-user-disk, process 2545
  - git-daemon
  - github-env
  - github-gitauth
  - github-resqued
  - github-stream-processors
  - github-timerd
  - github-unicorn
  - gitrpcd
  - governor
  - gpgverify
  - grafana-server, process 19314
  - graphite-web, process 20189
  - hookshot-go
  - kafka-lite
  - kredz
  - lfs-server
  - mail-replies
  - memcached
  - minio
  - mysql
  - nginx
  - nomad, process 19562
  - pages
  - postfix
  - redis
  - spokesd
  - spokes-sweeper
  - svnbridge
  - token-scanning-api
  - token-scanning-backfill-worker
  - token-scanning-hydro-consumer
  - token-scanning-incremental-worker
  - token-scanning-udp-backfill-worker
  - treelights
  - turboscan
  - viewscreen

inactive
  - wireguard

ghe-set-password

Esta utilidad le permite establecer una nueva contraseña de administrador de sitio raíz para la autenticación en Consola de administración. Para más información, consulta Administración del acceso a la Consola de administración.

ghe-set-password

ghe-setup-network

Esta utilidad permite configurar la interfaz de red principal.

Para entrar en el modo visual, que te guiará a través de la configuración de la red:

ghe-setup-network -v

Utiliza la marca -h para más opciones.

ghe-ssh-check-host-keys

Esta utilidad compara las claves del host de SSH existentes con la lista de claves del host de SHH filtradas conocidas.

ghe-ssh-check-host-keys

Si se encuentra una clave de host filtrada, se cierra la utilidad con el estado 1 y un mensaje:

> One or more of your SSH host keys were found in the blacklist.
> Please reset your host keys using ghe-ssh-roll-host-keys.

Si no se encuentra ninguna clave de host filtrada, se cierra la utilidad con el estado 0 y un mensaje:

> The SSH host keys were not found in the SSH host key blacklist.
> No additional steps are needed/recommended at this time.

ghe-ssh-roll-host-keys

Esta utilidad rota las claves del host de SSH y las reemplaza con claves que se generan nuevas.

$ sudo ghe-ssh-roll-host-keys
Proceed with rolling SSH host keys? This will delete the
existing keys in /etc/ssh/ssh_host_* and generate new ones. [y/N]

# Press 'Y' to confirm deleting, or use the -y switch to bypass this prompt

> SSH host keys have successfully been rolled.

ghe-ssh-weak-fingerprints

Esta utilidad devuelve un informe de claves SSH débiles conocidas almacenadas en el GitHub Enterprise dispositivo. Opcionalmente, puedes revocar las claves de usuario como acción masiva. La utilidad informará sobre las claves del sistema débiles, las cuales debe revocar manualmente en el Consola de administración.

# Print a report of weak user and system SSH keys
$ ghe-ssh-weak-fingerprints

# Revoke all weak user keys
$ ghe-ssh-weak-fingerprints --revoke

ghe-ssl-acme

Esta utilidad permite instalar un certificado Let's Encrypt en el GitHub Enterprise dispositivo. Para más información, consulta Configurar TLS.

Puede usar la marca -x para quitar la configuración de ACME.

ghe-ssl-acme -e

ghe-ssl-ca-certificate-install

Esta utilidad permite instalar un certificado de entidad de certificación raíz personalizado en el GitHub Enterprise servidor. El certificado debe tener un formato PEM. Además, si el proveedor de certificados incluye varios certificados de CA en un solo archivo, debe separarlos en archivos individuales que, a continuación, debe trasladar a ghe-ssl-ca-certificate-install de uno en uno.

Ejecuta esta utilidad para agregar una cadena de certificación para la verificación de firma de confirmación S/MIME. Para más información, consulta Acerca de la verificación de firma de confirmación.

Ejecute esta utilidad cuando tu instancia de GitHub Enterprise Server no pueda conectarse a otro servidor porque esta última usa un certificado SSL autofirmado o un certificado SSL para el que no proporciona la agrupación de CA necesaria. Una manera de confirmar esto es ejecutar openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs desde tu instancia de GitHub Enterprise Server. Si se puede comprobar el certificado SSL del servidor remoto, SSL-Session debe tener un código de retorno de 0, como se muestra a continuación.

SSL-Session:
    Protocol  : TLSv1
    Cipher    : AES128-SHA
    Session-ID: C794EBCC3CBC10F747C9AFC029C03C1048FC99CFC34D13D7444E0F267C58DF4C
    Session-ID-ctx:
    Master-Key: 02A7C47CFD6EEC87D3C710E9DD87390E04EF82DDD7514AE03127D5DC1945FC0CAEFB5395791AEA598667EFA61B9EA8C5
    Key-Arg   : None
    Start Time: 1394581597
    Timeout   : 300 (sec)
    Verify return code: 0 (ok)

Si, por otro lado, no se puede comprobar el certificado SSL del servidor remoto, SSL-Session debe tener un código de retorno distinto de cero:

SSL-Session:
    Protocol  : TLSv1
    Cipher    : AES128-SHA
    Session-ID: 82CB288051A6DB66094C50A69CF1292AEE7E54C6B01B659B98AB336F8C33863E
    Session-ID-ctx:
    Master-Key: 01B025B2F764043A27919A8D1355AAECD8844FF0831B1D664042334790574A6F4025BAB085D4ED71D71AAB3091B849E5
    Key-Arg   : None
    Start Time: 1394581782
    Timeout   : 300 (sec)
    Verify return code: 27 (certificate not trusted)

Puedes usar estas opciones adicionales con la utilidad:

  • La marca -r le permite desinstalar un certificado de CA.
  • La marca -h muestra más información de uso.
ghe-ssl-ca-certificate-install -c CERTIFICATE_PATH

Para aplicar la configuración, ejecuta el siguiente comando. Durante una ejecución de configuración, los servicios en tu instancia de GitHub Enterprise Server pueden reiniciarse, lo que puede provocar un breve tiempo de inactividad para los usuarios.

Shell
ghe-config-apply

configuración-del-certificado-ssl-ghe

Esta utilidad permite actualizar un certificado SSL para tu instancia de GitHub Enterprise Server.

Para obtener más información acerca de este comando o para conocer otras opciones, use la marca -h.

/usr/local/share/enterprise/ghe-ssl-certificate-setup

ghe-ssl-generate-csr

Esta utilidad te permite generar una clave privada y una solicitud de firma de certificado (CSR), que puedes compartir con una autoridad de certificación comercial o privada para obtener un certificado válido para utilizar con tu instancia. Para más información, consulta Configurar TLS.

Para obtener más información acerca de este comando o para conocer otras opciones, use la marca -h.

ghe-ssl-generate-csr

ghe-storage-extend

Algunas plataformas exigen este script para ampliar el volumen de usuarios. Para más información, consulta Aumentar la capacidad de almacenamiento.

ghe-storage-extend

ghe-version

Esta utilidad imprime la versión, la plataforma y la compilación de tu instancia de GitHub Enterprise Server.

ghe-version

ghe-webhook-logs

Esta utilidad genera registros de entregas de webhooks para que los administradores los revisen e identifiquen cualquier problema.

ghe-webhook-logs

Para mostrar todas las entregas de enlace filtradas por un evento concreto:

ghe-webhook-logs --event issues

Para mostrar todas las entregas de enlace filtradas por un evento y una acción dados:

ghe-webhook-logs --event issues.opened
To show all failed hook deliveries in the past day:

```shell
ghe-webhook-logs -f -a YYYY-MM-DD

El formato de fecha debe ser YYYY-MM-DD, YYYY-MM-DD HH:MM:SS o YYYY-MM-DD HH:MM:SS (+/-) HH:M.

Para mostrar todos los resultados, carga útil y excepciones del gancho para la entrega:

ghe-webhook-logs -g DELIVERY_GUID

Agrupación en clústeres

ghe-cluster-balance

Esta utilidad te permite aplicar una distribución uniforme de asignaciones en los nodos del clúster comprobando el estado de las asignaciones del clúster y, a continuación, reequilibrando las asignaciones problemáticas. Para más información, consulta Reequilibrio de las cargas de trabajo del clúster.

Para generar una lista de los trabajos balanceables y su asignación distribuida asociada:

ghe-cluster-balance status

Para generar recuentos de asignación para un trabajo determinado o una lista delimitada por comas de trabajos:

ghe-cluster-balance -j JOB

Para reequilibrar asignaciones problemáticas para un trabajo determinado o una lista delimitada por comas de trabajos:

ghe-cluster-balance rebalance -j JOB

Puedes usar las marcas siguientes con ghe-cluster-balance rebalance.

MarcaDescripción
-j/--job-namesEspecifica las tareas que se van a reequilibrar. Acepta un nombre de trabajo o una lista delimitada por comas de nombres.
-n/--dry-runGenera las operaciones Nomad que ejecutará la utilidad, sin ejecutarlas realmente. Se puede usar en conjunto con -j/--job-name.
-y/--yesOmite el mensaje del usuario.
w/--workersEspecifica el número máximo de trabajos simultáneos que se detendrán y en los que se esperará a que finalice la reasignación. El valor predeterminado es 4.
-t/--timeoutEspecifica cuántos segundos hay que esperar a que se sustituya una asignación detenida para un trabajo. El valor predeterminado es de 300 segundos.

Para generar scripts de finalización para el shell especificado:

ghe-cluster-balance completion

Para mostrar una breve descripción de la utilidad y los subcomandos válidos:

ghe-cluster-balance help

ghe-cluster-maintenance

Con la utilidad ghe-cluster-maintenance, puede establecer o anular el modo de mantenimiento para cada nodo de un clúster.

$ 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

ghe-cluster-repl-bootstrap

Esta utilidad configura la replicación de alta disponibilidad en un conjunto secundario de nodos de clúster. Para más información, consulta Configurar la replicación con disponibilidad alta para un clúster.

ghe-cluster-repl-bootstrap

ghe-cluster-repl-teardown

Esta utilidad deshabilita la replicación en nodos de réplica para un clúster en una configuración de alta disponibilidad. Para más información, consulta Configurar la replicación con disponibilidad alta para un clúster.

ghe-cluster-repl-teardown

estado ghe-dpages

Compruebe el estado de los nodos y servicios en una implementación de clúster de GitHub Enterprise Server.

ghe-cluster-status

ghe-cluster-support-bundle

Esta utilidad crea un tarball de paquetes de soporte que contiene registros importantes de cada nodo, tanto en la configuración de Replicación geográfica como de Agrupación.

De manera predeterminada, el comando crea el tarball en /tmp, pero también puede cat el tarball en STDOUT para facilitar la transmisión mediante SSH. Esto es útil en caso de que la interfaz de usuario web no responda o no funcione la descarga de un paquete de soporte desde setup/support. Debe usar este comando para generar un paquete de tipo extended que contenga registros antiguos. También puede usar este comando para cargar el paquete de soporte del clúster directamente a GitHub Enterprise soporte.

Para crear un paquete estándar:

ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz

Para crear un paquete estándar que incluya los datos de los últimos dos días:

ssh -p 122 admin@HOSTNAME -- "ghe-cluster-support-bundle -p 2days -o" > support-bundle.tgz

Para crear un paquete extendido que incluya los datos de los últimos ocho días:

ssh -p 122 admin@HOSTNAME -- ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz

Para enviar un paquete a Soporte de GitHub:

ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -u'

Para enviar un lote a Soporte de GitHub y asociarlo a un vale:

ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -t TICKET_ID'

ghe-cluster-failover

Con la utilidad ghe-cluster-failover, puede conmutar por error al clúster de réplica. Para más información, consulta Inicio de una conmutación por error a tu clúster de réplica.

ghe-cluster-failover

ghe-dpages

Esta utilidad le permite administrar el servidor distribuido GitHub Pages .

ghe-dpages

Para mostrar un resumen de la ubicación y salud del repositorio:

ghe-dpages status

Para evacuar un GitHub Pages servicio de almacenamiento antes de evacuar un nodo de clúster:

ghe-dpages evacuate pages-server-UUID

ghe-remove-node (comando para eliminar un nodo)

Esta utilidad quita un nodo de un clúster. Si va a reemplazar un nodo, después de configurar un nodo de reemplazo, puede usar este comando para desconectar el nodo anterior. Para más información, consulta Reemplazar un nodo de agrupación.

Debe ejecutar este comando desde el nodo mySQL principal del clúster, que suele ser el nodo designado como mysql-master en el archivo de configuración del clúster (cluster.conf). Puede usar este comando para quitar cualquier nodo, a excepción del nodo mysql-master o redis-master. Para más información, consulta Inicializando el clúster.

ghe-remove-node HOSTNAME

El comando hace lo siguiente:

  • Evacua los datos de los servicios de datos que se ejecutan en el nodo, de modo que los nodos restantes del clúster contengan copias de los datos.
  • Marca el nodo como sin conexión en la configuración, aplica este cambio al resto de los nodos del clúster y detiene el tráfico que se enruta al nodo.

Puede ejecutar el comando con las marcas siguientes:

MarcaDescripción
-ne/--no-evacuateOmite la evacuación de los servicios de datos (advertencia: puede provocar la pérdida de datos).
-v/--verboseImprime información adicional en la consola.
-h/--helpMuestra el texto de ayuda para el comando.

Nota:

  • Este comando solo se puede usar para quitar un nodo de una configuración de clúster. No se puede usar para quitar un nodo de una configuración de alta disponibilidad.
  • Este comando no admite ejecución en paralelo. Para quitar varios nodos, debe esperar hasta que este comando haya finalizado antes de ejecutarlo para otro nodo.

ghe-spokesctl

Esta utilidad te permite administrar la replicación de repositorios en los servidores de Git distribuidos.

ghe-spokesctl

Para mostrar los servidores donde se almacena el repositorio:

ghe-spokesctl routes

Para evacuar los servicios de almacenamiento en un nodo de la agrupación:

ghe-spokesctl server set evacuating git-server-UUID

ghe-storage

Esta utilidad te permite evacuar todos los servicios de almacenamiento antes de evacuar un nodo de agrupación.

ghe-storage evacuate storage-server-UUID

nes

Esta utilidad permite supervisar el estado de los nodos de clúster mediante Node Eligibility Service. De forma predeterminada, Node Eligibility Service está deshabilitado. Para más información, consulta Supervisión del estado de los Nodos del Clúster con el Servicio de Elegibilidad de Nodos.

Para ver el estado de los nodos del clúster:

nes get-cluster-health

Para comprobar la configuración de TTL:

nes get-node-ttl all

Para establecer el TTL para el estado fail en minutos:

nes set-node-ttl fail MINUTES

El TTL para el estado fail debe ser mayor que el TTL para el estado warn.

Para establecer el TTL para el estado warn en minutos:

nes set-node-ttl warn TIME

Para revisar si Node Eligibility Service puede realizar acciones administrativas cuando un nodo con el nombre de host HOSTNAME se queda sin conexión:

nes get-node-adminaction HOSTNAME

Para permitir Node Eligibility Service que realice automáticamente una acción administrativa cuando un nodo con el nombre de host HOSTNAME se desconecta:

nes set-node-adminaction approved HOSTNAME

Para revocar la capacidad de Node Eligibility Service para llevar el nodo con el nombre de host HOSTNAME fuera de línea:

nes set-node-adminaction none HOSTNAME

Para actualizar manualmente la idoneidad de un nodo para volver a agregar al clúster:

nes set-node-eligibility eligible HOSTNAME

Git

ghe-btop

Interfaz similar a top para las operaciones actuales de Git.

ghe-btop [ <port number> | --help | --usage ]

ghe-governor

Esta utilidad te ayuda a analizar el tráfico de Git. Consulte los archivos de datos de Governor ubicados en /data/user/gitmon. GitHub contiene una hora de datos por archivo, retenido durante dos semanas. Para obtener más información, consulte Análisis del tráfico de Git mediante Governor en GitHub Community.

ghe-governor <subcommand> <column> [options]

ghe-governor -h
Usage: ghe-governor [-h] <subcommand> args

OPTIONS:
  -h | --help        Show this message.

Valid subcommands are:
  aggregate              Find the top (n) groups of queries for a grouping function and metric
  health                 Summarize all recent activity on one or more servers
  top                    Find the top (n) queries for a given metric
  dump                   Dump individual operations
  test-quotas            Check quota information

Try ghe-governor <subcommand> --help for more information on the arguments each subcommand takes.

ghe-repo

Esta utilidad le permite acceder al directorio de un repositorio y abrir un shell interactivo como usuario de git. Puede realizar la inspección o el mantenimiento manuales de un repositorio con comandos como git-* o git-nw-*.

ghe-repo USERNAME/REPONAME

ghe-repo-gc

Esta utilidad reempaqueta de forma manual una red de repositorios para optimizar el almacenamiento de paquetes. Si tienes un repositorio grande, ejecutar este comando puede ayudar a reducir su tamaño general. GitHub Enterprise ejecuta automáticamente este comando a lo largo de la interacción con una red de repositorio.

ghe-repo-gc USERNAME/REPONAME

Puede agregar el argumento --prune opcional para quitar objetos inaccesibles de Git a los que no se hace referencia desde ninguna rama, etiqueta o cualquier otra referencia. Esto es especialmente útil para eliminar al instante información confidencial borrada previamente. Consulta Eliminación de datos confidenciales de un repositorio.

Si usa una topología de implementación con varios nodos, para evitar que los datos confidenciales se conserven en otros nodos y puedan exponerse durante una conmutación por error, debe ejecutar el comando en todos los nodos. Por ejemplo, para una configuración de clúster, puede usar el siguiente comando.

ghe-cluster-each -r git -- "ghe-repo-gc --prune USERNAME/REPONAME"

GitHub Actions

ghe-actions-check

Esta utilidad verifica que todos los servicios de GitHub Actions están en buen estado. Para más información, consulta Introducción a GitHub Actions para GitHub Enterprise Server y Solución de problemas de GitHub Actions para su empresa.

ghe-actions-check

ghe-actions-precheck

Esta utilidad prueba la configuración de Blob Storage para GitHub Actions en tu instancia de GitHub Enterprise Server. Puede usar la utilidad para comprobar la configuración de almacenamiento antes de habilitar GitHub Actions para la instancia.

Para obtener más información sobre la configuración de GitHub Actions, vea Introducción a GitHub Actions para GitHub Enterprise Server.

Nota:

Esta utilidad solo funciona con configuraciones que usan una conexión basada en credenciales al proveedor de almacenamiento. Para probar las configuraciones de openID Connect (OIDC), utilice ghe-actions-test-storage-with-oidc.

ghe-actions-precheck -p [PROVIDER] -cs ["CONNECTION-STRING"]

Si tu sistema de almacenamiento se configuró correctamente, verás la siguiente salida.

All Storage tests passed

ghe-actions-test-storage-with-oidc

Esta utilidad comprueba que el proveedor de almacenamiento de blobs para GitHub Actions en tu instancia de GitHub Enterprise Server es válido cuando se usa OpenID Connect (OIDC).

Nota:

Esta utilidad solo funciona con configuraciones que usan una configuración de OpenID Connect (OIDC). Para probar las configuraciones basadas en credenciales, utilice ghe-actions-precheck.

ghe-actions-test-storage-with-oidc -p [PROVIDER] -cs ["CONNECTION-STRING"]

ghe-actions-stop

Esta utilidad detiene GitHub Actions para que no se ejecute en tu instancia de GitHub Enterprise Server.

Nota:

  • Por lo general, solo hará esto si ha contactado con el equipo de soporte y le han solicitado que lo haga.
  • En configuraciones de alta disponibilidad, ejecuta este comando desde la principal.

ghe-actions-start

Esta utilidad inicia GitHub Actions en tu instancia de GitHub Enterprise Server después de que se haya detenido anteriormente.

Nota:

  • Por lo general, solo hará esto si ha contactado con el equipo de soporte y le han solicitado que lo haga.
  • En configuraciones de alta disponibilidad, ejecuta este comando desde la principal.

Si tu sistema se ha configurado correctamente, verás la siguiente salida:

Actions was enabled!

GitHub Packages

ghe-check-blob-connection

Esta utilidad comprueba que un proveedor de almacenamiento de blobs para GitHub Packages es válido en tu instancia de GitHub Enterprise Server.

ghe-check-blob-connection --help

Si una conexión se configuró anteriormente, las pruebas se pueden realizar ejecutando directamente el comando sin parámetros.

ghe-check-blob-connection

Si tu sistema se ha configurado correctamente, verás la siguiente salida:

All Storage tests passed

Alta disponibilidad

ghe-repl-decommission

Este comando retira las entradas de base de datos para el nodo con el UUID especificado. Ejecuta este comando en el nuevo nodo principal tras haber realizado una conmutación por error a un nodo de réplica, para quitar las entradas de la base de datos del nodo retirado. Para más información, consulta Iniciar una tolerancia de fallos a tu aparato de réplica.

ghe-repl-decommission <UUID>

ghe-repl-promote

Este comando deshabilita la replicación en un nodo de réplica existente y convierte el nodo de réplica en un nodo principal con la misma configuración que el nodo principal original. Todos los servicios de replicación están habilitados. Para más información, consulta Iniciar una tolerancia de fallos a tu aparato de réplica.

Promover una réplica no configura la replicación para aplicativos existentes automáticamente. Despues de promoverla, si así lo quieres, puedes configurar la replicacion desde el nuevo aplicativo principal hacia uno existente y hacia el aplicativo primario previo.

ghe-repl-promote

ghe-repl-setup

Ejecuta esta utilidad en un nodo existente para empezar a habilitar una configuración de alta disponibilidad. La utilidad coloca el nodo en modo de espera antes de comenzar la replicación con ghe-repl-start. Para más información, consulta Crear una réplica de alta disponibilidad.

Después de ejecutar la utilidad, se produce la siguiente configuración en el nodo.

  • Se establece un túnel VPN WireGuard cifrado para la comunicación entre los nodos.
  • Se configuran los servicios de bases de datos para la replicación y se inician.
  • Se inhabilitan los servicios de aplicaciones. Los intentos de acceder al nodo de réplica a través de HTTP o HTTPS, Git u otros protocolos admitidos mostrarán el mensaje "Servidor en modo de replicación", una página de mantenimiento o un mensaje de error.

Al ejecutar esta utilidad, reemplaza PRIMARY-NODE-IP por la dirección IP del nodo principal de la instancia.

ghe-repl-setup PRIMARY-NODE-IP

ghe-repl-start

Esta utilidad comienza la replicación de todos los almacenes de datos de un nodo. Ejecuta esta utilidad después de ejecutar ghe-repl-setup. Para más información, consulta Crear una réplica de alta disponibilidad.

ghe-repl-start

ghe-repl-status

Esta utilidad muestra el estado de la replicación en un nodo, devolviendo un estado OK, WARNING o CRITICAL para el flujo de replicación de cada almacén de datos. Para más información, consulta Supervisión de una configuración de alta disponibilidad.

  • Si alguno de los canales de replicación está en estado WARNING, el comando se cerrará con el código 1.
  • Si no has iniciado la replicación, el comando se cerrará con el código 1.
  • Si alguno de los canales está en estado CRITICAL, el comando se cerrará con el código 2.
  • La salida se ajusta a las expectativas del complemento check_by_ssh de Nagios. Para obtener más información, consulta el complemento check_by_ssh en la página oficial de complementos de Nagios.
ghe-repl-status

Las opciones -v y -vv proporcionan detalles adicionales sobre el estado de replicación de cada almacén de datos.

ghe-repl-status -v

ghe-repl-stop

Este comando deshabilita temporalmente la replicación de todos los almacenes de datos en un nodo de réplica existente. Todos los servicios de replicación se detienen. Para reanudar la replicación, usa ghe-repl-start.

ghe-repl-stop

ghe-repl-teardown

Esta utilidad deshabilita completamente la replicación en un nodo de réplica existente, quitando la configuración de la réplica. Puedes ejecutar el siguiente comando desde un nodo de réplica, pero si el nodo de réplica no es accesible, también puedes ejecutar el comando desde el nodo principal.

ghe-repl-teardown

ghe-repl-stop-all

Esta utilidad deshabilita la replicación de todos los almacenes de datos en todos los nodos de réplica. Ejecute esta utilidad desde el nodo principal antes de actualizar las réplicas. Para más información, consulta Actualizar con un paquete de actualización.

ghe-repl-start-all

Esta utilidad comienza la replicación de todos los almacenes de datos en todos los nodos de réplica. Ejecute esta utilidad desde el nodo principal después de actualizar las réplicas. Para más información, consulta Actualizar con un paquete de actualización.

Importación y exportación

ghe-migrator

          `ghe-migrator` es una herramienta de alta fidelidad para ayudarle a migrar de una instancia de GitHub a otra. Puede consolidar las instancias o mover su organización, usuarios, equipos y repositorios de GitHub.com a GitHub Enterprise.

Para obtener más información, consulte nuestras guías sobre la migración de datos en su empresa y desde su empresa.

git-import-detect

Con una URL, detecta qué tipo de sistema de administración de control de fuente hay en el otro extremo. Durante una importación manual, probablemente ya lo sepas, pero puede ser muy útil en scripts automáticos.

git-import-detect

git-import-hg-raw

Esta utilidad importa un repositorio de Mercurial a este repositorio de Git. Para más información, consulta Importación desde otros sistemas de control de versiones con el shell administrativo.

git-import-hg-raw

git-import-svn-raw

Esta utilidad importa los datos del archivo y el historial de Subversion en una rama de Git. Es una copia exacta del árbol, que ignora cualquier distinción de tronco o rama. Para más información, consulta Importación desde otros sistemas de control de versiones con el shell administrativo.

git-import-svn-raw

git-import-tfs-raw

Esta utilidad importa desde el Control de Versiones de Team Foundation (TFVC). Para más información, consulta Importación desde otros sistemas de control de versiones con el shell administrativo.

git-import-tfs-raw

git-import-rewrite

Esta utilidad reescribe el repositorio importado. Esto te proporciona una oportunidad para renombrar a los autores y, para Subversion y TFVC, produce ramas de Git que se basan en carpetas. Para más información, consulta Importación desde otros sistemas de control de versiones con el shell administrativo.

git-import-rewrite

Licencia

ghe-license

Esta utilidad permite interactuar con su licencia activa actual o con nuevas licencias sin necesidad de importarlas antes. También puede aplicar directamente la licencia para que los cambios entren en vigor mediante --apply. La aplicación de cambios con la utilidad ghe-license evita una ejecución de configuración y solo reinicia los servicios afectados.

Puede revisar los comandos y las banderas posibles mediante ghe-license -h.

Como alternativa, puede administrar licencias mediante la API REST o GitHub CLI. Consulta Puntos de conexión de la API REST para administrar GitHub Enterprise Server y Administración de la instancia mediante la CLI de GitHub.

Mostrar información de licencia. Si lo prefiere, utilice la marca -j para el formato JSON.

ghe-license info
# "advanced_security_enabled" : true
# "advanced_security_seats" : 0
# "cluster_support" : false
# "company" : "GitHub"
# "croquet_support" : true
# "custom_terms" : true
# "evaluation" : false
# "expire_at" : "2025-01-01T23:59:59-08:00"
# "insights_enabled" : true
# "insights_expire_at" : "2025-01-01T23:59:59.999-08:00"
# "learning_lab_evaluation_expires" : "2023-01-01T23:59:59.000-08:00"
# "learning_lab_seats" : 100
# "perpetual" : false
# "reference_number" : "123456"
# "seats" : 0
# "ssh_allowed" : true
# "support_key" : null
# "unlimited_seating" : true

Compruebe la licencia.

ghe-license check
# License is valid.

Todos los comandos se ejecutan en la licencia existente. Sin embargo, también puede proporcionar una licencia de STDOUT mediante --pipe.

cat license | ghe-license import --pipe
# License imported at /data/user/common/enterprise.ghl.
# License synchronized.

También puede proporcionar una licencia asignando una ruta de acceso de archivo a la variable de entorno GHE_LICENSE_FILE.

GHE_LICENSE_FILE=/path/license ghe-license import
# License imported at /data/user/common/enterprise.ghl.
# License synchronized.

Migrations

olmo

          `elm` es la herramienta de línea de comandos para Enterprise Live Migrations, una herramienta para migraciones en vivo a GHE.com. Consulta [AUTOTITLE](/migrations/elm/elm-cli-reference).

Seguridad

ghe-find-insecure-git-operations

Esta utilidad busca los registros de la instancia e identifica las operaciones de Git a través de SSH que usan algoritmos no seguros o funciones hash, como los cifrados DSA, RSA-SHA-1, HMAC-SHA-1 y CBC. Puedes usar la salida para admitir la transición de cada cliente a una conexión SSH más segura. Para obtener más información, consulte the GitHub Blog y Configuración de conexiones SSH a la instancia.

ghe-find-insecure-git-operations

Soporte técnico

ghe-diagnostics

Esta utilidad realiza múltiples verificaciones y reúne información acerca de tu instalación que puedes enviar para recibir asistencia para diagnosticar los problemas que tienes.

Actualmente, la salida de esta utilidad es similar a la descarga de la información de diagnóstico en Consola de administración, pero puede tener mejoras adicionales agregadas con el tiempo que no están disponibles en la interfaz de usuario web. Para más información, consulta Proporcionar datos al soporte técnico de GitHub.

ghe-diagnostics

paquete de soporte GHE

Nota:

Si tu instancia de GitHub Enterprise Server está en una configuración de replicación geográfica o si la instancia es un clúster, debes usar el comando ghe-cluster-support-bundle para recuperar el conjunto de soporte técnico. Para más información, consulta Utilidades de la línea de comandos. Esta utilidad crea un paquete de soporte tarball que contiene registros importantes de tu instancia.

De manera predeterminada, el comando crea el tarball en /tmp, pero también puede cat el tarball en STDOUT para facilitar la transmisión mediante SSH. Esto es útil en caso de que la interfaz de usuario web no responda o no funcione la descarga de un paquete de soporte desde setup/support. Debe usar este comando para generar un paquete de tipo extended que contenga registros antiguos. También puede usar este comando para cargar el paquete de soporte directamente a GitHub Enterprise support.

Para crear un paquete estándar:

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz

Para crear un paquete estándar que incluya los datos de los últimos dos días:

ssh -p 122 admin@HOSTNAME -- "ghe-support-bundle -p 2days -o" > support-bundle.tgz

Para crear un paquete extendido que incluya los datos de los últimos ocho días:

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -x -o' > support-bundle.tgz

Para enviar un paquete a Soporte de GitHub:

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -u'

Para enviar un lote a Soporte de GitHub y asociarlo a un vale:

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -t TICKET_ID'

ghe-support-upload

Esta utilidad envía información desde su aparato al soporte GitHub Enterprise. Puede especificar un archivo local o proporcionar un flujo de datos de hasta 100 MB desde STDIN. Opcionalmente, los datos cargados se pueden asociar con un ticket de asistencia.

Para enviar un archivo a Soporte de GitHub y asociarlo con un ticket:

ghe-support-upload -f FILE_PATH -t TICKET_ID

Para cargar datos desde STDIN y asociar los datos con un vale:

ghe-repl-status -vv | ghe-support-upload -t TICKET_ID -d "Verbose Replication Status"

En este ejemplo, ghe-repl-status -vv envía información de estado detallada desde un dispositivo de réplica. Debe reemplazar ghe-repl-status -vv por los datos específicos que desea transmitir a STDIN y Verbose Replication Status con una breve descripción de los datos. Por lo general, solo hará esto si ha contactado con el equipo de soporte y le han solicitado que lo haga.

Mejora GitHub Enterprise Server

ghe-check-background-upgrade-jobs

Durante una actualización a una versión de características, esta utilidad muestra el estado de los trabajos en segundo plano en tu instancia de GitHub Enterprise Server. Si está ejecutando actualizaciones back-to-back, debe usar esta utilidad para comprobar que todos los trabajos en segundo plano están completos antes de continuar con la siguiente actualización.

ghe-check-background-upgrade-jobs

ghe-migrations

Durante una actualización a una versión de características, esta utilidad muestra el estado de las migraciones de base de datos activas en tu instancia de GitHub Enterprise Server. La salida incluye un identificador de versión para la migración, el nombre de la migración, el estado de la migración y la duración actual de la migración.

Para mostrar la lista de migraciones:

ghe-migrations

De forma predeterminada, la utilidad genera una tabla con 10 líneas. Para ajustar el alto de la tabla en líneas:

ghe-migrations -height LINES

De forma predeterminada, el visualizador se actualiza cada segundo. Para especificar la duración en segundos para actualizar el visualizador:

ghe-migrations -refresh_rate SECONDS

ghe-update-check

Esta utilidad comprobará si un nuevo parche de GitHub Enterprise está disponible. Si lo hay, y si hay espacio disponible en tu instancia, descargará el paquete. De manera predeterminada, se guarda en /var/lib/ghe-updates. A continuación, un administrador puede realizar la actualización.

En /var/lib/ghe-updates/ghe-update-check.status puede acceder a un archivo que contiene el estado de la descarga.

Para comprobar la versión más reciente GitHub Enterprise, use el conmutador -i.

ssh -p 122 admin@HOSTNAME -- 'ghe-update-check'

ghe-upgrade

Esta utilidad instala o verifica un paquete actualizado. También puedes usar esta utilidad para revertir un lanzamiento de patch si falla o se interrumpe una actualización. Para más información, consulta Información general del proceso de actualización.

Para verificar un paquete de mejora:

ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME

Para instalar un paquete de mejora:

ghe-upgrade UPGRADE-PACKAGE-FILENAME

Al revertir una actualización, tendrá que usar un archivo de paquete de actualización con la extensión .pkg. Los archivos de paquete de revisión en caliente con la extensión .hpkg no se admiten.

ghe-upgrade --allow-patch-rollback EARLIER-RELEASE-UPGRADE-PACKAGE.pkg

Se requiere que reinicies después de ejecutar el comando. Bajar de categoría una mejora previa no afecta la partición de datos, ya que las migraciones no se ejecutan en lanzamientos parchados.

ghe-upgrade-scheduler

Esta utilidad administra la instalación programada de paquetes de actualización. Puedes mostrar, crear nuevas o eliminar las actualizaciones programadas. Debes crear cronogramas usando expresiones cron. Para obtener más información, consulte "Entrada de Wikipedia con Cron".

La utilidad ghe-upgrade-scheduler es más adecuada para programar actualizaciones de hotpatch, que no requieren el modo de mantenimiento ni un reinicio en la mayoría de los casos. Esta utilidad no es práctica para las actualizaciones de paquetes enteros, que requieren que un administrador establezca manualmente el modo de mantenimiento, reinicie la instancia y anule el modo de mantenimiento. Para obtener más información sobre los diferentes tipos de actualizaciones, consulta Actualizar con un paquete de actualización.

Para programar una nueva instalación para un paquete:

ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME

Para mostrar las instalaciones programadas para un paquete:

$ ghe-upgrade-scheduler -s UPGRADE PACKAGE FILENAME
> 0 2 15 12 * /usr/local/bin/ghe-upgrade -y -s UPGRADE-PACKAGE-FILENAME > /data/user/common/UPGRADE-PACKAGE-FILENAME.log 2>&1

Para eliminar las instalaciones programadas para un paquete:

ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME

Administración de usuarios

Uso de licencia GHE

Esta utilidad exporta una lista de los usuarios de la instalación en formato JSON. Si la instancia está conectada a GitHub Enterprise Cloud, GitHub Enterprise Server usa esta información para notificar información de licencias a GitHub Enterprise Cloud. Para más información, consulta Habilitación de GitHub Connect para GitHub.com.

Predeterminadamente, la lista de usuarios en el JSON resultante se encuentra cifrada. Revisa las banderas opcionales mediante ghe-license --help.

ghe-license usage

ghe-org-membership-update

Esta utilidad aplicará la visibilidad de membresía de la organización predeterminada mostrando todos los miembros de tu instancia. Para más información, consulta Configurar visibilidad para los miembros de la organización. Las opciones de configuración son public o private.

ghe-org-membership-update --visibility=SETTING

ghe-user-csv

Esta utilidad exporta una lista de todos los usuarios en la instalación a un formato CSV. El archivo CSV incluye las direcciones de correo electrónico, el tipo de usuario que son (p. ej., administrador, usuario), cuántos repositorios tienen, cuántas claves SSH tienen, la cantidad de pertenencias a organizaciones, la última dirección IP que inició sesión, etc. Use la marca -h para ver más opciones.

ghe-user-csv -o > users.csv

ghe-user-demote

Esta utilidad degrada el usuario especificado desde el estado de administrador al de usuario normal. Recomendamos usar la interfaz de usuario web para realizar esta acción, pero también facilitamos esta utilidad en caso de que la utilidad ghe-user-promote se ejecute con errores y deba volver a disminuir de categoría a un usuario desde la CLI.

ghe-user-demote USERNAME

ghe-user-promote (promover al usuario en GitHub Enterprise)

Esta utilidad promueve la cuenta de usuario especificada a administrador del sitio.

ghe-user-promote USERNAME

ghe-user-suspend

Esta utilidad suspende el usuario especificado, evitando que inicie sesión, suba o extraiga datos de tu repositorio.

ghe-user-suspend USERNAME

ghe-user-unsuspend

Esta utilidad anula la suspensión del usuario especificado, otorgándole acceso para iniciar sesión, subir o extraer datos de tu repositorio.

ghe-user-unsuspend USERNAME