メンテナンスモードの有効化とスケジューリング

メンテナンスモードについて

一部の種類の操作では、お使いの GitHub Enterprise Server インスタンスをオフラインにしてメンテナンスモードにする必要があります。

の新しいバージョンへのアップグレード GitHub Enterprise Server
仮想マシンに割り当てられている CPU、メモリ、またはストレージリソースを拡大する
ある仮想マシンから別の仮想マシンへデータを移行する
GitHub Enterprise Server Backup Utilities スナップショットからのデータの復元
特定の種類の重要なアプリケーション問題のトラブルシューティング

メンテナンスウィンドウのスケジュールは、ユーザに準備時間を与えるために少なくとも30分は先にすることをおすすめします。メンテナンスウィンドウがスケジューリングされると、すべてのユーザにはサイトにアクセスしたときにバナーが表示されます。

インスタンスがメンテナンスモードに入ると、通常のHTTP及びGitアクセスはすべて拒否されます。これには、アプライアンスが状態コード 503 (サービス利用不可) で応答する Web 要求と API 要求が含まれます。 Git fetch、clone、pushの操作も、サイトが一時的に利用できなくなっていることを示すエラーメッセージと共に拒否されます。 GitHub Actionsジョブは実行されません。サイトにブラウザーでアクセスすると、メンテナンスページが表示されます。

メンテナンス操作の初期検証を実行するには、IP 例外リストを構成して、指定された IP アドレスと範囲からのみお使いの GitHub Enterprise Server インスタンスにアクセスできるようにします。 IP 例外リストで指定されていない IP アドレスからお使いの GitHub Enterprise Server インスタンスにアクセスしようとすると、インスタンスがメンテナンスモードのときに送信された応答と一致する応答を受け取ります。

メンテナンスモードの即時有効化あるいは後のためのメンテナンスウィンドウのスケジューリング

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅にあるをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ Site admin] サイドバーで、[[Management Console]] をクリックします。
上部のナビゲーションバーで [メンテナンス] をクリックします。
[有効化とスケジュール] で [メンテナンスモードを有効にする] を選び、メンテナンスモードをすぐに有効にするか、将来のメンテナンス期間をスケジュールするかを決めます。
- メンテナンスモードを直ちに有効にするには、ドロップダウンメニューを選んで [今すぐ] をクリックします。
- 今後のメンテナンス期間をスケジュール設定するには、ドロップダウンメニューを選んで開始時間をクリックします。
(オプション) メンテナンス期間中にユーザーに表示するカスタムメッセージを設定するには、[Set a maintenance mode message] (メンテナンスモードメッセージの設定) フィールドにメッセージを入力します。
ウィンドウのタイミングとオプションのメッセージに問題がなければ、[保存] をクリックします。 [今すぐ] を選択した場合、インスタンスはすぐにメンテナンスモードになります。

IP 例外リストを使い、メンテナンスモードで変更を検証する

IP 例外リストは、お使いの GitHub Enterprise Server インスタンスへの制御された制限付きアクセスを提供します。これは、メンテナンス操作後のサーバーの正常性の初期検証に最適です。有効にすると、お使いの GitHub Enterprise Server インスタンスはメンテナンスモードから除外され、構成された IP アドレスでのみ使用できるようになります。メンテナンスモードのチェックボックスは、状態の変化を反映するように更新されます。

メンテナンスモードを再度有効にすると、IP 例外リストが無効になり、お使いの GitHub Enterprise Server インスタンスメンテナンスモードに戻ります。 IP 例外リストを無効にした場合、お使いの GitHub Enterprise Server インスタンスは通常の操作に戻ります。

コマンドラインユーティリティを使って IP 例外リストを構成することもできます。詳細については、「コマンドラインユーティリティ」および「管理シェル (SSH) にアクセスする」を参照してください。

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅にあるをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ Site admin] サイドバーで、[[Management Console]] をクリックします。
上部のナビゲーションバーで [メンテナンス] をクリックし、メンテナンスモードが既に有効になっていることを確認します。
[IP 例外リストの有効化と構成] で [IP 例外リストの有効化] を選びます。
リストを有効にするチェックボックスの右側に、お使いの GitHub Enterprise Server インスタンスへのアクセスを許可する必要がある、スペース区切りの IP アドレスまたは CIDR ブロックの有効なリストを入力します。
(オプション) メンテナンス期間中にユーザーに表示するカスタムメッセージを設定するには、[Set a maintenance mode message] (メンテナンスモードメッセージの設定) フィールドにメッセージを入力します。
[保存] をクリックします。

$ ghe-cluster-maintenance -h
# Shows options
$ ghe-cluster-maintenance -q
# Queries the current mode
$ ghe-cluster-maintenance -s
# Sets maintenance mode
$ ghe-cluster-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-cluster-maintenance -m "MESSAGE"
# Updates the custom message
$ ghe-cluster-maintenance -u
# Unsets maintenance mode

メンテナンスモードの有効化とスケジューリング

この記事で

メンテナンスモードについて

メンテナンスモードの即時有効化あるいは後のためのメンテナンスウィンドウのスケジューリング

IP 例外リストを使い、メンテナンスモードで変更を検証する

REST API を使用したメンテナンスモードの管理

GitHub CLI を使用したメンテナンスモードの管理

SSH を使用したメンテナンスモードの管理

SSH を使用したクラスターのメンテナンスモードの管理