Installing GitHub Enterprise Server on VMware

Prerequisites

• Você deve ter um GitHub Enterprise arquivo de licença. Para obter mais informações, confira "Como configurar uma avaliação do GitHub Enterprise Server" e "Sobre as licenças do GitHub Enterprise".
• You must have a VMware vSphere ESXi Hypervisor, applied to a bare metal machine that will run your GitHub Enterprise Server instances. We support versions 5.5 through 6.7 for GitHub Enterprise Server 3.4 and earlier. ESX version 7.0 is supported for GitHub Enterprise Server 3.5 and later. The ESXi Hypervisor is free and does not include the (optional) vCenter Server. For more information, see the VMware ESXi documentation.
• You will need access to a vSphere Client. If you have vCenter Server you can use the vSphere Web Client. For more information, see the VMware guide "Log in to vCenter Server by Using the vSphere Web Client."

Hardware considerations

• Minimum requirements
• Storage
• CPU and memory

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.

Licenças de usuário	vCPUs	Memória	Armazenamento anexado	Armazenamento raiz
Teste, demonstração ou 10 usuários leves	4	32 GB	150 GB	200 GB
10-3000	8	48 GB	300 GB	200 GB
3000-5000	12	64 GB	500 GB	200 GB
5000-8000	16	96 GB	750 GB	200 GB
8000-10000+	20	160 GB	1000 GB	200 GB

Se você pretende habilitar o GitHub Actions para os usuários da sua instância, mais recursos são necessários.

vCPUs	Memória	Simultaneidade máxima
32	128 GB	1.000 trabalhos
64	256 GB	1.300 trabalhos
96	384 GB	2.200 trabalhos

Para obter mais informações sobre esses requisitos, confira "Introdução ao GitHub Actions para GitHub Enterprise Server".

Para obter mais informações sobre como ajustar os recursos de uma instância existente, confira "Como aumentar a capacidade de armazenamento" e "Como aumentar os recursos de CPU ou de memória".

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."

Quando você aumenta os recursos da CPU, recomendamos adicionar pelo menos 6.5 GB de memória para cada vCPU (até 16 vCPUs) que você fornecer para a instância. Ao usar mais de 16 vCPUs, você não precisa adicionar 6.5 GB de memória para cada vCPU, mas você deve monitorar sua instância para garantir que ela tenha memória suficiente.

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."

Downloading the GitHub Enterprise Server image

1. Baixe sua licença. Para obter mais informações, confira "Como baixar sua licença do GitHub Enterprise".

2. Navegue até a imagem que você deseja usar em sua nova instância.

   • Navegue até Notas sobre a versão.
   • Na barra lateral �  direita, clique na versão que você deseja baixar.
   • Clique em Baixar GitHub Enterprise Server X.X.X.

3. Under "GitHub On-premises", select the "Select your hypervisor" dropdown menu and click VMware ESXi/vSphere (OVA).

4. Click Download for VMware ESXi/vSphere (OVA).

Creating the GitHub Enterprise Server instance

Para criar a instância, você precisará importar a imagem GitHub Enterprise Server para sua máquina virtual e anexar um volume de armazenamento adicional para os dados de sua instância. Para obter mais informações, confira "Considerações sobre hardware".

1. Using the vSphere Windows Client or the vCenter Web Client, import the GitHub Enterprise Server image you downloaded. For instructions, see the VMware guide "Deploy an OVF or OVA Template."
   • When selecting a datastore, choose one with sufficient space to host the VM's disks. For the minimum hardware specifications recommended for your instance size, see "Hardware considerations." We recommend thick provisioning with lazy zeroing.
   • Leave the Power on after deployment box unchecked, as you will need to add an attached storage volume for your repository data after provisioning the VM.
2. Crie um novo disco virtual para usar como um volume de armazenamento conectado para os dados da sua instância e configure o tamanho com base na contagem de licenças do usuário. For instructions, see the VMware guide "Add a New Hard Disk to a Virtual Machine."

Configuring the GitHub Enterprise Server instance

1. Copie o nome DNS público da máquina virtual e cole-o em um navegador.
2. No prompt, carregue seu arquivo de licença e defina uma senha de gerenciamento do console. Para obter mais informações, confira "Como gerenciar sua licença do GitHub Enterprise".
3. No Console de Gerenciamento, defina e salve as configurações desejadas. For more information, see "Configuring the GitHub Enterprise Server appliance."
4. A instância será reiniciada automaticamente.
5. Clique em Acessar sua instância.

Further reading

• "System overview"
• "About upgrades to new releases"