Skip to main content

GitHub Enterprise Server 3.13 での Elasticsearch アップグレードの準備

GitHub Enterprise Server をバージョン 3.13 以降にアップグレードする一環として、Elasticsearch サービスがアップグレードされます。

概要

Elasticsearch (ES) によって、GitHub Enterprise Server インスタンスの検索機能が可能になります。 パフォーマンスとセキュリティ態勢を向上させるために、インスタンスをバージョン 3.13 以降にアップグレードすると、アプライアンスの Elasticsearch バージョンが 5.6.16 から 8.7.0 にアップグレードされます。

以下のセクションは、管理者が Elasticsearch アップグレードの準備と監視を行う際に役立ちます。 重要なポイントは以下の通りです。

  • アップグレードにより、検索および監査ログ機能の環境が一時的に低下します。
  • クラスター構成のインスタンスをアップグレードする場合は、スクリプトを実行して ES アップグレード用にクラスターを準備する必要があります。 「クラスタのアップグレード」をご覧ください。
  • バックアップの場合、アップグレードが完了したら、すべての顧客がインスタンスのスナップショットを取得する必要があります。

検索ログと監査ログへの影響

すべての検索インデックスは、ES8 へのアップグレード後に再構築されます。 再構築中はユーザーの検索環境が低下しますが、それ以外の場合は、インスタンスが機能し、使用可能であることが期待されます。 インデックス再構築プロセスはデータ セットのサイズによって異なり、数時間から数日かかる場合があります。

監査ログはアップグレード直後には使用できません。すべての監査ログの移行には数時間かかる場合があります。

インデックスの再構築が完了した直後に (バックアップ ユーティリティを使用して) バックアップを作成し、そのスナップショットを今後のすべての復元に使用することを強くお勧めします。 「インスタンスでのバックアップの構成」をご覧ください。 GitHub Enterprise Server 3.11 または 3.12 を実行しているインスタンスからバックアップを復元する場合、ES に依存するすべてのコンテンツは、ES インデックスが移行され、3.13 インスタンスで再構築された後にのみ使用できます。

Elasticsearch アップグレードの監視

サイト管理者ダッシュボードで ES アップグレードの進行状況を監視できます。

  1. 任意のページの右上で をクリックします。
  2. 左側のサイドバーで、[インデックスの検索] をクリックします。

インデックスの再構築が完了すると、すべての検索インデックスが緑色になり、"100%" と表示されます。

修復ワーカーの数を変更する

既定では、インデックス修復ワーカーの数は、CPU コアの数を 8 で割った値に設定されます (上限は 8)。 インデックスの再構築を高速化するために、ワーカー数を調整できます。 ただし、その前に、負荷への潜在的な影響を考慮する必要があります。

  1. お使いの GitHub Enterprise Server インスタンス に SSH で接続します。 インスタンスが複数のノードで構成されている場合は (高可用性や geo レプリケーションが構成されている場合など)、プライマリ ノードに SSH 接続します。 クラスターを使用する場合は、任意のノードに SSH 接続できます。 HOSTNAME をインスタンスのホスト名、またはノードのホスト名または IP アドレスに置き換えます。 詳しくは、「管理シェル (SSH) にアクセスする」を参照してください。

    Shell
    ssh -p 122 admin@HOSTNAME
    
  2. ワーカーの数を変更するには、次のコマンドを入力します。

    Shell
    ghe-config app.github.es-workers NUMBER-OF-WORKERS
    
  3. ghe-config-apply を実行します。

サイト管理者ダッシュボードの [検索インデックス] セクションで、個々のインデックス再構築のワーカー数を調整することもできます。 「Elasticsearch アップグレードの監視」セクションを参照してください。