在 Google Cloud Platform 上安装 GitHub Enterprise Server

要在 Google Cloud Platform 上安装 GitHub Enterprise Server，您必须部署到受支持的机器类型上，并使用持久标准磁盘或持久 SSD。

本文内容

先决条件

硬件注意事项

最低推荐要求

建议根据 你的 GitHub Enterprise Server 实例 的用户许可数选择不同的硬件配置。 如果预配的资源超过最低推荐要求，则实例将表现更好并且可扩展性更好。

用户许可证x86-64 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

如果计划为实例的用户启用 GitHub Actions 或 GitHub Advanced Security，则需要更多资源。

  • GitHub Actions - 至少增加 25% 的 CPU 和内存。
  • GitHub Advanced Security -至少增加 25% 的 CPU 和内存。

这些调整应适用于每个用户层的基本要求。 建议监视对所有资源的更改，因为可能需要进一步增加。

有关这些要求的详细信息，请参阅“GitHub Actions for GitHub Enterprise Server 使用入门”。

如果计划为实例的用户启用 Container registry，则需要更多资源。 有关这些要求的详细信息，请参阅“企业 GitHub Packages 使用入门”。

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

存储

我们建议为 GitHub Enterprise Server 配置具有高每秒输入/输出操作数 (IOPS) 和低延迟的高性能 SSD。 工作负载是 I/O 密集型的。 如果使用裸机管理程序，建议直接连接磁盘或使用存储区域网络 (SAN) 中的磁盘。

您的实例需要一个独立于根磁盘的持久数据磁盘。 有关详细信息，请参阅“系统概览”。

Warning

根存储是指实例的根磁盘总大小。 当实例启动时，将看到根文件系统上有 100GB 可用空间。 剩余的 100GB 保留用于升级。 有关详细信息，请参阅“系统概览”。

若要配置 GitHub Actions，必须提供外部 Blob 存储。 有关详细信息，请参阅“GitHub Actions for GitHub Enterprise Server 使用入门”。

根文件系统上的可用空间将占磁盘总大小的 50%。 您可以通过构建一个新实例或使用现有实例来调整实例的根磁盘大小。 有关详细信息，请参阅“系统概览”和“增加存储容量”。

CPU 和内存

GitHub Enterprise Server 需要的 CPU 和内存资源取决于用户的活动水平、自动化和集成。

为 你的 GitHub Enterprise Server 实例 预配的任何 VM 都必须使用 x86-64 CPU 体系结构。 其他体系结构（例如 AArch64 或 arm64）均不受支持。

如果计划为 GitHub Enterprise Server 实例的用户启用 GitHub Actions，则可能需要为实例预配额外的 CPU 和内存资源。 有关详细信息，请参阅“GitHub Actions for GitHub Enterprise Server 使用入门”。

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

Warning

建议用户配置 Web 挂钩事件来通知外部系统有关 GitHub Enterprise Server 上的活动。 自动检查更改或轮询将对实例的性能和可扩展性产生不利影响。 有关详细信息，请参阅“关于 web 挂钩”。

有关监视 GitHub Enterprise Server 的容量和性能的详细信息，请参阅“监视实例”。

您可以增加实例的 CPU 或内存资源。 有关详细信息，请参阅“增加 CPU 或内存资源”。

确定机器类型

在 Google Cloud Platform 上启动 你的 GitHub Enterprise Server 实例 之前，你需要确定最适应组织需求的计算机类型。 若要查看 GitHub Enterprise Server 的最低推荐要求，请参阅“最低推荐要求”。

可以随时通过调整实例大小来扩展 CPU 或内存。 更改实例的可用资源需要用户安排出故障时间，因此GitHub建议预配帐户资源以进行缩放。

GitHub 建议对 GitHub Enterprise Server 使用通用高内存设备。 有关详细信息，请参阅 Google Compute Engine 文档中的“计算机类型”。

选择 GitHub Enterprise Server 映像

  1. 使用 gcloud compute 命令行工具，列出公共 GitHub Enterprise Server 映像：

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

  2. 记下 GitHub Enterprise Server 最新 GCE 映像的映像名称。

配置防火墙

GCE 虚拟机作为具有防火墙的网络的成员创建。 对于与 GitHub Enterprise Server VM 关联的网络，您需要将防火墙配置为允许下表中列出的必需端口。 建议根据针对管理和用户方面需要公开的网络服务有选择地打开网络端口。 有关详细信息，请参阅 Google Cloud Platform 文档中的“网络端口”和防火墙规则概述。

  1. 使用 gcloud compute 命令行工具创建网络。 有关详细信息，请参阅 Google 文档中的 gcloud compute networks create。

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

  2. 为下表中的各个端口创建防火墙规则。 有关详细信息，请参阅 Google 文档中的 gcloud compute firewall-rules。

    $ 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

    此表列出了必需端口以及各端口的用途。

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

分配静态 IP 并将其分配给 VM

如果此设备为生产设备，强烈建议保留静态外部 IP 地址并将其分配给 GitHub Enterprise Server VM。 否则，重新启动后将不会保留 VM 的公共 IP 地址。 有关详细信息，请参阅 Google 指南保留静态外部 IP 地址。

在生产高可用性配置中，主设备和副本设备均应获得单独的静态 IP 地址。

创建 GitHub Enterprise Server 实例

要创建 GitHub Enterprise Server 实例，您需要使用 GitHub Enterprise Server 映像创建 GCE 实例并连接额外的存储卷来存储实例数据。 有关详细信息，请参阅“硬件注意事项”。

  1. 使用 gcloud compute 命令行工具，创建数据磁盘，将其用作您的实例数据的附加存储卷，并根据用户许可数配置大小。 有关详细信息，请参阅 Google 文档中的 gcloud compute disks create。

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

  2. 然后，使用所选 GitHub Enterprise Server 映像的名称创建实例，并连接数据磁盘。 有关详细信息，请参阅 Google 文档中的 gcloud compute instances create。

    $ 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

配置实例

若要配置实例，必须上传许可证文件，设置 根管理控制台 密码，配置实例的设置，然后重启实例。

Warning

若要防止攻击者破坏新实例，请确保你亲自设置 根管理控制台 密码，并尽快创建第一个用户。

  1. 复制虚拟机的公共 DNS 名称，然后将其粘贴到 web 浏览器中。
  2. 在提示时上传许可文件并设置管理控制台密码。 有关详细信息，请参阅“管理 GitHub Enterprise 的许可证”。
  3. 在 管理控制台 中，配置并保存所需的设置。 有关详细信息，请参阅“配置 GitHub Enterprise”。
  4. 实例将自动重启。
  5. 单击“访问实例”。

延伸阅读