GitHub Enterprise Server でロードバランサを使用する

ロードバランサーについて

ロードバランサの設計では、ネットワークデバイスを使ってGit及びHTTPのトラフィックを個々のGitHub Enterprise Serverアプライアンスに向かわせます。ロードバランサを使って、セキュリティのためにアプライアンスへの直接のトラフィックを制限したり、必要に応じてDNSのレコードを変更することなくトラフィックをリダイレクトしたりできます。 PROXYプロトコルをサポートするTCPベースのロードバランサを使うことを強くおすすめします。

GitHub Enterprise Serverのホスト名に対するDNSルックアップは、ロードバランサに解決されなければなりません。 Subdomain Isolationを有効化することをおすすめします。サブドメイン分離が有効化されている場合、追加のワイルドカードレコード (*.HOSTNAME) もロードバランサーに解決されなければなりません。詳しくは、「Subdomain Isolationの有効化」を参照してください。

クライアントの接続情報の処理

GitHub Enterprise Server へのクライアント接続はロードバランサから来ることになるため、クライアントの IP アドレスは失われることがあります。

使用しているロードバランサがサポートできるなら、PROXYプロトコルの利用を強くおすすめします。 PROXY サポートが利用できない場合でも、X-Forwarded-For ヘッダーを使って HTTP および HTTPS ポートを負荷分散できます。

セキュリティの警告: PROXY サポートあるいは HTTP フォワーディングが有効化されている場合、外部のトラフィックが直接 GitHub Enterprise Server アプライアンスに到達できないことが重要です。外部トラフィックが適切にブロックされていない場合、ソース IP アドレスが偽造されるかもしれません。

警告: ロードバランサーの HTTPS 接続を終了する場合、ロードバランサーから GitHub Enterprise Server への要求も HTTPS を使用する必要があります。接続の HTTP へのダウングレードはサポートされません。

お使いの GitHub Enterprise Server インスタンスでの PROXY プロトコルサポートの有効化

インスタンスとロードバランサーの両方で PROXY プロトコルサポートを有効にすることを強くおすすめします。ロードバランサでPROXYプロトコルを有効化する方法については、ベンダーが提供する指示に従ってください。詳細については、PROXY プロトコルのドキュメントを参照してください。

注: GitHub Enterprise Server は、AWS ネットワークロードバランサーと互換性のない PROXY プロトコル V1 をサポートしています。 GitHub Enterprise Server で AWS ネットワークロードバランサーを使用する場合は、PROXY サポートを有効にしないでください。

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅でをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ サイト管理者] サイドバーで [Management Console] をクリックします。
[設定] サイドバーで [プライバシー] をクリックします。
[外部ロードバランサー] で、 [PROXY プロトコルのサポートを有効にする] を選択します。
[設定] サイドバーで [設定の保存] をクリックします。

注: [Management Console] に設定を保存すると、システムサービスが再起動され、ユーザーに表示されるダウンタイムが発生する可能性があります。
設定の実行が完了するのを待ってください。

PROXYプロトコルのTCPポートマッピング

送信元ポート	宛先ポート	サービスの説明
22	23	Git over SSH
80	81	HTTP
443	444	HTTPS
8080	8081	Management Console HTTP
8443	8444	Management Console HTTPS
9418	9419	Git

お使いの GitHub Enterprise Server インスタンスでの X-Forwarded-For サポートの有効化

X-Forwarded-For プロトコルは、PROXY プロトコルが使用できない場合にのみ使用します。 X-Forwarded-For ヘッダーは HTTP と HTTPS でのみ機能します。 SSH経由のGit接続で示されるIPアドレスは、ロードバランサのIPを示します。

警告: お使いの GitHub Enterprise Server インスタンスとロードバランサーの X-Forwarded-For サポートを構成すると、[Management Console] に接続できない可能性があります。詳しくは、「GitHub Enterprise Server でロードバランサを使用する」を参照してください。

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅でをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ サイト管理者] サイドバーで [Management Console] をクリックします。
[設定] サイドバーで [プライバシー] をクリックします。
[外部ロードバランサー] で、 [HTTP X-Forwarded-For ヘッダーを許可する] を選択します。
[設定] サイドバーで [設定の保存] をクリックします。

注: [Management Console] に設定を保存すると、システムサービスが再起動され、ユーザーに表示されるダウンタイムが発生する可能性があります。
設定の実行が完了するのを待ってください。

PROXYサポートなしで使うプロトコルのTCPポートマッピング

送信元ポート	宛先ポート	サービスの説明
22	22	Git over SSH
25	25	SMTP
80	80	HTTP
443	443	HTTPS
8080	8080	Management Console HTTP
8443	8443	Management Console HTTPS

健全性チェックの設定

ロードバランサは健全性チェックによって、事前に設定されたチェックが失敗するようになったノードがあれば、反応しなくなったノードへのトラフィックの送信を止めます。メンテナンスもしくは予想外の障害のためにインスタンスがオフラインになっている場合、ロードバランサーでは状態ページを表示できます。 High Availability（HA）設定では、ロードバランサはフェイルオーバーの戦略の一部として利用できます。ただし、HAペアの自動フェイルオーバーはサポートされていません。レプリカインスタンスは、手動で昇格させると要求に応えられるようになります。詳しくは、「高可用性の構成」を参照してください。

次の URL をチェックするようにロードバランサーを構成します。

http(s)://HOSTNAME/status

ノードが正常でエンドユーザーからの要求に応えられる場合、このエンドポイントによって状態コード 200 (OK) が返されます。詳しくは、「High Availability 設定の監視」を参照してください。

注: アプライアンスがメンテナンスモードの場合、https://HOSTNAME/status URL は状態コード 503 (サービス利用不可) を返します。詳しくは、「メンテナンスモードの有効化とスケジューリング」を参照してください。

ロードバランサーを介した接続のトラブルシューティング

ロードバランサーを介してお使いの GitHub Enterprise Server インスタンス上のサービスに接続できない場合は、次の情報を確認して問題のトラブルシューティングを行うことができます。

注: ステージング環境でネットワークインフラストラクチャとインスタンス構成に対する変更を常にテストします。詳しくは、「ステージングインスタンスのセットアップ」を参照してください。

エラー: [Management Console] への接続の "セッションの有効期限が切れています"

インスタンスとロードバランサーで X-Forwarded-For ヘッダーのサポートを有効にした場合、インスタンスの [Management Console] にアクセスできない可能性があります。 [Management Console] と接続に必要なポートについて詳しくは、「Web UI からインスタンスを管理する」と「ネットワークポート」を参照してください。

お使いの GitHub Enterprise Server インスタンスにより、ロードバランサーを介して [Management Console] に接続したときにセッションの有効期限が切れたことが示されている場合は、ロードバランサーで次のいずれかの構成を試してください。

ポート 8080 と 8443 でインスタンスへの接続の X-Forwarded-For ヘッダーを無効にします。
レイヤー 4 で動作するようにロードバランサーを構成し、クライアント IP アドレスのパススルーの X-Forwarded-For ではなく PROXY プロトコルを使用します。詳細については、「お使いの GitHub Enterprise Server インスタンスでの PROXY プロトコルサポートの有効化」を参照してください。

詳しくは、ロードバランサーのドキュメントを参照してください。

issue とチェックの実行に対するライブ更新が機能しない

お使いの GitHub Enterprise Server インスタンスにロードバランサーまたはリバースプロキシ経由でアクセスすると、issue に関する新しいコメントや通知バッジの変更、実行出力の確認などの予想されるライブ更新が、ページが更新されるまで表示されない場合があります。これは、リバースプロキシまたはロードバランサーがレイヤー 7 モードで実行されているか、必要な Websocket プロトコルをサポートしていない場合によくあります。

ライブ更新を有効にするには、ロードバランサーまたはプロキシを再構成する必要がある場合があります。詳しくは、ロードバランサーのドキュメントを参照してください。

GitHub Enterprise Server でロードバランサを使用する

この記事の内容