此版本的 GitHub Enterprise 已停止服务 2021-06-09. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

在 Google Cloud Platform 上安装 GitHub Enterprise Server

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

基本要求

硬件考量因素

最低要求

建议根据 您的 GitHub Enterprise Server 实例 的用户许可数选择不同的硬件配置。 如果预配的资源超过最低要求,您的实例将表现出更好的性能和扩展。

用户许可vCPU内存附加的存储容量根存储容量
试用版、演示版或 10 个轻度用户216 GB100 GB200 GB
10-3000432 GB250 GB200 GB
3000-5000864 GB500 GB200 GB
5000-80001296 GB750 GB200 GB
8000-10000+16128 GB1000 GB200 GB

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

存储器

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

您的实例需要一个独立于根磁盘的持久数据磁盘。 更多信息请参阅“系统概述”。

您可以通过构建一个新实例或使用现有实例来调整实例的根磁盘大小。 更多信息请参阅“增加存储容量”。

CPU 和内存

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

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

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

有关监控 GitHub Enterprise Server 容量和性能的更多信息,请参阅“监控您的设备”。

您可以增加实例的 CPU 或内存资源。 更多信息请参阅“增加 CPU 或内存资源”。

确定机器类型

在 Google Cloud Platform 上启动 您的 GitHub Enterprise Server 实例 之前,您需要确定最符合您的组织需求的机器类型。 要查看 GitHub Enterprise Server 的最低要求,请参阅“最低要求”。

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

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 上防火墙规则的信息,请参阅 Google 指南“防火墙规则概述”。

  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采用高可用性配置的安全复制网络隧道。
    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 ”。

    $ 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

配置实例

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

延伸阅读