Confluence 向けに OpenSearch を設定する

このページは OpenSearch アーリー アクセス プログラム (EAP) 向けです。

現在、OpenSearch はサポートされていません。EAP 期間中は、本番環境でのご利用をお控えください。一部の機能が使用できなくなります。これらはこのページの最後に記載されています。

OpenSearch EAP に関するご質問がある場合や、サポートが必要な場合は、osfc@atlassian.com までご連絡いただくか、カスタマー サポート チャンネルを通じてお問い合わせください。


Confluence インスタンスのサイズや規模が大きくなるにつれて、既定の検索エンジンである Lucene では、インデックスの作成や検索結果を返すのが遅くなる可能性があります。この問題に対処するために、Confluence Data Center はまもなくオプトイン機能として代替の検索エンジンである OpenSearch を提供する予定です。OpenSearch は、マルチノード インスタンスを利用して、プロセス集約型のインデックス作成を管理します。ユーザー インターフェースにおいて、ユーザーの検索エクスペリエンスは変わりません。

要件

  • Confluence 8.9 以降 (非本番環境)

  • OpenSearch 2.9 (これがサポート対象となる唯一のバージョンです)。

OpenSearch をセットアップする

OpenSearch をセットアップするには、次の手順に従います。

  1. OpenSearch クラスターをプロビジョニングします。

  2. Confluence を設定します。

  3. Lucene のインデックスを移行します。

このページでは、これらすべてのアクションについてご説明します。

OpenSearch クラスターをプロビジョニングする

OpenSearch クラスターをプロビジョニングする際、インデックスの作成について心配する必要はありません。Confluence は必要なインデックスを自動で作成します。

  1. OpenSearch 2.9 のクラスターをオンプレミスまたは管理対象サービス (AWS OpenSearch サービスなど) としてプロビジョニングします。クラスターのセットアップについては、OpenSearch のドキュメントをご参照ください。

  2. 推奨されるセキュリティ設定については「OpenSearch クラスターのセキュリティを確保する」をご参照ください。

Confluence を設定する

Confluence はプロパティを使用して、confluence.cfg.xml ファイルのプロパティまたはシステム プロパティとして設定できます。なお、両方とも存在する場合は、システム プロパティが優先されます。

最小構成は次のとおりです。

  • OpenSearch を使用していることを Confluence に伝える。

  • Confluence に OpenSearch クラスターの場所と認証の詳細を提供する。

これらの最小構成オプションは、次の表に記載されています。システム プロパティの完全なリストについては認識済みのシステム プロパティ」をご参照ください。

OpenSearch を使用するように Confluence に伝える

プロパティ

search.platform

opensearchlucene のいずれか

既定は lucene です。

opensearch

クラスターの場所と認証の詳細を提供する

OpenSearch クラスターへの認証には、基本認証 (ユーザー名/パスワード) と IAM という 2 つの方法があります。これらは相互に排他的です。

オプション 1: 基本認証で認証する

プロパティ

opensearch.http.url

OpenSearch クラスターの HTTP URL

https://vpc-hluk-es3-n4nkxafilj53hlzsq4kvp36k7e.ap-southeast-2.es.amazonaws.com

opensearch.username

OpenSearch のユーザー名

admin

opensearch.password

OpenSearch のパスワード

my-password

オプション 2: IAM で認証する (AWS のみ)

プロパティ

opensearch.http.url

AWS の OpenSearch ドメインのホスト、プロトコルなし (http(s)://))

vpc-hluk-es3-n4nkxafilj53hlzsq4kvp36k7e.ap-southeast-2.es.amazonaws.com

opensearch.aws.region

OpenSearch インスタンスの AWS リージョン

ap-southeast-2


設定を確認する

Confluence が OpenSearch で設定されているかどうかは、「システム情報」ページで確認できます。検索プラットフォームに「OpenSearch」と表示されているかをご確認ください。

Lucene インデックスを移行する

Confluence インスタンスが Lucene から OpenSearch に再設定されたら、インデックスに既存のデータを再入力する必要があります。コンテンツ インデックス管理者 UI を使用して、インデックスを再作成できます。

最も簡単な方法は、OpenSearch を使用するようにインスタンスを再設定したあと、ただちにインデックスを再作成することです。ただし、インデックスが完全に再作成されるまで、検索機能が一時的に利用できなくなったり、不完全な結果が返されたりします。これは、単一ノードのインスタンスで利用できる唯一のアプローチです。

インスタンスがクラスター設定で実行されている場合は、次の手順に従うことで検索のダウンタイムを回避できます。

インデックス移行中のダウンタイムを回避する

Confluence インスタンスがクラスター設定で実行されている場合は、この移行プロセス中に検索機能を維持するための手順を実行できます。

  1. Lucene を実行している Confluence クラスターから、「ダーク ノード」(つまり、ロード バランサーからの通常のユーザー トラフィックを処理しない Confluenceノード) をプロビジョニングします。

  2. 移動先の OpenSearch クラスターに接続された OpenSearch でダーク ノードを設定します。

  3. このダーク ノードにログインして、「システム情報」ページで OpenSearch で実行されていることを確認します。

  4. コンテンツ インデックス管理者 UI でインデックス再作成のプロセスを開始します。
    これによって、OpenSearch インデックスに既存のデータが再入力されます。なお、このプロセスには時間を要する場合があります。

  5. OpenSearch インデックスが完全に再作成されたら、このノード正常にドキュメントを検索できることを確認します

  6. 残りのクラスター ノードを Lucene から OpenSearch に設定します。

  7. 必要に応じて、ダーク ノードのプロビジョニングを解除します。

注目すべき変更点

Lucene から OpenSearch に切り替える際には、いくつかの注意すべき重要な違いがあることを知っておく必要があります。これは、既存のプロセスを変更しなければならない場合もあるためです。

本番環境バックアップ ストラテジー

現在、ホーム ディレクトリに Lucene インデックスのバックアップを取ることができます。これにより、復元時に完全なインデックス再作成を実行する必要がなくなります。OpenSearch に切り替えたあとは、スナップショットを使用して別のストラテジーを採用する必要があります。詳細は「本番環境バックアップ ストラテジー」をご参照ください。

インデックス再作成中のダウンタイム (EAP フェーズ中)

このセクションで説明されているケースは、Confluence 8.9. における、本 EAP 機能の現在のステータスに固有するものです。OpenSearch が公開される際には、ダウンタイムなしでインデックス再作成を実行できるよう、このエリアの改善に取り組んでいます。

Lucene では、インデックスが各ノードのローカルにあるため、ダウンタイムなしでインデックスを再作成できます。ただし、OpenSearch での動作は異なります。OpenSearch インデックスは、すべての Confluence ノードで共有されるため、インデックスを再作成するとクラスター全体の検索機能が中断されます。

さらに、速度を最適化するため、インデックスの再作成中はインデックスの更新を無効にしているため、プロセスの途中で突然中断すると、OpenSearch インデックスが機能しなくなる可能性があります。インデックスを復元するには、インデックス再作成のプロセスをやり直すか、スナップショットから復元します。

検索ウィンドウの制限

OpenSearch の結果を表示するウィンドウの既定の制限は 10,000 件です。これは検索で表示できる結果の最大数となり、既定ではメモリ使用量を制限するように設定されています。検索リクエストがこの制限を超えると (たとえば、既存のアプリがその制限を超えるものを検索するようにプログラムされている場合)、次のエラーが表示されます。


Result window is too large, from + size must be less than or equal to: [10000] but was [10010]. See the scroll api for a more efficient way to request large data sets. This limit can be set by changing the [index.max_result_window] index level setting.


この制限によってご利用の環境に問題が起きている場合は、アトラシアンまたはアプリ開発者にお問い合わせください。開発者がこの制限を回避するために採用できる、大量の検索結果を処理するメモリ効率の良い方法が用意されています。


または、当面の回避策として、OpenSearch インデックスの index.max_result_window 設定を増やすこともできます。検索リクエストは、検索結果のウィンドウに比例してヒープ メモリと時間を消費するため、OpenSearch データ ノードに十分なメモリがあることをご確認ください。このインデックス設定については、OpenSearch のドキュメントをご参照ください。

開発中の機能

OpenSearch 統合は Confluence 8.9 のアーリー アクセス プログラム (EAP) 機能です。この統合によって、すべての顧客に対して公開機能としてリリースする前に、自社の環境での機能のプレビューやアプリのテストを実行できるアーリー アクセスが顧客やベンダーに提供されます。

この EAP バージョンでは、次の機能をご利用になれません。これらは後日、公開リリースに含まれる予定です。

  • 英語以外のインデックス言語: サポートされている言語は英語のみとなります。

  • OpenSearch クラスターの問題について管理者に通知するヘルス チェック

  • ダウンタイムなしのインデックス再作成: OpenSearch でインデックスを再作成すると、検索機能が中断されます。つまり、インデックス再作成が完了するまでドキュメントが利用できなくなります (公開リリースでは、このような中断を避けるためにインデックス再作成のプロセスに冗長性のテクニックが採用されます)。

.

最終更新日 2024 年 5 月 16 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.