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	1,000 ジョブ
64	256 GB	1,300 ジョブ
96	384 GB	2,200 ジョブ

これらの要件の詳細については、「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ごとに少なくとも6.5GBのメモリを追� する（最大16vCPUまで）ことをおすすめします。 16以上のvCPUを使う� �合は、各vCPUごとに6.5GBのメモリを追� する必要はありませんが、インスタンスが十分なメモリを持っているかをモニターするべきです。

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

   Port	サービス	説明
   22	SSH	Git over SSHのアクセス。 パブリック／プライベートリポジトリのクローン、フェッチ、プッシュ操作がサポートされています。
   25	SMTP	暗号化（STARTTLS）付きのSMTPサポート。
   80	HTTP	Webアプリケーションへのアクセス。 SSL が有効になっている� �合、すべての要求は HTTPS ポートにリダイレクトされます。
   122	SSH	インスタンスのシェルへのアクセス。 既定の SSH ポート (22) は、アプリケーションの git+ssh ネットワーク トラフィック専用です。
   161/UDP	SNMP	ネットワークモニタリングプロトコルの処理に必要。
   443	HTTPS	Webアプリケーション及びGit over HTTPSのアクセス。
   1194/UDP	VPN	High Availability設定でのセキュアなレプリケーションネットワークトンネル。
   8080	HTTP	プレーンテキストの Webベースの [Management Console]。 SSL を手動で無効にしない限り必要ありません。
   8443	HTTPS	セキュアな Webベースの [Management Console]。 基本的なインストールと設定に必要です。
   9418	Git	シンプルなGitプロトコルのポートです。 パブリックリポジトリのクローンとフェッチのみができます。 暗号化されていないネットワーク通信。 インスタンスでプライベートモードを有効化した� �合、このポートをオープンする必要があるのは、匿名Git読み取りアクセスも有効化している� �合のみです。 詳細については、「Enterprise でリポジトリ管理ポリシーを適用する」を参照してく� さい。

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. [Management Console] で、目的の設定を構成して保存します。 For more information, see "Configuring the GitHub Enterprise Server appliance."
4. インスタンスは自動的に再起動します。
5. [Visit your instance](インスタンスにアクセスする) をクリックします。

Further reading

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