Instalar o GitHub Enterprise Server no Google Cloud Platform

Pré-requisitos

• 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."
• É preciso ter uma conta do Google Cloud Platform que possa iniciar instâncias de máquina virtual (VM) do Google Compute Engine (GCE). Para obter mais informações, consulte o site do Google Cloud Platform e a documentação do Google Cloud Platform.
• A maioria das ações necessárias para iniciar sua instância também pode ser executada usando o Google Cloud Platform Console. No entanto, é recomendável instalar a ferramenta de linha de comando gcloud compute para a configuração inicial. Veja abaixo alguns exemplos de uso da ferramenta de linha de comando gcloud compute. Para obter mais informações, consulte o guia de instalação e configuração do "gcloud compute" na documentação do Google.

Considerações de hardware

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

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

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

vCPUs	Memória	Rendimento máximo do trabalho
4	32 GB	Demonstração ou testes rápidos
8	64 GB	25 trabalhos
16	160 GB	35 trabalhos
32	256 GB	100 trabalhos

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

Determinar o tipo de máquina

Antes de iniciar a your GitHub Enterprise Server instance no Google Cloud Platform, você terá que determinar o tipo de máquina virtual que melhor se adapta � s demandas da sua organização. Para revisar os requisitos mínimos para GitHub Enterprise Server, consulte "Requisitos mínimos".

GitHub recomenda uma máquina de uso geral e de alta memória para GitHub Enterprise Server. Para obter mais informações, consulte "Tipos de máquina" na documentação do Google Compute Engine.

Selecionar a imagem do GitHub Enterprise Server

1. Usando a ferramenta de linha de comando gcloud compute, liste as imagens públicas do GitHub Enterprise Server:

   $ gcloud compute images list --project github-enterprise-public --no-standard-images

2. Anote o nome da imagem GCE mais recente do GitHub Enterprise Server.

Configurar o firewall

Máquinas virtuais GCE são criadas como integrantes de uma rede que tem um firewall. Na rede associada �  VM do GitHub Enterprise Server, você terá que configurar o firewall para permitir as portas necessárias da tabela abaixo. Para obter mais informações sobre as regras de firewall no Google Cloud Platform, consulte o guia "Visão geral das regras de firewall" do Google.

1. Usando a ferramenta de linha de comando gcloud compute, crie a rede. Para obter mais informações, consulte "criar redes com gcloud compute" na documentação do Google.

   $ gcloud compute networks create NETWORK-NAME --subnet-mode auto

2. Crie uma regra de firewall para cada porta da tabela abaixo. Para obter mais informações, consulte "regras de firewall do gcloud compute" na documentação do Google.

   $ gcloud compute firewall-rules create RULE-NAME \
      --network NETWORK-NAME \
      --allow tcp:22,tcp:25,tcp:80,tcp:122,udp:161,tcp:443,udp:1194,tcp:8080,tcp:8443,tcp:9418,icmp

   Esta tabela identifica as portas necessárias e o uso de cada uma delas.

   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 estiver habilitado.
   122	SSH	Exemplo de acesso a shell. A porta SSH padrão (22) é dedicada ao tráfego de rede git+ssh.
   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.
   8080	HTTP	Baseado em web de texto simples Console de gerenciamento. Não é necessário, a menos que o SSL seja desativado manualmente.
   8443	HTTPS	Base segura na web Console de gerenciamento. Necessário para instalação básica e configuração.
   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 encriptada. 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, consulte "Aplicar políticas de gerenciamento do repositório na sua empresa".

Alocar uma IP estática e associá-la com a VM

Se você estiver trabalhando com um appliance de produção, é altamente recomendável reservar um endereço IP externo estático e atribuí-lo �  VM do GitHub Enterprise Server. Caso contrário, o endereço IP público da VM não será retido após a reinicialização. Para obter mais informações, consulte o guia "Reservar um endereço IP externo estático" do Google.

Nas configurações de alta disponibilidade de produção, os appliances primário e réplica devem receber endereços IP estáticos separados.

Criar a instância do GitHub Enterprise Server

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

1. Usando a ferramenta de linha de comando gcloud compute, crie um disco de dados para usar como volume de armazenamento para os dados da sua instância e configure o tamanho com base na contagem de licenças de usuário. Para obter mais informações, consulte "criar discos no gcloud compute" na documentação do Google.

   $ gcloud compute disks create DATA-DISK-NAME --size DATA-DISK-SIZE --type DATA-DISK-TYPE --zone ZONE

2. Em seguida, crie uma instância usando o nome da imagem selecionada do GitHub Enterprise Server e vincule o disco de dados. Para obter mais informações, consulte "criar instâncias no gcloud compute" na documentação do Google.

   $ gcloud compute instances create INSTANCE-NAME \
   --machine-type n1-standard-8 \
   --image GITHUB-ENTERPRISE-IMAGE-NAME \
   --disk name=DATA-DISK-NAME \
   --metadata serial-port-enable=1 \
   --zone ZONE \
   --network NETWORK-NAME \
   --image-project github-enterprise-public

Configurar a instância

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. Para obter mais informações, consulte "Configurar o appliance do GitHub Enterprise Server".
4. A instância será reiniciada automaticamente.
5. Clique Visit your instance (Visite sua instância).

Leia mais

• "Visão geral do sistema
• "Sobre atualizações para novas versões"