Installing GitHub Enterprise Server on OpenStack KVM

Prerequisites

• 您必须拥有 GitHub Enterprise 许可文件。 有关详细信息，请参阅“设置 GitHub Enterprise Server 的试用版”和“关于 GitHub Enterprise 的许可证。”
• You must have access to an installation of OpenStack Horizon, the web-based user interface to OpenStack services. For more information, see the Horizon documentation.

Hardware considerations

• Minimum requirements
• Storage
• CPU and memory

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 个轻度用户	4	32 GB	150 GB	200 GB
10-3000	8	48 GB	300 GB	200 GB
3000-5000	12	64 GB	500 GB	200 GB
5000-8000	16	96 GB	750 GB	200 GB
8000-10000+	20	160 GB	1000 GB	200 GB

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

vCPU	内存	最大并行数
32	128 GB	1000 个作业
64	256 GB	1300 个作业
96	384 GB	2200 个作业

有关这些要求的详细信息，请参阅“GitHub Enterprise Server 的 GitHub Actions 使用入门”。

有关调整现有实例的资源的详细信息，请参阅“增� 存储容量”和“增�  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 内存，但应监控您的实例以确保其有足够的内存。

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."

   端口	服务	说明
   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	采用高可用性配置的安全复制网络隧道。
   8080	HTTP	基于纯文本 Web 的 管理控制台。 除非手动禁用 SSL，否则不需要。
   8443	HTTPS	基于安全 Web 的 管理控制台。 进行基本安装和配置时需要。
   9418	Git	简单的 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

• "System overview"
• "About upgrades to new releases"