Installing GitHub Enterprise Server on Google Cloud Platform

Prerequisites

• Você deve ter um GitHub Enterprise arquivo de licença. Para obter mais informações, confira "Como configurar uma avaliação do GitHub Enterprise Server" e "Sobre as licenças do GitHub Enterprise".
• You must have a Google Cloud Platform account capable of launching Google Compute Engine (GCE) virtual machine (VM) instances. For more information, see the Google Cloud Platform website and the Google Cloud Platform Documentation.
• Most actions needed to launch your instance may also be performed using the Google Cloud Platform Console. However, we recommend installing the gcloud compute command-line tool for initial setup. Examples using the gcloud compute command-line tool are included below. For more information, see the "gcloud compute" installation and setup guide in the Google documentation.

Hardware considerations

• Minimum requirements
• Storage
• CPU and memory

Minimum requirements

We recommend different hardware configurations depending on the number of user licenses for your GitHub Enterprise Server instance. If you provision more resources than the minimum requirements, your instance will perform and scale better.

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

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

vCPUs	Memória	Simultaneidade máxima
32	128 GB	1.000 trabalhos
64	256 GB	1.300 trabalhos
96	384 GB	2.200 trabalhos

Para obter mais informações sobre esses requisitos, confira "Introdução ao GitHub Actions para GitHub Enterprise Server".

Para obter mais informações sobre como ajustar os recursos de uma instância existente, confira "Como aumentar a capacidade de armazenamento" e "Como aumentar os recursos de CPU ou de memória".

Storage

We recommend a high-performance SSD with high input/output operations per second (IOPS) and low latency for GitHub Enterprise Server. Workloads are I/O intensive. If you use a bare metal hypervisor, we recommend directly attaching the disk or using a disk from a storage area network (SAN).

Your instance requires a persistent data disk separate from the root disk. For more information, see "System overview."

To configure GitHub Actions, you must provide external blob storage. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

The available space on the root filesystem will be 50% of the total disk size. You can resize your instance's root disk by building a new instance or using an existing instance. For more information, see "System overview" and "Increasing storage capacity."

CPU and memory

The CPU and memory resources that GitHub Enterprise Server requires depend on the levels of activity for users, automations, and integrations.

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. For more information, see "Getting started with 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.

For more information about monitoring the capacity and performance of GitHub Enterprise Server, see "Monitoring your appliance."

You can increase your instance's CPU or memory resources. For more information, see "Increasing CPU or memory resources."

Determining the machine type

Before launching your GitHub Enterprise Server instance on Google Cloud Platform, you'll need to determine the machine type that best fits the needs of your organization. To review the minimum requirements for GitHub Enterprise Server, see "Minimum requirements."

GitHub recommends a general-purpose, high-memory machine for GitHub Enterprise Server. For more information, see "Machine types" in the Google Compute Engine documentation.

Selecting the GitHub Enterprise Server image

1. Using the gcloud compute command-line tool, list the public GitHub Enterprise Server images:

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

2. Take note of the image name for the latest GCE image of GitHub Enterprise Server.

Configuring the firewall

GCE virtual machines are created as a member of a network, which has a firewall. For the network associated with the GitHub Enterprise Server VM, you'll need to configure the firewall to allow the required ports listed in the table below. For more information about firewall rules on Google Cloud Platform, see the Google guide "Firewall Rules Overview."

1. Using the gcloud compute command-line tool, create the network. For more information, see "gcloud compute networks create" in the Google documentation.

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

2. Create a firewall rule for each of the ports in the table below. For more information, see "gcloud compute firewall-rules" in the Google documentation.

   $ 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

   This table identifies the required ports and what each port is used for.

   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.
   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 "Como impor políticas de gerenciamento de repositório na sua empresa".

Allocating a static IP and assigning it to the VM

If this is a production appliance, we strongly recommend reserving a static external IP address and assigning it to the GitHub Enterprise Server VM. Otherwise, the public IP address of the VM will not be retained after restarts. For more information, see the Google guide "Reserving a Static External IP Address."

In production High Availability configurations, both primary and replica appliances should be assigned separate static IP addresses.

Creating the GitHub Enterprise Server instance

To create the GitHub Enterprise Server instance, you'll need to create a GCE instance with your GitHub Enterprise Server image and attach an additional storage volume for your instance data. For more information, see "Hardware considerations."

1. Using the gcloud compute command-line tool, create a data disk to use as an attached storage volume for your instance data, and configure the size based on your user license count. For more information, see "gcloud compute disks create" in the Google documentation.

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

2. Then create an instance using the name of the GitHub Enterprise Server image you selected, and attach the data disk. For more information, see "gcloud compute instances create" in the Google documentation.

   $ 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

Configuring the 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, confira "Como gerenciar sua licença do GitHub Enterprise".
3. No Console de Gerenciamento, defina 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 em Acessar sua instância.

Further reading

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