Skip to main content

Installing GitHub Enterprise Server on Hyper-V

To install GitHub Enterprise Server on Hyper-V, you must deploy onto a machine running Windows Server 2008 through Windows Server 2022.

Prerequisites

Hardware considerations

Requisitos mínimos

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

Licenças de usuáriovCPUs x86-64MemóriaArmazenamento raizArmazenamento (de dados) anexado
Teste, demonstração ou 10 usuários leves432 GB200 GB150 GB
10-3000848 GB200 GB300 GB
3000-50001264 GB200 GB500 GB
5000-80001696 GB200 GB750 GB
8000-10000+20160 GB200 GB1000 GB

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

Para obter mais informações sobre esses requisitos, confira "Getting started with GitHub Actions for GitHub Enterprise Server".

Se você pretende habilitar Container registry para os usuários da sua instância, são necessários mais recursos. Para obter mais informações sobre esses requisitos, confira "Getting started with GitHub Packages for your enterprise".

Para obter mais informações sobre como ajustar recursos para uma instância existente, confira "Aumentar a capacidade de armazenamento" e "Aprimorar os 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, confira "Visão geral do sistema".

Para configurar o GitHub Actions, você precisa fornecer um armazenamento de blobs externo. Para obter mais informações, confira "Getting started with GitHub Actions for GitHub Enterprise Server".

O espaço disponível no sistema de arquivos raiz será 50% do tamanho total do disco. Você pode redimensionar o disco raiz da sua instância criando uma nova instância ou usando uma instância existente. Para obter mais informações, confira "Visão geral do sistema" e "Aumentar a capacidade de armazenamento."

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.

Todas as VMs provisionados para sua instância do GitHub Enterprise Server devem usar a arquitetura de CPU x86-64. Não há suporte para outras arquiteturas, como Aarch64 ou arm64.

Se você pretende habilitar o GitHub Actions para os usuários da sua instância do GitHub Enterprise Server, talvez seja necessário provisionar recursos adicionais de CPU e memória para a instância. Para obter mais informações, confira "Getting started with GitHub Actions for GitHub Enterprise Server".

Quando você aumenta os recursos da CPU, a GitHub recomenda 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.

Aviso: recomendamos que os usuários configurem eventos de webhook para notificar os sistemas externos da atividade no GitHub Enterprise Server. As verificações automatizadas de alterações, ou sondagem, afetarão negativamente o desempenho e a escalabilidade da instância. Para obter mais informações, confira "Sobre webhooks".

Para obter mais informações sobre como monitorar a capacidade e o desempenho de GitHub Enterprise Server, confira "Monitorar sua instância".

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

Downloading the GitHub Enterprise Server image

  1. Baixe sua licença. Para obter mais informações, confira "Fazendo o download da sua licença para o 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 Hyper-V (VHD).

  4. 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, confira "Considerações sobre 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. Se reutilizar um disco existente, confirme se o disco está vazio e se não há partições. 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

Para configurar a instância, você precisa carregar um arquivo de licença, definir a senha raiz Console de Gerenciamento, definir as configurações da instância e reiniciar a instância.

Aviso: para impedir que um invasor comprometa a nova instância, defina pessoalmente a senha raiz Console de Gerenciamento e crie o primeiro usuário o mais rápido possível.

  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 "Gerenciando a sua licença para o GitHub Enterprise".
  3. No Console de Gerenciamento, defina e salve as configurações desejadas. For more information, see "Configuring GitHub Enterprise."
  4. A instância será reiniciada automaticamente.
  5. Clique em Acessar sua instância.

Further reading