基本要求
- 您必须拥有 GitHub Enterprise 许可文件。 要下载现有的许可文件或申请试用许可，请访问 enterprise.github.com。 更多信息请参阅“管理您的 GitHub Enterprise 许可。”
- 您必须具有能够启动 EC2 实例和创建 EBS 卷的 AWS 帐户。 更多信息请参阅 Amazon Web Services 网站。
- 启动 您的 GitHub Enterprise Server 实例 所需的大部分操作也可以使用 AWS 管理控制台执行。 不过，我们建议安装 AWS 命令行接口 (CLI) 进行初始设置。 下文介绍了使用 AWS CLI 的示例。 更多信息请参阅 Amzon 指南“使用 AWS 管理控制台”和“什么是 AWS 命令行接口”。
本指南假定您已熟悉以下 AWS 概念：
- 启动 EC2 实例
- 管理 EBS 卷
- 使用安全组（用于管理对实例的网络访问）
- 弹性 IP 地址 (EIP)（强烈建议用于生产环境）
- EC2 和 Virtual Private Cloud（如果计划启动到 Virtual Private Cloud）
硬件考量因素
GitHub Enterprise Server 需要一个与根磁盘分开的持久性数据磁盘。 更多信息请参阅“系统概述”。 建议根据 您的 GitHub Enterprise Server 实例 中使用的用户许可数选择不同的硬件配置。 |
| 用户许可 | vCPU | 内存 | 附加的存储容量 | 根存储容量 |
|---|---|---|---|---|
| 试用版、演示版或 10 个轻度用户 | 2 | 16 GB | 100 GB | 200 GB |
| 10-3000 | 4 | 32 GB | 250 GB | 200 GB |
| 3000-5000 | 8 | 64 GB | 500 GB | 200 GB |
| 5000-8000 | 12 | 96 GB | 750 GB | 200 GB |
| 8000-10000+ | 16 | 128 GB | 1000 GB | 200 GB |
这些是最低限度的建议。 根据您的使用情况（例如用户活动和选定的集成），可能需要更多资源。 增加 CPU 资源时，建议为添加到 GitHub Enterprise Server 实例的每个 CPU（最多 16 个 CPU）添加至少 6.5 GB 内存。 更多信息请参阅“增加 CPU 或内存资源”。
注意： 可以构建新设备或使用现有设备来调整根磁盘的大小。 更多信息请参阅“增加存储容量”。
确定实例类型
在 AWS 上启动 您的 GitHub Enterprise Server 实例 之前，您需要确定最符合您的组织需求的虚拟机类型。
支持的实例类型
以下类型的 EC2 实例支持 GitHub Enterprise Server。 更多信息请参阅 the AWS EC2 实例类型概述页面。
| EC2 实例类型 | 模型 |
|---|---|
| C3 | c3.2xlarge、c3.4xlarge、c3.8xlarge |
| EC2 实例类型 | 模型 |
|---|---|
| C4 | c4.2xlarge、c4.4xlarge、c4.8xlarge |
| EC2 实例类型 | 模型 |
|---|---|
| C5 | c5.large、c5.xlarge、c5.2xlarge、c5.4xlarge、c5.9xlarge、c5.18xlarge |
| EC2 实例类型 | 模型 |
|---|---|
| M3 | m3.xlarge、m3.2xlarge |
| EC2 实例类型 | 模型 |
|---|---|
| M4 | m4.xlarge、m4.2xlarge、m4.4xlarge、m4.10xlarge、m4.16xlarge |
| EC2 实例类型 | 模型 |
|---|---|
| M5 | m5.large、m5.xlarge、m5.2xlarge、m5.4xlarge、m5.12xlarge、m5.24xlarge |
| EC2 实例类型 | 模型 |
|---|---|
| R4 | r4.large、r4.xlarge、r4.2xlarge、r4.4xlarge、r4.8xlarge、r4.16xlarge |
| EC2 实例类型 | 模型 |
|---|---|
| R5 | r5.large、r5.xlarge、r5.2xlarge、r5.4xlarge、r5.12xlarge、r5.24xlarge |
| EC2 实例类型 | 模型 |
|---|---|
| X1 | x1.16xlarge、x1.32xlarge |
建议的实例类型
根据您的用户许可数量，我们建议使用以下实例类型。 |
| 用户许可 | 建议类型 |
|---|---|
| 试用版、演示版或 10 个轻度用户 | r4.large |
| 10 - 3000 | r4.xlarge |
| 3000 - 5000 | r4.2xlarge |
| 5000 - 8000 | r4.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
- 导航到 GitHub Enterprise Server 下载页面。
- 单击 Get the latest release of GitHub Enterprise Server（获取 GitHub Enterprise Server 的最新版本）。
- 在 Select your platform 下拉菜单中，单击 Amazon Web Services。
- 在 Select your AWS region 下拉菜单中，选择所需地区。
- 记下显示的 AMI ID。
使用 AWS CLI 选择 AMI
- 使用 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 - 记下最新 GitHub Enterprise Server 映像的 AMI ID。
创建安全组
如果是首次设置 AMI，您需要创建安全组并为下表中的每个端口添加新的安全组规则。 更多信息请参阅 AWS 指南“使用安全组”。
-
使用 AWS CLI 创建新的安全组。 更多信息请参阅 AWS 文档中的“create-security-group”。
$ aws ec2 create-security-group --group-name SECURITY_GROUP_NAME --description "SECURITY GROUP DESCRIPTION" -
记下新创建的安全组的安全组 ID (
sg-xxxxxxxx)。 -
为下表中的每个端口创建安全组规则。 更多信息请参阅 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此表列出了每个端口的用途。
端口 服务 描述 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 协议端口。 仅克隆和获取操作到公共仓库。 未加密的网络通信。
创建 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 实例
- 复制虚拟机的公共 DNS 名称，然后将其粘贴到 web 浏览器中。
- 在提示时上传许可文件并设置管理控制台密码。 更多信息请参阅“管理您的 GitHub Enterprise 许可。”
- 在 管理控制台 中，配置并保存您所需的设置。 更多信息请参阅“配置 GitHub Enterprise Server 设备”。
- 实例将自动重启。
- 单击 Visit your instance（访问您的实例）。
延伸阅读
- "系统概述"