ステージングインスタンスのセットアップ

ステージング インスタンスについて

GitHub では、お使いの GitHub Enterprise Server インスタンスの構成のバックアップ、更新、または変更をテストするために個別の環境を設定することを推奨しています。 運用システムから分離する必要があるこの環境は、ステージング環境と呼ばれます。

たとえば、データの損失から保護するために、運用インスタンスのバックアップを定期的に検証できます。 運用データのバックアップは、ステージング環境の別の GitHub Enterprise Server インスタンスに定期的に復元できます。 このステージング インスタンスでは、GitHub Enterprise Server の最新の機能リリースへのアップグレードをテストすることもできます。

ステージング環境に関する考慮事項

GitHub Enterprise Server を十分にテストし、運用環境とできるだけ似た環境を再現するために、インスタンスを操作する外部システムを検討してください。 たとえば、ステージング環境では次をテストできます。

• 認証 (特に SAML などの外部認証プロバイダーを使用する場合)
• 外部のチケットシステムとの統合
• 継続的インテグレーションサーバとの統合
• GitHub Enterprise Server APIs を利用する外部のスクリプトあるいはソフトウェア
• メール通知のための外部のSMTPサーバ

ステージングインスタンスのセットアップ

ステージング インスタンスを最初からセットアップしたり、必要に応じてインスタンスを設定したりすることができます。 詳細については、「GitHub Enterprise Server インスタンスをセットアップする」および「GitHub Enterprise を設定する」を参照してください。

または、運用インスタンスのバックアップをステージング インスタンスに復元することで、運用構成を反映するステージング インスタンスを作成することもできます。

1. 運用インスタンスをバックアップします。
2. ステージング インスタンスをセットアップします。
3. GitHub Actions を設定します。
4. GitHub Packages を設定します。
5. 運用バックアップを復元します。
6. インスタンスの設定を確認します。
7. インスタンスの構成を適用します。

1. 運用インスタンスをバックアップする

運用インスタンスと同じデータと設定を含むインスタンスで変更をテストする場合は、GitHub Enterprise Server Backup Utilities を使用して運用インスタンスからデータと設定をバックアップします。 詳しくは、「インスタンスでのバックアップの構成」をご覧ください。

2. ステージング インスタンスをセットアップする

新しいインスタンスをステージング環境として動作するようにセットアップしてください。 ステージングインスタンスのプロビジョニングとインストールについては、本番インスタンスと同じガイドが利用できます。 詳しくは、「GitHub Enterprise Server インスタンスをセットアップする」をご覧ください。

運用インスタンスのバックアップを復元する場合は、次の手順に進みます。 または、インスタンスを手動で設定し、以降の手順にスキップすることもできます。

3. GitHub Actions を設定する

必要に応じて、運用インスタンスで GitHub Actions を使用する場合、運用バックアップを復元する前にステージング インスタンスで機能を設定します。 GitHub Actions を使わない場合は、1 に進んでください。GitHub Packages を構成します。

1. ステージング インスタンスに SSH でアクセスします。 詳しくは、「管理シェル (SSH) にアクセスする」をご覧ください。

   Shell

   ssh -p 122 admin@HOSTNAME
   

2. GitHub Actions の外部ストレージ プロバイダーを使用するようにステージング インスタンスを設定するには、次のコマンドのいずれかを入力します。

   • Azure Blob Storage:

     Shell

     ghe-config secrets.actions.storage.blob-provider "azure"
     

   • Amazon S3:

     Shell

     ghe-config secrets.actions.storage.blob-provider "s3"
     

   • Google Cloud Storage:

     Shell

     ghe-config secrets.actions.storage.blob-provider "gcs"
     

3. 次のコマンドを入力して外部ストレージ接続を構成し、プレースホルダーの値を実際の接続の値に置き換えます。

   • Azure Blob Storage:

     Shell

     ghe-config secrets.actions.storage.azure.connection-string "CONNECTION STRING"
     

   • Amazon S3:

     Shell

     ghe-config secrets.actions.storage.s3.bucket-name "S3 BUCKET NAME"
     ghe-config secrets.actions.storage.s3.service-url "S3 SERVICE URL"
     ghe-config secrets.actions.storage.s3.access-key-id "S3 ACCESS KEY ID"
     ghe-config secrets.actions.storage.s3.access-secret "S3 ACCESS SECRET"
     

     必要に応じて、S3 のパス スタイルのアドレス指定を強制するには、次のコマンドも入力します。

     Shell

     ghe-config secrets.actions.storage.s3.force-path-style true
     

   • Google Cloud Storage:

     Shell

     ghe-config secrets.actions.storage.gcs.service-url "SERVICE URL"
     ghe-config secrets.actions.storage.gcs.bucket-name "BUCKET NAME"
     ghe-config secrets.actions.storage.gcs.access-key-id "HMAC ACCESS ID"
     ghe-config secrets.actions.storage.gcs.access-secret "HMAC SECRET"
     

4. ステージング インスタンスで GitHub Actions を有効にする準備をするには、次のコマンドを入力します。

   Shell

   ghe-config app.actions.enabled true
   

5. 構成の変更を適用するには、次のコマンドを入力します。

   Shell

   ghe-config-apply
   

4. GitHub Packages を設定する

必要に応じて、運用インスタンスで GitHub Packages を使用する場合、運用バックアップを復元する前にステージング インスタンスで機能を設定します。 GitHub Packages を使わない場合は、1 に進んでください。運用バックアップを復元します。

1. ステージング インスタンスに復元するバックアップを確認します。

   • GitHub Enterprise Server Backup Utilities 3.5 以降を使用してバックアップを作成した場合、バックアップには、GitHub Packages の設定が含まれます。 次の手順に進みます。
   • GitHub Enterprise Server Backup Utilities 3.4 以前を使用してバックアップを作成した場合、ステージング インスタンスで GitHub Packages を設定します。 詳しくは、「Enterprise 向けの GitHub Packages を使い始める」をご覧ください。

2. ステージング インスタンスに SSH でアクセスします。 詳しくは、「管理シェル (SSH) にアクセスする」をご覧ください。

   Shell

   ssh -p 122 admin@HOSTNAME
   

3. 次のコマンドを入力して外部ストレージ接続を設定し、プレースホルダーの値を接続の実際の値に置き換えます。

   • Azure Blob Storage:

     Shell

     ghe-config secrets.packages.blob-storage-type "azure"
     ghe-config secrets.packages.azure-container-name "AZURE CONTAINER NAME"
     ghe-config secrets.packages.azure-connection-string "CONNECTION STRING"
     

   • Amazon S3:

     Shell

     ghe-config secrets.packages.blob-storage-type "s3"
     ghe-config secrets.packages.service-url "S3 SERVICE URL"
     ghe-config secrets.packages.s3-bucket "S3 BUCKET NAME"
     ghe-config secrets.packages.aws-access-key "S3 ACCESS KEY ID"
     ghe-config secrets.packages.aws-secret-key "S3 ACCESS SECRET"
     

4. ステージング インスタンスで GitHub Packages を有効にする準備をするには、次のコマンドを入力します。

   Shell

   ghe-config app.packages.enabled true
   

5. 運用バックアップを復元する

ghe-restore コマンドを使用して残りのデータをバックアップから復元します。 詳しくは、「インスタンスでのバックアップの構成」をご覧ください。

ステージング インスタンスが既に設定されており、設定、証明書、ライセンス データを上書きする場合は、コマンドに -c オプションを追加します。 このオプションの詳しい情報については、GitHub Enterprise Server Backup Utilities ドキュメントの「バックアップおよび復元コマンドの使用」を参照してください。

6. インスタンスの設定を確認する

同じホスト名を使用してステージング インスタンスにアクセスするには、macOS または Linux の /etc/hosts ファイル、または Windows の C:\Windows\system32\drivers\etc ファイルを編集して、ステージング インスタンスのホスト名を IP アドレスで解決するようにローカル ホスト ファイルを更新します。

次に、[Management Console] でステージング インスタンスの設定を確認します。 詳しくは、「Web UI からインスタンスを管理する」をご覧ください。

7. インスタンスの構成を適用する

[Management Console] から設定を適用するには、 [設定の保存] をクリックします。

ステージング インスタンスをオンラインに戻す

コストの節約のためにステージング インスタンスの電源をオフにし、必要に応じて電源をオンに戻したりすることができます。

インスタンスをオフラインのままにできる期間は、このバージョンの最新パッチ リリースでは 7 日間から延長され、60 日間になりました。

許可されたオフライン期間内にインスタンスをオンラインに戻すと、GitHub Enterprise Server が正常にインスタンス化されます。 許可された期間を超えてインスタンスがオフラインの状態が続くと、GitHub Enterprise Server によるインスタンス化は失敗し、server has been offline for more than the configured server_rejoin_age_max というテキストのエラー メッセージがシステム ログに表示されることがあります。 「システム ログについて」を参照してください。

インスタンスがエラー状態でスタックしている場合は、これらのコマンドを実行して復旧できます。

sudo mv /data/user/consul/server_metadata.json /data/user/consul/server_metadata.json.bak
ghe-config-apply

参考資料

• 新しいリリースへのアップグレードについて