我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 将停止服务 此版本的 GitHub Enterprise 已停止服务 2020-11-12. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

在 AWS 上安装 GitHub Enterprise Server

要在 Amazon Web Services (AWS) 上安装 GitHub Enterprise Server,您必须启动 Amazon Elastic Compute Cloud (EC2) 实例并创建和连接单独的 Amazon Elastic Block Store (EBS) 数据卷。

本文内容

Did this doc help you?

基本要求

本指南假定您已熟悉以下 AWS 概念:

硬件考量因素

Minimum requirements

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

用户许可vCPU内存附加的存储容量根存储容量
试用版、演示版或 10 个轻度用户216 GB100 GB200 GB
10-3000432 GB250 GB200 GB
3000-5000864 GB500 GB200 GB
5000-80001296 GB750 GB200 GB
8000-10000+16128 GB1000 GB200 GB

For more information about adjusting resources for an existing instance, see "Increasing storage capacity" and "Increasing CPU or memory resources."

存储器

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. 更多信息请参阅“系统概述”。

You can resize your instance's root disk by building a new instance or using an existing instance. 更多信息请参阅“增加存储容量”。

CPU and memory

GitHub Enterprise Server requires more CPU and memory resources depending on levels of activity for users, automations, and integrations.

When you increase CPU resources, we recommend adding at least 6.5 GB of memory for each vCPU (up to 16 vCPUs) that you provision for the instance. When you use more than 16 vCPUs, you don't need to add 6.5 GB of memory for each vCPU, but you should monitor your instance to ensure it has enough memory.

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

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

确定实例类型

在 AWS 上启动 您的 GitHub Enterprise Server 实例 之前,您需要确定最符合您的组织需求的虚拟机类型。

支持的实例类型

以下类型的 EC2 实例支持 GitHub Enterprise Server。 更多信息请参阅 the AWS EC2 实例类型概述页面

EC2 实例类型模型
C3c3.2xlarge、c3.4xlarge、c3.8xlarge
EC2 实例类型模型
C4c4.2xlarge、c4.4xlarge、c4.8xlarge
EC2 实例类型模型
C5c5.large、c5.xlarge、c5.2xlarge、c5.4xlarge、c5.9xlarge、c5.18xlarge
EC2 实例类型模型
M3m3.xlarge、m3.2xlarge
EC2 实例类型模型
M4m4.xlarge、m4.2xlarge、m4.4xlarge、m4.10xlarge、m4.16xlarge
EC2 实例类型模型
M5m5.large、m5.xlarge、m5.2xlarge、m5.4xlarge、m5.12xlarge、m5.24xlarge
EC2 实例类型模型
R4r4.large、r4.xlarge、r4.2xlarge、r4.4xlarge、r4.8xlarge、r4.16xlarge
EC2 实例类型模型
R5r5.large、r5.xlarge、r5.2xlarge、r5.4xlarge、r5.12xlarge、r5.24xlarge
EC2 实例类型模型
X1x1.16xlarge、x1.32xlarge

建议的实例类型

根据您的用户许可数量,我们建议使用以下实例类型。 |

用户许可建议类型
试用版、演示版或 10 个轻度用户r4.large
10 - 3000r4.xlarge
3000 - 5000r4.2xlarge
5000 - 8000r4.4xlarge
8000 - 10000+r4.8xlarge

注意:您可以随时通过调整实例大小来扩展 CPU 或内存。 但由于调整 CPU 或内存的大小需要对用户停机,因此我们建议超配资源来应对扩展。

选择 GitHub Enterprise Server AMI

您可以使用 GitHub Enterprise Server 门户或 AWS CLI 为 GitHub Enterprise Server 选择 Amazon Machine Image (AMI)。

GitHub Enterprise Server 的 AMI 适用于 AWS GovCloud(美国东部和美国西部)区域。 因此,受特定法规要求约束的美国客户可以在符合联邦要求的云环境中运行 GitHub Enterprise Server。 更多关于 AWS 符合联邦和其他标准的合规信息,请参阅 AWS 的 GovCloud (US) 页面以及 AWS 的合规页面

使用 GitHub Enterprise Server 门户选择 AMI

  1. 导航到 GitHub Enterprise Server 下载页面
  2. 单击 Get the latest release of GitHub Enterprise Server(获取 GitHub Enterprise Server 的最新版本)
  3. 在 Select your platform 下拉菜单中,单击 Amazon Web Services
  4. 在 Select your AWS region 下拉菜单中,选择所需地区。
  5. 记下显示的 AMI ID。

使用 AWS CLI 选择 AMI

  1. 使用 AWS CLI 获取由 GitHub 的 AWS 所有者 ID(025577942450 代表 GovCloud,895557238572 代表其他地区)发布的 GitHub Enterprise Server 映像列表。 更多信息请参阅 AWS 文档中的“describe-images”。
    aws ec2 describe-images \
    --owners OWNER ID \
    --query 'sort_by(Images,&Name)[*].{Name:Name,ImageID:ImageId}' \
    --output=text
  2. 记下最新 GitHub Enterprise Server 映像的 AMI ID。

创建安全组

如果是首次设置 AMI,您需要创建安全组并为下表中的每个端口添加新的安全组规则。 更多信息请参阅 AWS 指南“使用安全组”。

  1. 使用 AWS CLI 创建新的安全组。 更多信息请参阅 AWS 文档中的“create-security-group”。

    $ aws ec2 create-security-group --group-name SECURITY_GROUP_NAME --description "SECURITY GROUP DESCRIPTION"
  2. 记下新创建的安全组的安全组 ID (sg-xxxxxxxx)。

  3. 为下表中的每个端口创建安全组规则。 更多信息请参阅 AWS 文档中的 "authorize-security-group-ingress"。

    $ aws ec2 authorize-security-group-ingress --group-id SECURITY_GROUP_ID --protocol PROTOCOL --port PORT_NUMBER --cidr SOURCE IP RANGE

    此表列出了每个端口的用途。

    端口服务描述
    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 协议端口。 仅克隆和获取操作到公共仓库。 未加密的网络通信。

创建 GitHub Enterprise Server 实例

要创建实例,您需要使用 GitHub Enterprise Server AMI 启动 EC2 实例,并连接额外的存储卷来存储实例数据。 更多信息请参阅“硬件考量因素”。

注:您可以加密数据磁盘以获得更高的安全级别,并确保写入实例的所有数据都受到保护。 使用加密磁盘会对性能稍有影响。 如果您决定要对卷加密,我们强烈建议您在首次启动实例之前进行加密。 更多信息请参阅关于 EBS 加密的 Amazon 指南

警告:如果您决定在配置完实例后启用加密,则需要将数据迁移到加密卷,此过程将导致用户停机一段时间。

启动 EC2 实例

在 AWS CLI 中,使用 AMI 以及您创建的安全组启动 EC2 实例。 附上新的块设备,以用作实例数据的存储卷,并根据您的用户许可数配置大小。 更多信息请参阅 AWS 文档中的 "run-instances"。

aws ec2 run-instances \
  --security-group-ids SECURITY_GROUP_ID \
  --instance-type INSTANCE_TYPE \
  --image-id AMI_ID \
  --block-device-mappings '[{"DeviceName":"/dev/xvdf","Ebs":{"VolumeSize":SIZE,"VolumeType":"TYPE"}}]' \
  --region REGION \
  --ebs-optimized

分配弹性 IP 并将其与实例关联

如果是生产实例,我们强烈建议先分配弹性 IP (EIP) 并将其与实例关联,然后再继续进行 GitHub Enterprise Server 配置。 否则,实例重新启动后将无法保留公共 IP 地址。 更多信息请参阅 Amazon 文档中的“分配弹性 IP 地址”和“将弹性 IP 地址与运行的实例关联”。

如果采用生产高可用性配置,主实例和副本实例均应分配单独的 EIP。 更多信息请参阅“配置 GitHub Enterprise Server 以实现高可用性”。

配置 GitHub Enterprise Server 实例

  1. 复制虚拟机的公共 DNS 名称,然后将其粘贴到 web 浏览器中。
  2. 在提示时上传许可文件并设置管理控制台密码。 更多信息请参阅“管理您的 GitHub Enterprise 许可。”
  3. 管理控制台 中,配置并保存您所需的设置。 更多信息请参阅“配置 GitHub Enterprise Server 设备”。
  4. 实例将自动重启。
  5. 单击 Visit your instance(访问您的实例)

延伸阅读

Did this doc help you?