Installing GitHub Enterprise Server on Azure

To install GitHub Enterprise Server on Azure, you must deploy onto a DS-series instance and use Premium-LRS storage.

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

Prerequisites

Hardware considerations

最低要求

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

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

如果您计划为实例用户启用 GitHub Actions,请在“GitHub Enterprise Server 的 GitHub Actions 使用入门”中查阅硬件、外部存储和运行器的要求。

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

存储器

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

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

To configure GitHub Actions, you must provide external blob storage. 更多信息请参阅“GitHub Enterprise Server 的 GitHub Actions 使用入门”。

The available space on the root filesystem will be 50% of the total disk size. 您可以通过构建一个新实例或使用现有实例来调整实例的根磁盘大小。 For more information, see "System overview" and "Increasing storage capacity."

CPU 和内存

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

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. 更多信息请参阅“GitHub Enterprise Server 的 GitHub Actions 使用入门”。

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

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

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

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

Determining the virtual machine type

Before launching your GitHub Enterprise Server instance on Azure, 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 Enterprise Server 设备需要高级存储数据磁盘,可以在支持高级存储的任何 Azure VM 上使用。 带有 `` 后缀的 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":' | 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. For more information, see "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.

    端口服务描述
    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 读取访问时才需要打开此端口。 更多信息请参阅“在企业中实施仓库管理策略”。
  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, 100), 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 40 GiB with read/write cache enabled (--caching ReadWrite).

Configuring the GitHub Enterprise Server virtual machine

  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 Azure's guide on how to "Create a fully qualified domain name in the Azure portal for a Linux VM."

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

  3. 在提示时上传许可文件并设置管理控制台密码。 更多信息请参阅“管理 GitHub Enterprise 的许可”。

  4. 管理控制台 中,配置并保存您所需的设置。 For more information, see "Configuring the GitHub Enterprise Server appliance."

  5. 实例将自动重启。

  6. 单击 Visit your instance(访问您的实例)

Further reading

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或者, 了解如何参与。