在 Azure 上安装 GitHub Enterprise Server

若要在 Azure 上安装 GitHub Enterprise Server，必须部署到支持高级存储的内存优化实例上。

本文内容

您可以将 GitHub Enterprise Server 部署在全局 Azure 或 Azure Government 上。

先决条件

硬件注意事项

最低推荐要求

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

用户许可证x86-64 vCPU内存根存储附加（数据）存储IOPS
试用版、演示版或 10 个轻度用户432 GB400 GB500 GB600
最多 1,000 个848 GB400 GB500 GB3000
1,000 到 3,0001664 GB400 GB1000 GB6000
3,000 到 5,00032128 GB400 GB1500 GB9000
5,000 到 8,00048256 GB400 GB3000 GB12000
8000-10000+64512 GB400 GB5000 GB15000

如果计划为实例的用户启用 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

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

若要配置 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 或内存资源”。

确定虚拟机类型

在 Azure 上启动 你的 GitHub Enterprise Server 实例 之前，需要确定最符合组织需求的设备类型。 有关内存优化计算机的详细信息，请参阅 Microsoft Azure 文档中的内存优化虚拟机大小。 若要查看 GitHub Enterprise Server 的最低资源要求，请参阅“最低推荐要求”。

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

GitHub Enterprise Server 设备需要高级存储数据磁盘，可以在支持高级存储的任何 Azure VM 上使用。 带有 s 后缀的 Azure VM 类型支持高级存储。 有关详细信息，请参阅 Azure 文档中的“Azure 中提供哪些磁盘类型？” 和“Azure 高级存储：高性能设计”。

GitHub 建议对 GitHub Enterprise Server 使用内存优化的虚拟机。 有关详细信息，请参阅 Azure 文档中的“内存优化虚拟机大小”。

GitHub Enterprise Server 可以在支持您的 VM 类型的任何地区使用。 有关每个 VM 支持的区域的详细信息，请参阅 Azure 的“提供的产品（按区域）”。

创建 GitHub Enterprise Server 虚拟机

要创建实例，需要将 GitHub Enterprise Server 映像导入虚拟机，并为实例数据附加额外的存储卷。 有关详细信息，请参阅“硬件注意事项”。

  1. 找到最新的 GitHub Enterprise Server 设备映像。 有关 vm image list 命令的详细信息，请参阅 Microsoft 文档中的“az vm image list”。

    az vm image list --all -f GitHub-Enterprise | grep '"urn": "GitHub:' | sort -V

  2. 使用找到的设备映像创建新的 VM。 有关详细信息，请参阅 Microsoft 文档中的 az vm create。

    传入以下选项：VM 名称、资源组、VM 大小、首选 Azure 地区名称、上一步中列出的设备映像 VM 的名称，以及用于高级存储的存储 SKU。 有关资源组的详细信息，请参阅 Microsoft 文档中的资源组。

    az vm create -n VM_NAME -g RESOURCE_GROUP --size VM_SIZE -l REGION --image APPLIANCE_IMAGE_NAME --storage-sku Premium_LRS

  3. 在 VM 上配置安全设置，以打开所需端口。 建议根据针对管理和用户方面需要公开的网络服务有选择地打开网络端口。 有关详细信息，请参阅 Microsoft 文档中的“网络端口”和 az vm open-port。 请参阅下表中对每个端口的说明，以确定需要打开的端口。

    az vm open-port -n VM_NAME -g RESOURCE_GROUP --port PORT_NUMBER

    此表列出了每个端口的用途。

    端口服务说明
    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 读取访问时才需要打开此端口。 有关详细信息，请参阅“在企业中实施仓库管理策略”。

  4. 创建新的未加密数据磁盘并将其附加至 VM，然后根据用户许可数配置大小。 有关详细信息，请参阅 Microsoft 文档中的 az vm disk attach。

    传入以下选项：VM 名称（例如 ghe-acme-corp）、资源组、高级存储 SKU、磁盘大小（例如 200）以及生成的 VHD 的名称。

    az vm disk attach --vm-name VM_NAME -g RESOURCE_GROUP --sku Premium_LRS --new -z SIZE_IN_GB --name ghe-data.vhd --caching ReadWrite

    Note

    为确保非生产实例具有足够的 I/O 吞吐量，建议最小磁盘大小为 150 GiB 并启用读/写缓存 (--caching ReadWrite)。

配置 GitHub Enterprise Server 虚拟机

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

Warning

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

  1. 在配置 VM 之前，您必须等待其进入 ReadyRole 状态。 使用 vm list 命令检查 VM 的状态。 有关详细信息，请参阅 Microsoft 文档中的 az vm list。

    $ az vm list -d -g RESOURCE_GROUP -o table
> Name    ResourceGroup    PowerState    PublicIps     Fqdns    Location    Zones
> ------  ---------------  ------------  ------------  -------  ----------  -------
> VM_NAME RESOURCE_GROUP   VM running    40.76.79.202           eastus

    Note

    Azure 不会自动为 VM 创建 FQDNS 条目。 有关详细信息，请参阅 Azure 指南在 Azure 门户中为 Linux VM 创建完全限定域名。

    1. 复制虚拟机的公共 DNS 名称，然后将其粘贴到 web 浏览器中。

  2. 在提示时上传许可文件并设置管理控制台密码。 有关详细信息，请参阅“管理 GitHub Enterprise 的许可证”。

  3. 在 管理控制台 中，配置并保存所需的设置。 有关详细信息，请参阅“配置 GitHub Enterprise”。

    1. 实例将自动重启。

  4. 单击“访问实例”。

Azure 扩展功能

GitHub Enterprise Server 不支持安装 Azure 扩展功能。 GitHub Enterprise Server 映像随附一个自定义的 waagent 包，该包仅支持基本 VM 管理功能并阻止高级 VM 管理功能。

为避免 GitHub Enterprise Server 实例的系统不稳定，walinuxagent 服务有意在 GitHub Enterprise Server 中以受限模式运行，显式地禁止代理安装其他代理。 不支持依赖于 GitHub Enterprise Server 映像附带的其他代理和扩展的 VM 管理功能，例如 Azure Insights 或 Azure 备份的监视代理扩展。

由于 GitHub Enterprise Server 运行仅具有必要应用程序和服务的自定义 Linux 操作系统，因此手动安装或更新操作系统包将覆盖这些自定义项并可能导致意外行为。 有关详细信息，请参阅“系统概览”。

其他阅读材料