Skip to main content

Installing GitHub Enterprise Server on Google Cloud Platform

To install GitHub Enterprise Server on Google Cloud Platform, you must deploy onto a supported machine type and use a persistent standard disk or a persistent SSD.

Prerequisites

Hardware considerations

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.

用户许可证vCPU内存根存储附加(数据)存储
试用版、演示版或 10 个轻度用户432 GB200 GB150 GB
10-3000848 GB200 GB300 GB
3000-50001264 GB200 GB500 GB
5000-80001696 GB200 GB750 GB
8000-10000+20160 GB200 GB1000 GB

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

vCPU内存最大并行数
864 GB740 个作业
16128 GB1250 个作业
32160 GB2700 个作业
64256 GB4500 个作业
96384 GB7000 个作业

For more information about these requirements, see "Getting started with GitHub Actions for GitHub Enterprise Server."

有关调整现有实例的资源的详细信息,请参阅“增加存储容量”和“增加 CPU 或内存资源”。

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

增加 CPU 资源时,我们建议为实例预配的每个 vCPU(最多 16 个 vCPU)增加至少 6.5 GB 的内存。 如果您使用的 vCPU 超过 16 个,则无需为每个 vCPU 添加 6.5 GB 内存,但应监控您的实例以确保其有足够的内存。

Warning: We recommend that users configure webhook events to notify external systems of activity on GitHub Enterprise Server. Automated checks for changes, or polling, will negatively impact the performance and scalability of your instance. For more information, see "About webhooks."

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

注意:可以随时通过调整实例大小来扩展 CPU 或内存。 但由于调整 CPU 或内存的大小需要对用户停机,因此我们建议超配资源来应对扩展。

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.

    端口服务说明
    22SSHGit over SSH 访问。 支持克隆、获取和推送操作到公共/私有仓库。
    25SMTP支持加密 (STARTTLS) 的 SMTP。
    80HTTPWeb 应用程序访问。 当 SSL 启用时,所有请求都会重定向到 HTTPS 端口。
    122SSH实例 shell 访问。 默认 SSH 端口 (22) 专用于应用程序 git+ssh 网络流量。
    161/UDPSNMP为网络监视协议操作所需。
    443HTTPSWeb 应用程序和 Git over HTTPS 访问。
    1194/UDPVPN采用高可用性配置的安全复制网络隧道。
    8080HTTP基于纯文本 Web 的 管理控制台。 除非手动禁用 SSL,否则不需要。
    8443HTTPS基于安全 Web 的 管理控制台。 进行基本安装和配置时需要。
    9418Git简单的 Git 协议端口。 仅克隆和获取操作到公共仓库。 未加密的网络通信。 如果在实例上启用了私有模式,则仅当您也启用了匿名 Git 读取访问时才需要打开此端口。 有关详细信息,请参阅“在企业中实施存储库管理策略”。

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. 复制虚拟机的公共 DNS 名称,然后将其粘贴到 web 浏览器中。
  2. 在提示时上传许可文件并设置管理控制台密码。 有关详细信息,请参阅“管理 GitHub Enterprise 的许可”。
  3. 管理控制台 中,配置并保存所需的设置。 For more information, see "Configuring the GitHub Enterprise Server appliance."
  4. 实例将自动重启。
  5. 单击“访问实例”。

Further reading