Installing GitHub Enterprise Server on Hyper-V

Prerequisites

• Você deve ter um GitHub Enterprise arquivo de licença. For more information, see "Setting up a trial of GitHub Enterprise Server" and "About licenses for GitHub Enterprise."
• You must have Windows Server 2008 through Windows Server 2019, which support Hyper-V.
• Most actions needed to create your virtual machine (VM) may also be performed using the Hyper-V Manager. However, we recommend using the Windows PowerShell command-line shell for initial setup. Examples using PowerShell are included below. For more information, see the Microsoft guide "Getting Started with Windows PowerShell."

Hardware considerations

• Requisitos mínimos
• Armazenamento
• CPU e memória

Requisitos mínimos

Recomendamos diferentes configurações de hardware, dependendo do número de licenças de usuário para your GitHub Enterprise Server instance. Se você fornecer mais recursos do que os requisitos mínimos, sua instância terá um desempenho e uma escala melhores.

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

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

Para obter mais informações sobre o ajuste de recursos para uma instância existente, consulte "aumentar a capacidade de armazenamento" e "aumentar recursos de CPU ou memória".

Armazenamento

Recomendamos um SSD de alto desempenho com operações de alta entrada/saída por segundo (IOPS) e baixa latência para GitHub Enterprise Server. Cargas de trabalho são intensivas em I/O. Se você usar um hipervisor de metal simples, recomendamos anexar diretamente o disco ou usar um disco a partir de uma rede de área de armazenamento (SAN).

A sua instância exige um disco de dados persistente separado do disco raiz. Para obter mais informações, consulte "System overview."

To configure GitHub Actions, you must provide external blob storage. Para obter mais informações, consulte "Primeiros passos com GitHub Actions for GitHub Enterprise Server".

The available space on the root filesystem will be 50% of the total disk size. Você pode redimensionar o disco raiz da sua instância criando uma nova instância ou usando uma instância existente. For more information, see "System overview" and "Increasing storage capacity."

CPU e memória

Os recursos de CPU e memória que GitHub Enterprise Server exige dependem dos níveis de atividade para usuários, automações e integrações.

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. Para obter mais informações, consulte "Primeiros passos com 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.

Para obter mais informações sobre o monitoramento da capacidade e desempenho de GitHub Enterprise Server, consulte "Monitoramento do seu aplicativo".

Você pode aumentar os recursos de memória ou da CPU na sua instância. Para obter mais informações, consulte "Increasing CPU or memory resources."

Downloading the GitHub Enterprise Server image

1. Navegue até the GitHub Enterprise Server download page.
2. Para baixar o arquivo de licença, clique em Download license (Baixar licença).
3. Clique em Get the latest release of GitHub Enterprise Server.
4. Select GitHub On-premises, then click Hyper-V (VHD).
5. Click Download for Hyper-V (VHD).

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, consulte "Considerações de hardware".

1. In PowerShell, create a new Generation 1 virtual machine, configure the size based on your user license count, and attach the GitHub Enterprise Server image you downloaded. For more information, see "New-VM" in the Microsoft documentation.

   PS C:\> New-VM -Generation 1 -Name VM_NAME -MemoryStartupBytes MEMORY_SIZE -BootDevice VHD -VHDPath PATH_TO_VHD  

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. Replace PATH_TO_DATA_DISK with the path to the location where you create the disk. For more information, see "New-VHD" in the Microsoft documentation.

   PS C:\> New-VHD -Path PATH_TO_DATA_DISK -SizeBytes DISK_SIZE

3. Attach the data disk to your instance. For more information, see "Add-VMHardDiskDrive" in the Microsoft documentation.

   PS C:\> Add-VMHardDiskDrive -VMName VM_NAME -Path PATH_TO_DATA_DISK

4. Start the VM. For more information, see "Start-VM" in the Microsoft documentation.

   PS C:\> Start-VM -Name VM_NAME

5. Get the IP address of your VM. For more information, see "Get-VMNetworkAdapter" in the Microsoft documentation.

   PS C:\> (Get-VMNetworkAdapter -VMName VM_NAME).IpAddresses

6. Copy the VM's IP address and paste it into a web browser.

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, consulte "Gerenciar a sua licença para GitHub Enterprise."
3. No Console de gerenciamento, configure 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 Visit your instance (Visite sua instância).

Further reading

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