Skip to main content

此版本的 GitHub Enterprise 将停止服务 2023-01-18. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

Installing GitHub Enterprise Server on OpenStack KVM

To install GitHub Enterprise Server on OpenStack KVM, you must have OpenStack access and download the GitHub Enterprise Server QCOW2 image.

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 GB150 GB200 GB
10-3000848 GB300 GB200 GB
3000-50001264 GB500 GB200 GB
5000-80001696 GB750 GB200 GB
8000-10000+20160 GB1000 GB200 GB

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

vCPU内存最大并行数
864 GB300 个作业
16128 GB700 个作业
32160 GB1300 个作业
64256 GB2000 个作业
96384 GB4000 个作业

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 OpenStack KVM (QCOW2).

  4. Click Download for OpenStack KVM (QCOW2).

Creating the GitHub Enterprise Server instance

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

  1. In OpenStack Horizon, upload the GitHub Enterprise Server image you downloaded. For instructions, see the "Upload an image" section of the OpenStack guide "Upload and manage images."

  2. 创建新虚拟磁盘以用作实例数据的附加存储卷,并根据您的用户许可数配置大小。 For instructions, see the OpenStack guide "Create and manage volumes."

  3. Create a security group, and add a new security group rule for each port in the table below. For instructions, see the OpenStack guide "Configure access and security for instances."

    端口服务说明
    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. Optionally, associate a floating IP to the instance. Depending on your OpenStack setup, you may need to allocate a floating IP to the project and associate it to the instance. Contact your system administrator to determine if this is the case for you. For more information, see "Allocate a floating IP address to an instance" in the OpenStack documentation.

  5. Launch your GitHub Enterprise Server instance using the image, data volume, and security group created in the previous steps. For instructions, see the OpenStack guide "Launch and manage instances."

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