Instalar o GitHub Enterprise Server no AWS

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 AWS que possa iniciar instâncias do EC2 e criar volumes EBS. Para obter mais informações, confira o site da Amazon Web Services.
A maioria das ações necessárias para iniciar o sua instância do GitHub Enterprise Server também pode ser executada por meio do console de gerenciamento da AWS. No entanto, é recomendável instalar a interface da linha de comando (CLI) do AWS para a configuração inicial. Veja abaixo alguns exemplos de uso da CLI do AWS. Para obter mais informações, confira os guias da Amazon Como trabalhar com o Console de Gerenciamento da AWS e O que é a interface de linha de comando da AWS.

Observação: no momento, o GitHub Enterprise Server não dá suporte ao uso da API de Metadados do Amazon IMDSv2.

Para usar este guia, você deve conhecer os seguintes conceitos do AWS:

Como iniciar instâncias do EC2
Gerenciar volumes do EBS
Como usar grupos de segurança (para gerenciar o acesso à rede na sua instância)
EIP (Endereços IP elásticos) (altamente recomendado para ambientes de produção)
EC2 e nuvem virtual privada (se você pretende iniciá-la em uma nuvem virtual privada)
Preços da AWS (para calcular e gerenciar os custos)

Para obter um diagrama que fornece uma visão geral de arquitetura, confira o "Diagrama de Arquitetura da AWS para implantação do GitHub Enterprise Server".

Este guia recomenda o princípio do menor privilégio ao configurar sua instância do GitHub Enterprise Server no AWS. Para obter mais informações, veja a documentação do IAM (Gerenciamento de Identidades e Acesso) da AWS.

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á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 para os usuários da sua instância, mais recursos são necessários.

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

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 instância

Antes de iniciar o sua instância do GitHub Enterprise Server no AWS, você precisará determinar o tipo de computador que melhor atende às necessidades da sua organização. Para revisar os requisitos mínimos do GitHub Enterprise Server, confira "Requisitos mínimos".

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.

GitHub recomenda uma instância otimizada para a memória para GitHub Enterprise Server. Para obter mais informações, confira Tipos de Instância do Amazon EC2 no site do Amazon EC2.

Selecionar a AMI do GitHub Enterprise Server

É possível selecionar uma Amazon Machine Image (AMI) para o GitHub Enterprise Server usando o portal do GitHub Enterprise Server na CLI do AWS.

As AMIs para o GitHub Enterprise Server estão disponíveis na região (EUA-Leste e EUA-Oeste) do AWS GovCloud. Com isso, os clientes dos EUA com requisitos regulamentares específicos podem executar o GitHub Enterprise Server em um ambiente em nuvem de conformidade federal. Para obter mais informações sobre a conformidade da AWS com os padrões federais e outros, confira a página do GovCloud (US) da AWS e a página de conformidade da AWS.

Usar o portal do GitHub Enterprise Server para selecionar uma AMI

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.
Em "GitHub na Nuvem", selecione o menu suspenso "Selecionar sua plataforma" e clique na Amazon Web Services.
Escolha o menu suspenso "Selecionar sua região da AWS" e clique na região desejada.
Anote a ID da AMI.

Usar a CLI do AWS para selecionar uma AMI

Usando a CLI da AWS, obtenha uma lista de imagens do GitHub Enterprise Server publicadas pelas IDs do proprietário da AWS do GitHub (025577942450 para GovCloud e 895557238572 para outras regiões). Para obter mais informações, confira describe-images na documentação da AWS.
```
aws ec2 describe-images \
--owners OWNER_ID \
--query 'sort_by(Images,&Name)[*].{Name:Name,ImageID:ImageId}' \
--output=text
```
Anote a ID da AMI para a imagem mais recente do GitHub Enterprise Server.

Criação de um grupo de segurança

Se estiver configurando a AMI pela primeira vez, você terá que criar um grupo de segurança e adicionar uma nova regra de grupo de segurança para cada porta na tabela abaixo. Para obter mais informações, confira o guia da AWS Como usar grupos de segurança.

Usando a CLI do AWS, crie um grupo de segurança. Para obter mais informações, confira create-security-group na documentação da AWS.
```
aws ec2 create-security-group --group-name SECURITY_GROUP_NAME --description "SECURITY GROUP DESCRIPTION"
```
Anote a ID do grupo de segurança (sg-xxxxxxxx) do grupo de segurança recém-criado.

Crie uma regra de grupo de segurança para cada porta da tabela abaixo. 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," and authorize-security-group-ingress na documentação da AWS.

aws ec2 authorize-security-group-ingress --group-id SECURITY_GROUP_ID --protocol PROTOCOL --port PORT_NUMBER --cidr SOURCE IP RANGE

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

Criar a instância do GitHub Enterprise Server

Para criar a instância, você deve iniciar uma instância EC2 com sua AMI do GitHub Enterprise Server e vincular um volume de armazenamento adicional aos dados da sua instância. Para obter mais informações, confira "Considerações sobre hardware".

Observação: você pode criptografar o disco de dados para obter um nível extra de segurança e garantir que todos os dados gravados na sua instância estejam protegidos. Usar discos criptografados gera um leve impacto no desempenho. Se você decidir criptografar o volume, recomendaremos expressamente fazer isso antes de iniciar a instância pela primeira vez. Para obter mais informações, confira o guia da Amazon sobre a criptografia EBS.

Aviso: se você decidir habilitar a criptografia depois de configurar sua instância, precisará migrar seus dados para o volume criptografado, o que vai gerar algum tempo de inatividade para os usuários.

Iniciar uma instância do EC2

Na CLI do AWS, inicie uma instância do EC2 usando sua AMI e o grupo de segurança que você criou. Vincule um novo dispositivo de bloqueio para uso como volume de armazenamento dos dados da sua instância e configure o tamanho com base na contagem de licença de usuário. Para obter mais informações, confira run-instances na documentação da AWS.

aws ec2 run-instances \
  --security-group-ids SECURITY_GROUP_ID \
  --instance-type INSTANCE_TYPE \
  --image-id AMI_ID \
  --block-device-mappings '[{"DeviceName":"/dev/xvdf","Ebs":{"VolumeSize":SIZE,"VolumeType":"TYPE"}}]' \
  --region REGION \
  --ebs-optimized

Alocar uma IP elástica e associá-la com a instância

Se for uma instância de produção, é recomendável alocar uma IP Elástica (EIP) e associá-la à instância antes de seguir para a configuração do GitHub Enterprise Server. Caso contrário, o endereço IP público da instância não será retido após a reinicialização da instância. Para obter mais informações, confira Como alocar um endereço IP elástico e Como associar um endereço IP elástico a uma instância em execução na documentação da Amazon.

As instâncias primária e de réplica devem receber EIPs separados nas configurações de alta disponibilidade de produção. Para obter mais informações, confira "Como configurar a alta disponibilidade".

Configurar a instância do GitHub Enterprise Server

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.

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.