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

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

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

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

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

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

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

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

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅でをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ サイト管理者] サイドバーで [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 の管理アカウントから、任意のページの右上隅でをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ サイト管理者] サイドバーで [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 を使用したクラスターのメンテナンスモードの管理

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

この記事の内容

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

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

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

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

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

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

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

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

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

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

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

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