FessでAWS Elasticsearch Serviceの利用方法

FessがElastic Cloudに対応した話は前回書いたけど、今回は、AWSのElasticsearch Serviceにも対応したので、それについて書いておきます。

AWSのElasticsearch ServiceはElastic Cloudと違い、プラグインを変更することなどはできないので、Elastic Cloudの設定では動かないので、ES_TYPEにawsを追加して対応しました。それ以外は、Elastic Cloudと同じ感じです。

Elasticsearch Serviceを試すために、AWSコンソールに入り、Elasticsearch Serviceのドメインを作成して、試してみます。今回はローカル環境にFessのインスタンスだけを起動して、Elasticsearch Serviceに繋ぎにいく状態で説明します。AWS環境で実際に利用する場合には、FessのインスタンスはECSやEKSに置いて利用することになると思います。ですので、実際に運用する場合には、適切なAWSの権限設定をおこなってください。

AWSコンソールからElasticsearch Serviceにいき、ドメインの作成を押下すると、デプロイタイプの選択が表示されます。

今回は、テスト用に構築するだけなので、「開発およびテスト」を選択します。Elasticsearchのバージョンは、7.9を選択し、次へを押下します。

次に、ドメインの設定が表示され、ドメイン名を設定します。カスタムエンドポイントを利用しなければ、ドメイン名が含まれたURLになります。今回はただの検証が目的なので、自動調整は向こうにします。

データノードは想定する利用状況に適したものを選択します。今回はデフォルトのインスタンスタイプを選択します。t系のインスタンスでは動かないため、注意してください。その他のElasticsearchのノード設定も利用する状況に合わせて、設定してください。

設定ができたら、次へボタンを押下します。

アクセス関連の設定をします。今回はローカル環境から接続しにいくため、VPCでなく、パブリックなアクセスにして、マスターユーザー名とパスワードを設定します。このユーザー名とパスワードがFessからのアクセスで必要になります。アクセスポリシーには、アクセス元のIPを設定しておきます。このアクセス権限まわりの設定は、ご利用の環境に合わせて設定してください。

タグの追加は必要に応じて、設定して、次へボタンを押下します。

最後に設定した内容の確認が表示され、問題がなければ、確認ボタンを押下してください。10分くらいするとElasticsearchクラスタが利用可能になります。

Elasticsearchが利用可能になったら、DockerでFessを起動します。

docker run -p 8080:8080 -it \
  -e ES_HTTP_URL=https://search-〜.es.amazonaws.com \
  -e ES_TYPE=aws \
  -e ES_USERNAME=〜ユーザー名〜 \
  -e ES_PASSWORD=〜パスワード〜 \
   ghcr.io/codelibs/fess:snapshot

ElasticsearchのエンドポイントはAWSコンソール上で確認してください。ユーザー名とパスワードはElasticsearch Serviceでドメイン作成時に設定したものになります。

起動できたら、http://localhost:8080/ にアクセスして確認してください。

FessでElastic Cloudの利用方法

FessElastic Cloudに接続して利用する方法について、忘れないように書いておく。Elastic Cloudは簡単に2週間無料トライアルができるので、とりあえず、ログインして、Elasticsearchの作成をしょうとすると以下の選択が表示される。

ああ

Fessでは、Elasticsearchが使えれば良いので、今回は、Elastic Enterprise Searchを選択して構築する。Create deploymentボタンを押すと、以下のユーザー名とパスワードが表示される。

Downloadボタンを押下すると、ユーザー名とパスワードのcsvがダウンロードされ、Elasticsearchのクラスタが作成開始されるので、しばらく待つと、以下のように利用可能な状態になる。このページのElasticsearchのentrypointで、https://〜:〜 でElasticsearchのURLが取得できる。

左のメニューのElasticsearchリンクを押下すると、Elasticsearchクラスタの情報が表示される。

左のメニューのEditリンクを押下すると、クラスタの編集が表示される。

Fessで利用するためには、Elasticsearchプラグインをインストールする必要があるので、Settings and Pluginsリンクを押下する。

analysis-kuromoji、analysis-nori、analysis-smartcnを選択して、Backボタンをおして、クラスタの編集を保存すると、確認画面が表示される。

Confirmボタンを押下すると、プラグインのインストールが始まる。ローリングリスタートで順番にノードが再起動されて適用されていく。しばらく待てば反映される。

以上でElastic CloudがFessで利用できる状態になる。

あとは、Fessを起動したいサーバーで実行すれば良いので、

docker run -p 8080:8080 -it \
  -e ES_HTTP_URL=https://〜:〜 \
  -e ES_TYPE=cloud \
  -e ES_USERNAME=elastic \
  -e ES_PASSWORD=〜パスワード〜 \
   ghcr.io/codelibs/fess:snapshot

とすれば、利用できる。(snapshotの部分は、13.11.1以降を指定する)

Fessの方は激しいクロールとかしなければ、1G以下くらいのメモリーでも動くと思うし、ECSとか、マネージドな環境とかで上げておけば、運用とか楽かも。クロール用とフロント用とか、分けてあげても良いかも。という感じで、手間いらずな環境をいろいろと作れる可能性もありますね。

FessのElastic Cloud対応

Fess 13.11.0でElastic Cloudを検証してみたけど、zip版だと設定すれば使えるかもしれないけど、FessのDocker版では使えなかった…。ということで、ちょっと修正したので、Fess 13.11.1からは使えるはず。

Elastic Cloudで利用するにあたっては、Elasticsearchを構築して、Elastic Cloudの管理画面から
・analysis-kuromoji
・analysis-nori
・analysis-smartcn
のプラグインを入れておく必要がある。

あとは、FessのDocker版を

docker run -p 8080:8080 -it \
 -e ES_HTTP_URL=https://〜.elastic-cloud.com:XXXX \
 -e ES_TYPE=cloud \
 -e ES_USERNAME=elastic \
 -e ES_PASSWORD=〜パスワード〜 \
  ghcr.io/codelibs/fess:snapshot

とすれば、Elastic CloudのElasticsearchを利用して、Fessが起動してくる。そのうち、インストールガイドに書いておくと思う。