Skip to main content

Installing GitHub Enterprise Server on VMware

To install GitHub Enterprise Server on VMware, you must download the VMware vSphere client, and then download and deploy the GitHub Enterprise Server software.

Prerequisites

Hardware considerations

Minimum requirements

We recommend different hardware configurations depending on the number of user licenses for your GitHub Enterprise Server instance. If you provision more resources than the minimum requirements, your instance will perform and scale better.

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

If you plan to enable GitHub Actions for the users of your instance, more resources are required.

For more information about these requirements, see "Getting started with GitHub Actions for GitHub Enterprise Server."

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

Storage

We recommend a high-performance SSD with high input/output operations per second (IOPS) and low latency for GitHub Enterprise Server. Workloads are I/O intensive. If you use a bare metal hypervisor, we recommend directly attaching the disk or using a disk from a storage area network (SAN).

Your instance requires a persistent data disk separate from the root disk. For more information, see "System overview."

To configure GitHub Actions, you must provide external blob storage. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

The available space on the root filesystem will be 50% of the total disk size. You can resize your instance's root disk by building a new instance or using an existing instance. For more information, see "System overview" and "Increasing storage capacity."

CPU and memory

The CPU and memory resources that GitHub Enterprise Server requires depend on the levels of activity for users, automations, and integrations.

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. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

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

Warning: We recommend that users configure webhook events to notify external systems of activity on GitHub Enterprise Server. Automated checks for changes, or polling, will negatively impact the performance and scalability of your instance. For more information, see "About webhooks."

For more information about monitoring the capacity and performance of GitHub Enterprise Server, see "Monitoring your appliance."

You can increase your instance's CPU or memory resources. For more information, see "Increasing CPU or memory resources."

Downloading the GitHub Enterprise Server image

  1. 下载许可。 有关详细信息,请参阅“下载 GitHub Enterprise 的许可”。

  2. 导航到要用于新实例的映像。

    • 导航到发行说明
    • 在右侧边栏中,单击要下载的版本。
    • 单击“下载 GitHub Enterprise Server X.X.X”。
  3. Under "GitHub On-premises", select the "Select your hypervisor" dropdown menu and click VMware ESXi/vSphere (OVA).

  4. Click Download for VMware ESXi/vSphere (OVA).

Creating the GitHub Enterprise Server instance

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

  1. Using the vSphere Windows Client or the vCenter Web Client, import the GitHub Enterprise Server image you downloaded. For instructions, see the VMware guide "Deploy an OVF or OVA Template."
    • When selecting a datastore, choose one with sufficient space to host the VM's disks. For the minimum hardware specifications recommended for your instance size, see "Hardware considerations." We recommend thick provisioning with lazy zeroing.
    • Leave the Power on after deployment box unchecked, as you will need to add an attached storage volume for your repository data after provisioning the VM.
  2. 创建新虚拟磁盘以用作实例数据的附加存储卷,并根据您的用户许可数配置大小。 For instructions, see the VMware guide "Add a New Hard Disk to a Virtual Machine."

Configuring the GitHub Enterprise Server instance

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

Further reading