Installing GitHub Enterprise Server on Azure

You can deploy GitHub Enterprise Server on global Azure or Azure Government.

Prerequisites

• 您必须拥有 GitHub Enterprise 许可文件。 有关详细信息，请参阅“设置 GitHub Enterprise Server 试用版”和“关于 GitHub Enterprise 的许可证”。
• You must have an Azure account capable of provisioning new machines. For more information, see the Microsoft Azure website.
• Most actions needed to launch your virtual machine (VM) may also be performed using the Azure Portal. However, we recommend installing the Azure command line interface (CLI) for initial setup. Examples using the Azure CLI 2.0 are included below. For more information, see Azure's guide Install Azure CLI 2.0.

Hardware considerations

• 最低要求
• 存储
• CPU 和内存

最低要求

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

用户许可证	x86-64 vCPU	内存	根存储	附加（数据）存储
试用版、演示版或 10 个轻度用户	4	32 GB	200 GB	150 GB
10-3000	8	48 GB	200 GB	300 GB
3000-5000	12	64 GB	200 GB	500 GB
5000-8000	16	96 GB	200 GB	750 GB
8000-10000+	20	160 GB	200 GB	1000 GB

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

有关这些要求的详细信息，请参阅“Getting started with GitHub Actions for GitHub Enterprise Server”。

如果计划为实例的用户启用 Container registry，则需要更多资源。 有关这些要求的详细信息，请参阅“Getting started with GitHub Packages for your enterprise”。

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

存储

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

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

若要配置 GitHub Actions，必须提供外部 Blob 存储。 有关详细信息，请参阅“Getting started with 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 和内存资源。 有关详细信息，请参阅“Getting started with GitHub Actions for GitHub Enterprise Server”。

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

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

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

Determining the virtual machine type

Before launching 你的 GitHub Enterprise Server 实例 on Azure, you'll need to determine the machine type that best fits the needs of your organization. For more information about memory optimized machines, see Memory optimized virtual machine sizes in the Microsoft Azure documentation. To review the minimum resource requirements for GitHub Enterprise Server, see "Minimum requirements."

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

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

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

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

Creating the GitHub Enterprise Server virtual machine

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

1. Find the most recent GitHub Enterprise Server appliance image. For more information about the vm image list command, see "az vm image list" in the Microsoft documentation.

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

2. Create a new VM using the appliance image you found. For more information, see az vm create in the Microsoft documentation.

   Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see Resource groups in the Microsoft documentation.

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

3. Configure the security settings on your VM to open up required ports. We recommend opening network ports selectively based on the network services you need to expose for administrative and user purposes. For more information, see "Network ports," and az vm open-port in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open.

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

   This table identifies what each port is used for.

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

4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see az vm disk attach in the Microsoft documentation.

   Pass in options for the name of your VM (for example, ghe-acme-corp), the resource group, the premium storage SKU, the size of the disk (for example, 200), and a name for the resulting 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: For non-production instances to have sufficient I/O throughput, the recommended minimum disk size is 150 GiB with read/write cache enabled (--caching ReadWrite).

Configuring the GitHub Enterprise Server virtual machine

To configure the instance, you must confirm the instance's status, upload a license file, set the root 管理控制台 password, configure the instance's settings, and restart the instance.

1. Before configuring the VM, you must wait for it to enter ReadyRole status. Check the status of the VM with the vm list command. For more information, see az vm list in the Microsoft documentation.

   $ 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 does not automatically create a FQDNS entry for the VM. For more information, see the Azure guide Create a fully qualified domain name in the Azure portal for a Linux VM.

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

Azure extension features

GitHub Enterprise Server does not support the installation of Azure extension features. The GitHub Enterprise Server image is shipped with a customized waagent package which only supports basic VM management functions and blocks advanced VM management functions.

To avoid system instability of your GitHub Enterprise Server instance, the walinuxagent service is intentionally run in GitHub Enterprise Server in a restricted mode, explicitly disallowing the agent from being able to install other agents. VM management features that rely on additional agents and extensions beyond that which ships with GitHub Enterprise Server image, such as the Monitoring Agent extension for Azure Insights or Azure Backups, are unsupported.

Because GitHub Enterprise Server runs a customized Linux operating system with only the necessary applications and services, installing or updating operating system packages manually will overwrite these customizations and can cause unexpected behavior. For more information, see "系统概览."

Further reading

• "系统概览"
• "关于升级到新版本"