Skip to main content

Esta versión de GitHub Enterprise se discontinuará el 2023-01-18. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Installing GitHub Enterprise Server on Azure

To install GitHub Enterprise Server on Azure, you must deploy onto a memory-optimized instance that supports premium storage.

You can deploy GitHub Enterprise Server on global Azure or Azure Government.

Prerequisites

Hardware considerations

Minimum requirements

We recommend different hardware configurations depending on the number of user licenses for your GitHub Enterprise Server instance. If you provision more resources than the minimum requirements, your instance will perform and scale better.

Licencias de usuariovCPUMemoriaAlmacenamiento raízAlmacenamiento adjunto (datos)
Prueba, Demo o 10 usuarios no frecuentes432 GB200 GB150 GB
10-3000848 GB200 GB300 GB
3000-50001264 GB200 GB500 GB
5000-80001696 GB200 GB750 GB
8000-10000+20160 GB200 GB1000 GB

If you plan to enable GitHub Actions for the users of your instance, more resources are required.

vCPUMemoriaSimultaneidad máxima
864 GB300 trabajos
16128 GB700 trabajos
32160 GB1300 trabajos
64256 GB2000 trabajos
96384 GB4000 trabajos

For more information about these requirements, see "Getting started with GitHub Actions for GitHub Enterprise Server."

Para más información sobre cómo ajustar los recursos de una instancia existente, vea "Aumento de la capacidad de almacenamiento" y "Aumento de los recursos de CPU o memoria".

Storage

We recommend a high-performance SSD with high input/output operations per second (IOPS) and low latency for GitHub Enterprise Server. Workloads are I/O intensive. If you use a bare metal hypervisor, we recommend directly attaching the disk or using a disk from a storage area network (SAN).

Your instance requires a persistent data disk separate from the root disk. For more information, see "System overview."

To configure GitHub Actions, you must provide external blob storage. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

The available space on the root filesystem will be 50% of the total disk size. You can resize your instance's root disk by building a new instance or using an existing instance. For more information, see "System overview" and "Increasing storage capacity."

CPU and memory

The CPU and memory resources that GitHub Enterprise Server requires depend on the levels of activity for users, automations, and integrations.

If you plan to enable GitHub Actions for the users of your GitHub Enterprise Server instance, you may need to provision additional CPU and memory resources for your instance. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

Cuando incrementas tus recursos de CPU, te recomendamos agregar por lo menos 6.5 GB de memoria para cada vCPU (hasta 16 vCPU) que aprovisiones para la instancia. Cuando utilizas más de 16 CPU, no necesitas agregar 6.5 GB de memoria para cada uno, pero debes monitorear tu instancia para garantizar que tenga memoria suficiente.

Warning: We recommend that users configure webhook events to notify external systems of activity on GitHub Enterprise Server. Automated checks for changes, or polling, will negatively impact the performance and scalability of your instance. For more information, see "About webhooks."

For more information about monitoring the capacity and performance of GitHub Enterprise Server, see "Monitoring your appliance."

You can increase your instance's CPU or memory resources. For more information, see "Increasing CPU or memory resources."

Determining the virtual machine type

Before launching your GitHub Enterprise Server instance on Azure, you'll need to determine the machine type that best fits the needs of your organization. For more information about memory optimized machines, see "Memory optimized virtual machine sizes" in the Microsoft Azure documentation. To review the minimum resource requirements for GitHub Enterprise Server, see "Minimum requirements."

Nota: Siempre puede escalar verticalmente la CPU o la memoria si cambia de tamaño la instancia. Sin embargo, ya que cambiar de tamaño tu CPU o memoria requiere tiempo de inactividad para tus usuarios, recomendamos contar con recursos de sobra para compensar un escalamiento.

El aparato GitHub Enterprise Server requiere un disco de datos de almacenamiento prémium, y es compatible con cualquier Azure VM que admita almacenamiento prémium. Los tipos de VM de Azure con el sufijo s admiten el almacenamiento premium. Para más información, vea "¿Qué tipos de disco están disponibles en Azure?" y "Azure Premium Storage: diseño para un alto rendimiento" en la documentación de Azure.

GitHub recomienda una VM con memoria optimizada para GitHub Enterprise Server. Para más información, vea "Tamaños de máquina virtual optimizados para memoria" en la documentación de Azure.

GitHub Enterprise Server admite cualquier región que sea compatible con tu tipo de VM. Para más información sobre las regiones admitidas para cada máquina virtual, vea "Productos disponibles por región" de Azure.

Creating the GitHub Enterprise Server virtual machine

Para crear la instancia, deberás importar la imagen del GitHub Enterprise Server a tu máquina virtual y adjuntar un volumen de almacenamiento adicional para los datos de tu instancia. Para más información, vea "Consideraciones de hardware".

  1. Find the most recent GitHub Enterprise Server appliance image. For more information about the vm image list command, see "az vm image list" in the Microsoft documentation.

    $ az vm image list --all -f GitHub-Enterprise | grep '"urn":' | sort -V
  2. Create a new VM using the appliance image you found. For more information, see "az vm create" in the Microsoft documentation.

    Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see "Resource groups" in the Microsoft documentation.

    $ az vm create -n VM_NAME -g RESOURCE_GROUP --size VM_SIZE -l REGION --image APPLIANCE_IMAGE_NAME --storage-sku Premium_LRS
  3. Configure the security settings on your VM to open up required ports. For more information, see "az vm open-port" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open.

    $ az vm open-port -n VM_NAME -g RESOURCE_GROUP --port PORT_NUMBER

    This table identifies what each port is used for.

    PortServicioDescripción
    22SSHGit a través de acceso SSH. Se admite clonar, extraer y subir operaciones a repositorios privados/públicos.
    25SMTPSMTP con soporte de encriptación (STARTTLS).
    80HTTPAcceso a aplicación web. Todas las solicitudes se redirigen al puerto HTTPS cuando se habilita SSL.
    122SSHAcceso a shell de instancia. El puerto SSH predeterminado (22) se dedica a la aplicación de Git y el tráfico de red SSH.
    161/UDPSNMPSe requiere para operar el protocolo de revisión de red.
    443HTTPSAplicación web y Git a través de acceso HTTPS.
    1194/UDPVPNTúnel de red de replicación segura en la configuración de alta disponibilidad.
    8080HTTPConsola de administración basada en la web de texto simple. No es obligatorio a menos que SSL se deshabilite de forma manual.
    8443HTTPSConsola de administración seguro basada en la web. Necesario para la instalación y la configuración básicas.
    9418GitPuerto simple de protocolo de Git. Únicamente clonar y extraer operaciones a repositorios públicos. Comunicación de red sin cifrar. Si habilitaste el modo privado en tu instancia, entonces solo se requerirá abrir este puerto si también habilitas el acceso de lectura anónimo para Git. Para más información, vea "Aplicación de directivas de administración de repositorios en la empresa".
  4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "az vm disk attach" in the Microsoft documentation.

    Pass in options for the name of your VM (for example, ghe-acme-corp), the resource group, the premium storage SKU, the size of the disk (for example, 200), and a name for the resulting VHD.

    $ az vm disk attach --vm-name VM_NAME -g RESOURCE_GROUP --sku Premium_LRS --new -z SIZE_IN_GB --name ghe-data.vhd --caching ReadWrite

    Note: For non-production instances to have sufficient I/O throughput, the recommended minimum disk size is 150 GiB with read/write cache enabled (--caching ReadWrite).

Configuring the GitHub Enterprise Server virtual machine

  1. Before configuring the VM, you must wait for it to enter ReadyRole status. Check the status of the VM with the vm list command. For more information, see "az vm list" in the Microsoft documentation.

    $ az vm list -d -g RESOURCE_GROUP -o table
    > Name    ResourceGroup    PowerState    PublicIps     Fqdns    Location    Zones
    > ------  ---------------  ------------  ------------  -------  ----------  -------
    > VM_NAME RESOURCE_GROUP   VM running    40.76.79.202           eastus
    

    Note: Azure does not automatically create a FQDNS entry for the VM. For more information, see Azure's guide on how to "Create a fully qualified domain name in the Azure portal for a Linux VM."

  2. Copie el nombre DNS público de la máquina virtual y péguelo en un explorador web.

  3. En el prompt, carga tu archivo de licencia y configura una contraseña de consola de administración. Para obtener más información, consulte "Administrar tu licencia de GitHub Enterprise".

  4. En Consola de administración, configura y guarda la configuración deseada. For more information, see "Configuring the GitHub Enterprise Server appliance."

  5. La instancia se reiniciará automáticamente.

  6. Haga clic en Visitar la instancia.

Azure extension features

GitHub Enterprise Server does not support the installation of Azure extension features. The GitHub Enterprise Server image is shipped with a customized waagent package which only supports basic VM management functions and blocks advanced VM management functions.

To avoid system instability of your GitHub Enterprise Server instance, the walinuxagent service is intentionally run in GitHub Enterprise Server in a restricted mode, explicitly disallowing the agent from being able to install other agents. VM management features that rely on additional agents and extensions beyond that which ships with GitHub Enterprise Server image, such as the Monitoring Agent extension for Azure Insights or Azure Backups, are unsupported.

Because GitHub Enterprise Server runs a customized Linux operating system with only the necessary applications and services, installing or updating operating system packages manually will overwrite these customizations and can cause unexpected behavior. For more information, see "System overview."

Further reading