リポジトリキャッシュの構成

リポジトリキャッシュの構成について

リポジトリキャッシュと呼ばれる特殊な種類のレプリカを作成することで、リポジトリキャッシュを構成できます。次に、リポジトリキャッシュにレプリケートされるリポジトリネットワークを管理するデータの場所ポリシーを設定できます。

クラスタリングでは、リポジトリキャッシュはサポートされていません。

リポジトリキャッシュの DNS

プライマリインスタンスとリポジトリキャッシュの DNS 名は異なっている必要があります。たとえば、プライマリインスタンスが github.example.com にある場合は、キャッシュ名は europe-ci.github.example.com や github.asia.example.com に決定できます。

CI マシンで、プライマリインスタンスではなくリポジトリキャッシュからフェッチするには、Git の url.<base>.insteadOf 構成設定を使用できます。詳細については、Git ドキュメントにある「git-config」を参照してください。

たとえば、CI マシンのグローバル .gitconfig には、次の行が含まれます。

[url "https://europe-ci.github.example.com/"]
    insteadOf = https://github.example.com/

次に、https://github.example.com/myorg/myrepo をフェッチするように Git に要求すると、代わりに https://europe-ci.github.example.com/myorg/myrepo からフェッチされます。

新しい GitHub Enterprise Server インスタンスを希望するプラットフォームにセットアップします。このインスタンスがリポジトリキャッシュになります。詳しくは、「GitHub Enterprise Server インスタンスをセットアップする」をご覧ください。
プライマリアプライアンス上のパスワードと一致する管理者パスワードを設定して続行します。
[レプリカとして設定] をクリックします。
"Add new SSH key（新しいSSH鍵の追加）"の下でSSH鍵を入力してください。
[キーの追加] をクリックします。
SSH を使用して、リポジトリキャッシュの IP アドレスに接続します。
```
ssh -p 122 admin@REPLICA-IP
```
レプリケーション用のキーの組を生成するには、プライマリアプライアンスの IP アドレスを指定して ghe-repl-setup コマンドを使用し、それが返す公開キーをコピーします。
```
ghe-repl-setup PRIMARY_IP
```
プライマリアプライアンスの承認されたキーのリストに公開キーを追加するには、https://PRIMARY-HOSTNAME/setup/settings を参照して、レプリカからコピーしたキーをリストに追加します。
プライマリへの接続を確認し、リポジトリキャッシュに対してレプリカモードを有効にするには、ghe-repl-setup をもう一度実行します。
- リポジトリキャッシュが唯一の追加ノードである場合、引数は必要ありません。
```
ghe-repl-setup PRIMARY-IP
```
- 1 つ以上の既存のレプリカに加えてリポジトリキャッシュを構成する場合は、-a または --add 引数を使います。
```
ghe-repl-setup -a PRIMARY-IP
```
リポジトリキャッシュを構成するには、ghe-repl-node コマンドを使用し、必要なパラメーターを含めます。
- CACHE-LOCATION を、キャッシュがデプロイされているリージョンなどの英数字識別子に置き換えて、リポジトリキャッシュに対して cache-location を設定します。 CACHE-LOCATION 値は、assets や media など、サブドメイン分離で使用するために予約されているサブドメインのいずれにもできません。予約されている名前の一覧については、「Subdomain Isolationの有効化」をご覧ください。
- リポジトリキャッシュに cache-domain を設定し、EXTERNAL-CACHE-DOMAIN を Git クライアントがリポジトリキャッシュへのアクセスに使用するホスト名に置き換えます。 cache-domain を指定しない場合、GitHub Enterprise Server により、インスタンス用に構成されたホスト名の前に、サブドメインとして CACHE-LOCATION 値が付加されます。詳しくは、「インスタンスのホストキーの構成」をご覧ください。
- まだの場合は、DC-NAME をデータセンター名で置き換えて、プライマリと任意のレプリカアプライアンスでデータセンター名を設定します。
```
ghe-repl-node --datacenter DC-NAME
```
- 新しいキャッシュでは、同じデータセンター内の別のキャッシュからシード処理を試みます。リポジトリキャッシュに datacenter を設定し、REPLICA-DC-NAME をノードをデプロイするデータセンターの名前に置き換えます。
```
ghe-repl-node --cache CACHE-LOCATION --cache-domain EXTERNAL-CACHE-DOMAIN --datacenter REPLICA-DC-NAME
```
データストアのレプリケーションを開始するには、ghe-repl-start コマンドを使います。
```
ghe-repl-start
```
Warning

ghe-repl-start を実行すると、プライマリサーバーを短時間使えなくなり、その間、ユーザーには内部サーバーエラーが表示されることがあります。もっとわかりやすいメッセージを表示するには、ghe-repl-start をレプリカノードで実行する前にプライマリノード上で ghe-maintenance -s を実行し、アプライアンスをメンテナンスモードにします。レプリケーションを開始したら、ghe-maintenance -u を使ってメンテナンスモードを無効にします。プライマリノードがメンテナンスモードの間、Git レプリケーションは進行しません。
各データストアのレプリケーションチャネルの状態を確認するには、ghe-repl-status コマンドを使用します。
```
ghe-repl-status
```
リポジトリキャッシュへのリポジトリネットワークのレプリケーションを有効にするには、データの場所ポリシーを設定します。詳しくは、「データの場所ポリシー」をご覧ください。

データの場所ポリシー

spokesctl cache-policy コマンドでリポジトリのデータの場所ポリシーを構成して、データの局所性を制御できます。データの場所ポリシーによって、どのリポジトリネットワークがどのリポジトリキャッシュにレプリケートされているかが決まります。既定では、データの場所ポリシーが構成されるまで、どのリポジトリキャッシュにもリポジトリネットワークはレプリケートされません。

データの場所ポリシーは、Git コンテンツにのみ影響します。 Issue や pull request コメントなどのデータベース内のコンテンツは、ポリシーに関係なくすべてのノードにレプリケートされます。

Note

データの場所のポリシーは、アクセス制御と同じではありません。リポジトリにアクセスできるユーザーを制御するには、リポジトリロールを使用する必要があります。リポジトリのロールについて詳しくは、「Organizationのリポジトリロール」をご覧ください。

--default フラグを使用して、すべてのネットワークをレプリケートするようにポリシーを構成できます。たとえば、次のコマンドでは、すべてのリポジトリネットワークの 1 つのコピーを、cache_location が "kansas" であるリポジトリキャッシュのセットにレプリケートするポリシーが作成されます。

ghe-spokesctl cache-policy set --default 1 kansas

リポジトリネットワークのレプリケーションを構成するには、ネットワークのルートであるリポジトリを指定します。リポジトリネットワークには、リポジトリとリポジトリのすべてのフォークが含まれます。ネットワーク全体をレプリケートしないと、ネットワークの一部をレプリケートすることはできません。

ghe-spokesctl cache-policy set <owner/repository> 1 kansas

ネットワークのレプリカ数を 0 に指定すると、すべてのネットワークをレプリケートし、特定のネットワークを除外するポリシーをオーバーライドできます。たとえば、次のコマンドでは、場所 "kansas" 内のリポジトリキャッシュに、そのネットワークのコピーを含めることができないことが指定されます。

ghe-spokesctl cache-policy set <owner/repository> 0 kansas

特定のキャッシュの場所で、1 より大きいレプリカ数はサポートされていません。

リポジトリ キャッシュの構成

この記事の内容