Você pode implantar o GitHub Enterprise Server no Azure global ou Azure Government.
Pré-requisitos
- Você deve ter um GitHub Enterprise arquivo de licença. Para obter mais informações, confira "Configurar uma versão de avaliação do GitHub Enterprise Server" e "Sobre licenças para o GitHub Enterprise."
- Você deve ter uma conta do Azure que permita provisionar novas máquinas. Para obter mais informações, acesse o site do Microsoft Azure.
- A maioria das ações necessárias para iniciar sua máquina virtual (VM) também pode ser executada pelo Portal do Azure. No entanto, é recomendável instalar a interface da linha de comando (CLI) do Azure para a configuração inicial. Veja abaixo alguns exemplos de uso da CLI do Azure 2.0. Para obter mais informações, confira o guia do Azure Instalação da CLI 2.0 do Azure.
Considerações sobre hardware
Requisitos mínimos recomendados
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 recomendados, sua instância terá um desempenho e uma escala melhores.
Licenças de usuário | vCPUs x86-64 | Memória | Armazenamento raiz | Armazenamento (de dados) anexado |
---|---|---|---|---|
Teste, demonstração ou 10 usuários leves | 4 | 32 GB | 200 GB | 150 GB |
10-3000 | 8 | 48 GB | 200 GB | 300 GB |
3000-5000 | 12 | 64 GB | 200 GB | 500 GB |
5000-8000 | 16 | 96 GB | 200 GB | 750 GB |
8000-10000+ | 20 | 160 GB | 200 GB | 1000 GB |
Se você pretende habilitar o GitHub Actions ou o GitHub Advanced Security para os usuários da sua instância, mais recursos são necessários.
- GitHub Actions - aumenta a CPU e a memória em 25%
- GitHub Advanced Security - aumentar a CPU e a memória em 15%
Esses ajustes devem ser aplicados aos requisitos básicos de cada nível de usuário.
Para obter mais informações sobre esses requisitos, confira "Primeiros passos com o GitHub Actions para o 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 "Primeiros passos com o GitHub Packages para a sua empresa".
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".
Warning
O armazenamento raiz refere-se ao tamanho total do disco raiz da instância. Quando a instância for inicializada, você verá 200 GB disponíveis no sistema de arquivos raiz. Os 200 GB restantes são reservados para atualizações. 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 "Primeiros passos com o GitHub Actions para o 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 "Primeiros passos com o GitHub Actions para o 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".
Determinar o tipo de máquina virtual
Antes de iniciar o sua instância do GitHub Enterprise Server no Azure, você precisará determinar o tipo de computador que melhor atende às necessidades da sua organização. Para obter mais informações sobre computadores com otimização de memória, confira Tamanhos de máquina virtual otimizados para memória na documentação Microsoft Azure. Para examinar os requisitos mínimos de recursos para dados para GitHub Enterprise Server, confira "Requisitos mínimos recomendados".
Você pode sempre ajustar sua CPU ou memória redimensionando sua instância. Alterar os recursos disponíveis para sua instância requer tempo de inatividade para seus usuários, portanto, a GitHub recomenda recursos de provisionamento excessivo para levar em conta a escala.
O appliance do GitHub Enterprise Server requer um disco de dados de armazenamento premium e é compatível com qualquer VM do Azure que tenha suporte ao armazenamento premium. Os tipos de VMs do Azure com o sufixo s
dão suporte ao armazenamento premium. Para obter mais informações, confira "Quais tipos de discos estão disponíveis no Azure?" e "Armazenamento premium do Azure: design para alto desempenho" na documentação do Azure.
GitHub recomenda uma VM com memória otimizada para GitHub Enterprise Server. Para obter mais informações, confira "Tamanhos de máquina virtual otimizados para memória" na documentação do Azure.
O GitHub Enterprise Server dá suporte a qualquer região compatível com o seu tipo de VM. Para obter mais informações sobre as regiões com suporte para cada VM, confira "Produtos disponíveis por região" do Azure.
Criar a instância da máquina virtual do GitHub Enterprise Server
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".
-
Localize a imagem mais recente do appliance do GitHub Enterprise Server. Para obter mais informações sobre o comando
vm image list
, confira "az vm image list
" na documentação da Microsoft.az vm image list --all -f GitHub-Enterprise | grep '"urn": "GitHub:' | sort -V
-
Crie uma VM usando a imagem do appliance. Para obter mais informações, confira az vm create na documentação da Microsoft.
Veja as opções de nome da VM, grupo de recursos, tamanho da VM, nome da região preferida do Azure, nome da da imagem de VM do appliance que você listou na etapa anterior e o SKU de armazenamento para Premium. Para obter mais informações sobre grupos de recursos, confira Grupos de recursos na documentação da Microsoft.
az vm create -n VM_NAME -g RESOURCE_GROUP --size VM_SIZE -l REGION --image APPLIANCE_IMAGE_NAME --storage-sku Premium_LRS
-
Defina as configurações de segurança na VM para abrir as portas necessárias. Recomendamos abrir portas de rede seletivamente com base nos serviços de rede que você precisa expor para fins administrativos e de usuário. Para obter mais informações, confira "Portas de rede," e az vm open-port na documentação da Microsoft. A tabela abaixo descreve cada porta para determinar quais portas você precisa abrir.
az vm open-port -n VM_NAME -g RESOURCE_GROUP --port PORT_NUMBER
Esta tabela identifica o uso de cada porta.
Porta Serviço Descrição 22 SSH Git sobre acesso via SSH. Clone, buscar e fazer push de operações para repositórios público/privado suportados. 25 SMTP Suporte a SMTP com criptografia (STARTTLS). 80 HTTP Acesso ao aplicativo web. Todas as solicitações são redirecionadas para a porta HTTPS quando o SSL está habilitado. 122 SSH Exemplo de acesso a shell. A porta SSH padrão (22) é dedicada ao tráfego de rede entre o Git e o SSH do aplicativo. 161/UDP SNMP Obrigatória para operações de protocolo de monitoramento de rede. 443 HTTPS Aplicativo web e Git sobre acesso HTTPS. 1194/UDP VPN Túnel de rede de réplica segura na configuração de alta disponibilidade. Criptografado usando WireGuard. 8080 HTTP Baseado em web de texto simples Console de Gerenciamento. Não obrigatória, a menos que o SSL seja desabilitado manualmente. 8443 HTTPS Base segura na web Console de Gerenciamento. Obrigatória para instalação e configuração básicas. 9418 Git Porta de protocolo Simples Git. Clonar e buscar somente as operações para repositórios públicos. Comunicação de rede não criptografada. Se você habilitou o modo privado na sua instância, abrir esta porta só é necessário se você também habilitou o acesso de leitura anônimo do Git. Para obter mais informações, confira "Aplicar as políticas de gerenciamento do repositório na sua empresa". -
Crie e anexe um novo disco de dados não criptografado à VM e configure o tamanho com base na sua contagem de licenças do usuário. Para obter mais informações, confira az vm disk attach na documentação da Microsoft.
Transmita as opções de nome da VM (por exemplo,
ghe-acme-corp
), o grupo de recursos, o SKU de armazenamento premium, o tamanho do disco (por exemplo,200
) e um nome para o VHD resultante.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
Observação: para que as instâncias de não produção tenham uma taxa de transferência de E/S suficiente, o tamanho mínimo recomendado do disco é de 150 GiB com o cache de leitura/gravação habilitado (
--caching ReadWrite
).
Configurar a máquina virtual do GitHub Enterprise Server
Para configurar a instância, você precisa confirmar o status da instância, 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.
-
Antes de configurar a VM, você deve aguardar a entrada no status ReadyRole. Verifique o status da VM com o comando
vm list
. Para obter mais informações, confira az vm list na documentação da Microsoft.$ 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
Observação: o Azure não cria automaticamente uma entrada FQDNS para a VM. Para obter mais informações, confira o guia do Azure Criar um nome de domínio totalmente qualificado no portal do Azure para uma VM do Linux.
- Copie o nome DNS público da máquina virtual e cole-o em um navegador.
-
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".
-
No Console de Gerenciamento, defina e salve as configurações desejadas. Para saber mais, confira "Configurar o GitHub Enterprise".
- A instância será reiniciada automaticamente.
-
Clique em Acessar sua instância.
Recursos da extensão do Azure
O GitHub Enterprise Server não dá suporte à instalação de recursos de extensão do Azure. A imagem do GitHub Enterprise Server é fornecida com um pacote waagent
personalizado que só dá suporte às funções básicas de gerenciamento de VM e bloqueia as funções avançadas de gerenciamento de VM.
Para evitar a instabilidade do sistema da sua instância do GitHub Enterprise Server, o serviço walinuxagent
é executado intencionalmente no GitHub Enterprise Server em um modo restrito, impedindo explicitamente que o agente possa instalar outros agentes. Não há suporte para recursos de gerenciamento de VM que dependem de agentes e extensões adicionais além dos fornecidos com a imagem do GitHub Enterprise Server, como a extensão do Agente de Monitoramento para Insights do Azure ou Backups do Azure.
Como o GitHub Enterprise Server executa um sistema operacional Linux personalizado com apenas os aplicativos e os serviços necessários, a instalação ou a atualização manual dos pacotes do sistema operacional substituirá essas personalizações e poderá causar um comportamento inesperado. Para obter mais informações, confira "Visão geral do sistema".