Luxorインストールの前提条件
Luxorのサポート環境
ハードウェアスペック
ハードウェアの選定にあたっては、ユーザ数、同時処理リクエスト数、データの更新頻度、参照頻度、ネットワーク性能、サーバ構成等あらゆる要件を考慮する必要があります。インストールに必要なLuxorサーバの推奨スペックは下表の通りです。
表 推奨ハードウェアスペック
ハードウェア項目 | 推奨最小スペック |
---|---|
CPU | デュアルコア 2.6GHzまたは同等のもの。 |
メモリ | 1 GB以上の空き容量(Java仮想マシンに割り当てる容量)。 Luxorが使用するJVMヒープサイズを充分に確保しておくことで、Luxorがキャッシュを適切に利用できるようになる。 |
インストールに必要なハードディスク | 700MB程度の空き容量(プログラムだけの容量。インデックス領域は含まない。) インデックス領域はデータ量に依存 |
ソフトウェアスペック
Luxorを動作させるための必要なソフトウェアプラットフォーム及びソフトウェアを説明します。
表 サポートOS
サーバ | OS |
---|---|
Luxorサーバ | Red Hat Enterprise Linux 6.X |
Red Hat Enterprise Linux 7.X | |
CentOS 6.X | |
CentOS 7.X |
また、Luxorをインストールすると以下のソフトウェアが自動的にインストールされます。
注意
使用環境で下記コマンドがあることを確認してください。
・/usr/bin/unzip
サポートJava
Javaのサポートは下表になります。
表 Javaのサポートバージョンについて
サポートするJavaのバージョン |
Java Standard Edition 11 Java Standard Edition 12 |
---|
※ Java11はLuxor Ver.2.2からサポート開始されています。
※ Java12はLuxor Ver.2.4からサポート開始されています。
Javaの環境更新手順は「JREのアップグレード手順」を参照してください。
LuxorでサポートするJDKは、Oracle JDK/OpenJDKです。
Oracle JDKを利用する場合は、Oracle社のサイトから最新版のモジュールを入手してください。別途、Oracle社と有償サポート契約が必要となります。
OpenJDKを利用する場合は、OSベンダーにより提供されているパッケージを利用してください。OSベンダーによる長期サポートが提供されます。
サポートTomcat
Tomcatのサポートは下表になります。
表 Tomcatのサポートバージョンについて
サポートするTomcatのバージョン |
Apache Tomcat 9 Apache Tomcat 8.5 |
---|
※ Tomcat 9はLuxor Ver.2.4からサポート開始されています。Tomcat 9への環境更新手順は「Tomcatのアップグレード手順」を参照してください。
サポートPC環境
Luxor管理画面を利用するクライアントPCのサポート環境は下表になります。
表 クライアントPCのサポート環境
サポートOS | Microsoft Windows / Apple MacOS X |
---|---|
サポートブラウザ |
[Windows] Internet Explorer 11 (ドキュメントモード:IE=Edge) [Windows] Edge [Windows] Firefox ESR 52 / 60 [Windows] Google Chrome (最新版のみ) [MacOS X] Firefox ESR 52 / 60 [MacOS X] Google Chrome (最新版のみ) |
※ Internet Explorerのドキュメントモードは、デフォルト設定としてEdgeモードでの動作となります。
※ Internet Explorerの互換表示は、非推奨となります。
※ Google Chrome は自動更新されるため常に最新版のみがサポート対象となります。
※ Internet Explorerは2016年1月13日以降、マイクロソフト社のサポートポリシーが変更され、最新版のみが技術サポートとセキュリティアップデートの対象となります。古いバージョンでは脆弱性が修正されなくなりますので、早急に最新版へ更新してください。
https://www.microsoft.com/ja-jp/windows/lifecycle/iesupport/
※ 上記サポート対象ブラウザにおいては、ブラウザ起因で発生する動作不良などについてもサポートいたします。但し、ブラウザの不具合などにより発生し弊社製品での解消が困難な場合、対象ブラウザをご使用の際の製品の制限事項とさせて頂く場合がございます。
※ クライアントPCのOSにWindows 10を使用している場合には「Windows 10 October 2018 Update」を適用してください。
INSUITE®がサポートするLuxorのバージョン
INSUITE®がサポートしているLuxorのバージョンは下表の通りです。一部未検証な組み合わせもありますが、理論上使用可能であるため、サポート対象としています。
表 LuxorとINSUITE®のバージョン
INSUITE® | Luxor Ver.1.3.0以前 | Luxor Ver.1.3.X | Luxor Ver.2.X.X |
---|---|---|---|
Ver.3.1.X | ◯ | △ | ☓ |
Ver.3.2.X | ◯ | △ | ☓ |
Ver.3.3.X | △ | ◯ | ☓ |
Ver.3.4.X | △ | ◯ | ☓ |
Ver.3.5.X | △ | △ | ◯ |
Ver.4.0.X | △ | △ | ◯ |
Ver.4.1.X | △ | ◯ | △ |
Ver.4.2.X | △ | ◯ | △ |
Ver.4.3.X | △ | △ | ○ |
Ver.4.4.X | △ | △ | ○ |
Ver.4.5.X | △ | △ | ○ |
Ver.4.6.X | △ | △ | ○ |
Ver.4.7.X | △ | △ | ○ |
Ver.4.8.X | △ | △ | ○ |
Ver.4.9.X〜最新 | △ | △ | ○ |
◯:検証済み △:未検証 ☓:サポート対象外 |
注意事項
INSUITE® Ver.4.3.0から追加された全文検索入力サジェスト機能、コンテンツ機能の全文検索をご利用いただくため、Luxor Ver2.2.0以降が必要となります。
Sm@rtDBがサポートするLuxorのバージョン
Sm@rtDBがサポートしているLuxorのバージョンは下表の通りです。一部未検証な組み合わせもありますが、理論上使用可能であるため、サポート対象としています。
表 LuxorとSm@rtDBのバージョン
Sm@rtDB | Luxor Ver.1.3.0以前 | Luxor Ver.1.3.X | Luxor Ver.2.X.X |
---|---|---|---|
Ver.3.2.X | ☓ | ◯ | ☓ |
Ver.3.4.X | ☓ | ◯ | ☓ |
Ver.3.5.X | ☓ | △ | ☓ |
Ver.3.6.X | ☓ | △ | ◯ |
Ver.4.0.X | ☓ | △ | ◯ |
Ver.4.1.X | ☓ | ◯ | △ |
Ver.4.2.X | ☓ | △ | ○ |
Ver.4.3.X | ☓ | △ | ○ |
Ver.4.4.X | ☓ | △ | ○ |
Ver.4.5.X〜最新 | ☓ | △ | ○ |
◯:検証済み △:未検証 ☓:サポート対象外
注意事項
Sm@rtDB Ver.4.2.0から追加された全文検索入力サジェスト機能をご利用いただくため、Luxor Ver2.2.0以降が必要となります。
各サーバの役割と通信
Luxorサーバと各クライアントサーバ(INSUITE®サーバ/Sm@rtDBサーバ)の構成と役割、ネットワークの通信要件などを説明します。
各サーバの基本構成と役割
以下はINSUITE®およびSm@rtDB環境にLuxorサーバを構築する場合の構成例です。それぞれの役割については、次の表「LuxorサーバとLuxor管理端末の役割」を参照してください。
図 Luxorサーバの構成例
Luxorサーバと管理端末の役割について、次の表に記載します。
表 LuxorサーバとLuxor管理端末の役割
Luxorサーバ | 役割 |
---|---|
Luxorサーバ | 各APサーバより送られてきた検索リクエストに対し、閲覧権限チェックし、検索結果を返すサーバ。HTTPサービスとしてTomcatを利用している。 LuxorサーバはNFSサーバ・DBサーバ・管理サーバに同居させることも可能。性能面の考慮や検索速度を考慮すると、専用サーバに導入することを推奨。 |
Luxor管理端末 | WEBブラウザを使ってLuxor新管理画面を表示する端末。Luxor新管理画面の詳細は『運用ガイド』の「Luxor新管理画面」を参照してください。 Luxor管理端末からLuxorサーバにアクセス可能にあるよう構成する必要がある。 他のユーザ端末からLuxorサーバへのアクセスは不要であるため、DMZ内部への設置が推奨。 |
注意
Luxorサーバをクラスター構成にする場合は1,3,5台等の奇数台構成である必要があります。 詳細は『運用ガイド』の「SolrCloud複数台構成」を参照してください。
各サーバ間の通信要件
Luxorを利用する際、各サーバ間ではデフォルトでBASIC認証を用いて認証を行っています。Luxor管理端末からLuxorサーバにアクセスする場合は、ユーザ名とパスワードが必要になります。
ユーザ名とパスワードは、インストール時に変更可能です。変更方法の詳細については、設定ファイルsetup.confのパラメータluxorUserPassについての記載を参照してください。
表 各サーバ間のプロトコル(デフォルトポート)
サーバ | プロトコル | 通信内容 |
---|---|---|
Luxorサーバ→INSUITE® APサーバ Luxorサーバ→Sm@rtDB APサーバ |
HTTP (デフォルト:80) |
LuxorからINSUITE®/Sm@rtDBへの内部リクエストを行う |
INSUITE® APサーバ・管理サーバ → Luxorサーバ | HTTP (デフォルト:10080) |
INSUITE®からLuxorへの検索、データ登録を行う。 |
Sm@rtDB APサーバ → Luxorサーバ | HTTP (デフォルト:10080) |
Sm@rtDBからLuxorへの検索、データ登録を行う。 |
INSUITE® APサーバ → Sm@rtDB APサーバ | HTTP (デフォルト:80) |
INSUITE®の統合検索画面からSm@rtDBのデータを含んで検索する。 |
Luxor管理端末 → Luxorサーバ | HTTP (デフォルト:10080) |
システム管理者がLuxorの管理画面を参照する。 |
Luxorサーバ | HTTP (デフォルト:18005) |
LuxorのTomcatがシャットダウンのリクエストを受け付ける。 |
ZooKeeper※1 | HTTP (デフォルト:11080、11081、11082) |
・11080:ZooKeeperが対外通信する(即ち、ZooKeeperのクライアント側がZooKeeperへの内部リクエストを行う)ためのポート。setup.confファイル設定用。 ・11081:Luxorが複数台構成にする場合、ZooKeeperクラスター内部サーバ間の通信用ポートzoo.cfgファイル設定用。 ・11082:ZooKeeperクラスター内部サーバ間の通信用ポート。Luxorサーバのリーダーがサービス停止された場合、ZooKeeperがこのポートで新しいリーダーサーバを選出する。zoo.cfgファイル設定用。 |
ActiveMQ※2 | HTTP (デフォルト:12080、12081、12082、12083) |
・12080:Luxorが受け取ったリクエストをActiveMQに保存したり、ActiveMQからレコードを取得したりするための通信用ポート。 ・12081:ActiveMQ のマスタノードがレプリケーションプロトコルを提供するポート。 ・12082:JMXコネクタが利用するポート。 ・12083:RMI サーバが利用するポート。 12081、12082、12083は、Luxor内部リクエスト通信用のポートとなる。この三つの番号に関しては番号衝突が発生しない限り、変更する必要なし。 ※設定ファイルsetup.confに番号変更のパラメータを用意していない。 |
※1 ZooKeeper
Apache ZooKeeper(アパッチ ズーキーパーと呼ばれ、以下はZooKeeperで表記)はApacheソフトウェア財団のオープンソースプロジェクトで、大規模分散システムでよく利用される、設定情報の集中管理や名前付けなどのサービスを提供するソフトウェアである。Luxor Ver.2.0よりZooKeeperサービスがLuxorモジュールと同梱され、インストール対象となります。
※2 ActiveMQ
Apache ActiveMQ(アパッチ アクティブ エムキューと呼ばれ、以下はActiveMQと表記)は、Apache License 2.0による Java Message Serviceを実装したメッセージ関連のオープンソースのミドルウェアである。Luxor Ver.2.0よりActiveMQサービスがLuxorモジュールと同梱され、インストール対象となります。
Luxorモジュール構成
Ver.2.X.X系のモジュール構成は以下の通りです。
下記では、Luxor Ver.2.4.0モジュール構成を例にしています。各リビジョンに合わせ、読み替えてください。
モジュール名 | luxor.2.4.0.tbz |
---|---|
モジュール構成 | luxor.2.4.0/solrSchemaDAT.tar.gz luxor.2.4.0/solrSchemaJPT.tar.gz luxor.2.4.0/zkcli.sh luxor.2.4.0/log4j.properties luxor.2.4.0/setup.sh luxor.2.4.0/solr.war luxor.2.4.0/luxor-tool/ luxor.2.4.0/luxor-tool/luxortool.sh luxor.2.4.0/luxor-tool/luxortool.jar luxor.2.4.0/luxor-tool/conf.xml |
注意
Luxor Ver.2.0から日本語検索精度向上オプションを追加したため、Ver.2.0以降のモジュール構成も一部変更しています。変更内容は次となります。
(廃棄)solrSchemaV1.tar.gz
(廃棄)solrSchemaV2.tar.gz
(追加)solrSchemaDAT.tar.gz
(追加)solrSchemaJPT.tar.gzsolrSchemaDAT.tar.gzはドリーム・アーツが開発したトークナイザ(DATokenizerFactory:N-gramというトークナイザのカスタマイズ)を利用するモジュールとなります。solrSchemaJPT.tar.gzは形態素解析トークナイズの一種類であるJapaneseTokenizerFactoryを利用するモジュールとなります。
二種類のトークナイザに関しては、「接続関連の設定」の「スキーマの選定」にて記載しています。構築時に利用するスキーマを決めてください。
solrSchemaDAT.tar.gzは、廃棄したsolrSchemaV2.tar.gzと同様にN-gramトークナイザDATokenizerを使用するスキーマであり、solrSchemaV2.tar.gzより進化している分割方式となります。分割結果の違いに関しては、『Luxor_Ver.2.4_運用ガイド』の「検索精度」を参照してください。
各種サーバの設定
インストール作業を実施する前の各種設定を説明します。
前提条件
前提条件は以下の通りです。インストール前に確認してください。
-
webadminというUser/Groupが存在しないことを想定しています。インストール時、UID/GID共に1521で作成します。存在する場合、そのUserでtomcatを起動する設定となります。
-
/etc/init.d/solrTomcatが存在するかしないかを確認してください。存在する場合、既にLuxorサービスが起動したり、同名のサービスが存在したりすることが想定されます。Solr用Tomcatサービスが起動していないことを前提にしてください。
-
以下のファイル/ディレクトリが存在すると、インストールスクリプト実行時にエラーになります。存在する場合は事前に削除または退避してください。
/etc/init.d/solrTomcat
/etc/profile.d/solrTomcat.sh
/var/luxor
/var/log/luxor -
ポートは通信可能な状態にしておいてください。またポートが既に使われているかどうかを確認してください。既に使われている場合、ポート番号をsetup.confで変更してください。ポート情報の詳細については、「表 各サーバ間のプロトコル(デフォルトポート)」を参照してください。
例:10080のポートが存在するかどうかを確認するのは下記のコマンドを実行してください。実行結果がある場合、既に使用済みを意味します。
# netstat -anotulp | grep 10080
-
NFSでマウントしたディレクトリ上にインストールする場合は、本章の「LuxorのインデックスをNFS上に保存する方法」を参照してください。
接続関連の設定
INSUITE® AP・管理サーバまたはSm@rtDB APサーバとLuxorサーバ間のリクエスト送信に必要な接続設定を説明します。
Luxorサーバの設定
Luxorの設定ファイルsetup.confについては、次のまとめを参照してください。
※Ver.2.4.0の場合のパスを例にしています。各リビジョンに合わせ、読み替えてください。
■ setup.confのパス
/root/luxor.2.4.0/setup.conf
※Luxorの設定ファイルsetup.confを変更する際、INSUITE®(V3.4.1以降)とSm@rtDBのサービス停止は不要です。LuxorのTomcatサービスが停止していても、インデックス作成リクエストはINSUITE®とSm@rtDBのキューに保持され、LuxorのTomcatサービス起動後にキュー情報からインデックスの作成を再開します。
Ver.3.4.1より前のINSUITE®ではキューを持たないため、インデックスの不整合を起こせないように事前にINSUITE®のサービスも停止が必要です。詳細については、「Luxorの設定ファイル変更」の記載を参照してください。
表 setup.confファイルの主な設定
パラメータ | 説明 |
---|---|
schemaISEVer | INSUITE®のスキーマのバージョン設定。 DAT:DATokenizerFactoryトークナイザを使用するスキーマを利用。 JPT:JapaneseTokenizerFactoryトークナイザを使用するスキーマを利用。 (Luxor Ver.2.0以降に追加) schemaSDBVerと同じ設定をしてください。 |
schemaSDBVer | Sm@rtDBのスキーマのバージョン設定。 DAT:DATokenizerFactoryトークナイザを使用するスキーマを利用。 JPT:JapaneseTokenizerFactoryトークナイザを使用するスキーマを利用。 (Luxor Ver.2.0以降に追加) schemaISEVerと同じ設定をしてください。 |
addAllowIps | Luxorサーバへ送信する検索リクエストを許可する各APサーバのIPアドレスを指定するパラメータ。複数設定可。INSUITE® AP・管理サーバ/Sm@rtDB APサーバ/Luxorサーバ(複数台構成の場合)のIPアドレスを全て指定してください。※ 複数IPアドレスの場合、カンマ区切り、スペースは入れないでください。 ネットワークセグメント単位での指定可能。例:addAllowIps="10.2.0.0/16"。 |
addBasicIps | Luxor管理端末からLuxorサーバへ送信するリクエストを許可するIPアドレスを指定するパラメータ。複数設定可。Luxor管理端末のIPアドレスを指定してください。※複数IPアドレスの場合、カンマ区切り、スペースは入れないでください。 ネットワークセグメント単位での指定可能。例:addBasicIps="10.2.0.0/16" |
iseUrl | 閲覧権限をチェックするリクエストの送信先を指定するINSUITE®用パラメータ。一台構成(INSUITE®サーバ)の場合、INSUITE® APサーバのIPアドレスかFQDNを指定。複数台構成(INSUITE®サーバ)の場合、LBのIPアドレスかFQDNを指定してください。 ※INSUITE®管理サーバは指定できない。 |
sdbUrl | 閲覧権限をチェックするリクエストの送信先を指定するSm@rtDB用パラメータ。一台構成(Sm@rtDBサーバ)の場合、Sm@rtDB APサーバのIPアドレスかFQDNを指定。複数台構成(Sm@rtDBサーバ)の場合、LBのIPアドレスかFQDNを指定してください。 |
maxHostConnections | 閲覧権限をチェックするリクエストにおけるINSUITE® APサーバとSm@rtDB APサーバホスト(iseUrl、sdbUrlの設定値)ごとの最大同時接続数。 |
maxTotalConnections | 閲覧権限をチェックするリクエストにおけるINSUITE® APサーバとSm@rtDB APサーバ全ホスト合計の最大同時接続数。 |
localhostAddress | 該当LuxorサーバのIPアドレスを設定してください。 |
replicas | Luxorサーバの台数。 1、3、5などの奇数を設定してください。単体構成の場合は1を設定してください。SolrCloudを利用する複数台構成で構築する場合、3以上の奇数を設定してください。 |
zkClientPort | ZooKeeperが対外通信する(即ち、ZooKeeperのクライアント側がZooKeeperへの内部リクエストを行う)ためのポート。 |
zkHost | ZooKeeperサーバのIPアドレスを設定。ポート番号を含めて設定してください。複数IPアドレスを設定する場合、カンマ区切りで、スペースを含めないでください。 例:10.2.2.10:11080,10.2.2.11:11080,10.2.2.12:11080 。 |
zkMyID | Luxorサーバの番号を設定。単台(Luxorサーバ)の場合、Luxorサーバが一つしかないため、"1"に設定してください。複数台(Luxorサーバ)の場合、Luxorサーバの番号を正整数で順番的に設定してください。 例:3台構成の場合、Luxorサーバの構築時の"zkMyId"をそれぞれ1、2、3で設定。 |
amqPort | Luxorが受け取ったリクエストをActiveMQに保存したり、ActiveMQからレコードを取得したりするための通信用ポート。 |
amqAddress | ActiveMQサービスのIPアドレスを設定する。ポート番号を含めて設定してください。複数IPアドレスを設定する場合、カンマ区切りで、スペースを含めないでください。 例:10.2.2.10:12080,10.2.2.11:12080,10.2.2.12:12080 。 |
suggesterBuildTime | (Luxor Ver.2.2.0で追加)検索オートコンプリート機能を利用するために、検索履歴情報がインデックスとして保存されています。検索履歴を有効にするため、ビルド処理が必要です。リアルタイムでビルドすることはサーバリソースが消費されるため、夜間の時間帯を利用し、ビルド処理をすることをお勧めです。 設定フォーマット: HH:mm:ss 初期値: 02:00:00 |
その他、setup.confで指定可能なパラメータは以下の通りです。必要に応じて指定してください。
表 setup.confファイル全ての設定情報
項目名 | 必須 | 初期値 | 追加バージョン | 説明 |
---|---|---|---|---|
UserName | ○ | webadmin | - | Tomcat起動User名 |
UserId | ○ | 1521 | - | Tomcat起動UserのId。Userが存在しない場合に作成する際のUserIDを指定する。 |
GroupName | ○ | webadmin | - | Tomcat起動Userの所属Group名 |
GroupId | ○ | 1521 | - | Tomcat起動Userの所属GroupID。Groupが存在しない場合に作成する際のGroup IDを指定 |
tomcatInstallDir | ○ | /usr/local/luxor/tomcat | - | LuxorサーバにインストールされたTomcatのフルパスを設定してください |
tomcatMediaFile | ○ | apache-tomcat-8.5.38.tar.gz | - | 本設定項目はVer.2.4.0より廃止します |
tomcatInitFile | ○ | /etc/init.d/solrTomcat | - | Tomcat起動File |
javaMediaFile | ○ | jre-8u172-linux-x64.tar.gz | - | 本設定項目はVer.2.2.0より廃止します |
javaDir | ○ | jre1.8.0_172 | - | 本設定項目はVer.2.2.0より廃止します |
javaInstallDir | ○ | なし | - | LuxorサーバにインストールされたJavaのフルパスを設定してください |
solrPort | ○ | 10080 | - | Tomcatが検索等のリクエストを受け付けるポート |
tomcatShutdownPort | ○ | 18005 | - | Tomcatが停止リクエストを受け付けるポート |
solrDataDir | ○ | /var | - | Solrのデータを保存するディレクトリ。指定ディレクトリ配下に「luxor」を作成するため、「/var/luxor」ディレクトリの場合、「/var」と指定する。 |
solrLogDir | ○ | /var/log/luxor | - | 本設定項目はVer.2.2.0より無効します、ログファイル保存ディレクトリを変更する場合、log4j.xmlが修正必要 |
solrWarFile | ○ | solr.war | - | SolrのWar File名 |
addAllowIps | - | Solrへのアクセスを無条件で許可するIP。INSUITE® AP/管理サーバ、Sm@rtDB APサーバ/Luxorサーバ(複数台構成の場合)のIPアドレスを指定。複数指定可 複数記述する場合はカンマ区切り。スペースは入れないでください。 127.0.0.1は無条件で許可される。ネットワークセグメント単位での指定可能。例:addAllowIps="10.2.0.0/16" 。 |
||
addBasicIps | ○ | - | SolrへのアクセスをBASIC認証で許可するIP。Luxor管理端末のIPアドレスを指定。複数指定可 複数記述する場合は、カンマ区切り。スペースは入れないでください。ネットワークセグメント単位での指定可能。例:addBasicIps="10.2.0.0/16" 。 |
|
iseUrl | △ | http://localhost/ | - | 閲覧権限をチェックするリクエストの送信先を指定するINSUITE®用パラメータ。 一台構成(INSUITE®サーバ)の場合、INSUITE® APサーバのIPアドレスかFQDNを指定。複数台構成(INSUITE®サーバ)の場合、LBのIPアドレスかFQDNを指定してください。 ※INSUITE®管理サーバは指定できません。 △INSUITE®にてLuxor検索エンジンを使用する場合は必須。 |
sdbUrl | △ | http://localhost/hibiki | - | 閲覧権限をチェックするリクエストの送信先を指定するSm@rtDB用パラメータ。 一台構成(Sm@rtDBサーバ)の場合、Sm@rtDB APサーバのIPアドレスかFQDNを指定。複数台構成(Sm@rtDBサーバ)の場合、LBサーバのIPアドレスかFQDNを指定してください。 △Sm@rtDBにてLuxor検索エンジンを使用する場合は必須。 |
localhostAddress | ◯ | 127.0.0.1 | - | 該当LuxorサーバのIPアドレスを設定してください。 |
watchInterval | 5 | - | log4j.xmlファイルの更新を監視する、監視間隔を設定。(単位:秒) | |
replicas | ◯ | 1 | 2.0.0 | Luxorサーバの台数 1、3、5などの奇数を設定してください。単体構成の場合は1を設定してください。SolrCloudを利用する複数台構成で構築する場合、3以上の奇数を設定してください。 |
zkClientPort | ◯ | 11080 | 2.0.0 | ZooKeeperが対外通信する(即ち、ZooKeeperのクライアント側がZooKeeperへの内部リクエストを行う)ためのポート。 |
zkHost | ◯ | 127.0.0.1:11080 | 2.0.0 | ZooKeeperサーバのIPアドレスを設定する。ポート番号を含めて設定してください。複数IPアドレスを設定する場合、カンマ区切りで、スペースを含めないでください。 例:10.2.2.10:11080,10.2.2.11:11080,10.2.2.12:11080。 |
zkDataDir | ◯ | /var/luxor/zookeeper/data | 2.0.0 | ZooKeeperサーバがデータを保存するディレクトリ。必要に応じて、設定変更を行ってください。 |
zkDataLogDir | ◯ | /var/luxor/zookeeper/log | 2.0.0 | ZooKeeperサーバのログファイルを保存するディレクトリ。必要に応じて、設定変更を行ってください。 |
zkMyID | ◯ | 1 | 2.0.0 | Luxorサーバの番号を設定。単体構成の場合、"1"を設定してください。数台構成の場合、Luxorサーバの番号を1から順番に設定してください。 例:3台構成の場合、Luxorサーバの構築時のzkMyIdをそれぞれ1、2、3で設定。 |
amqPort | ◯ | 12080 | 2.0.0 | Luxorが受け取ったリクエストをActiveMQに保存したり、ActiveMQからレコードを取得したりするための通信用ポート |
amqAddress | ◯ | 127.0.0.1:12080 | 2.0.0 | ActiveMQサービスのIPアドレスを設定する。ポート番号を含めて設定してください。複数IPアドレスを設定する場合、カンマ区切りで、スペースを含めないでください。 例:10.2.2.10:12080,10.2.2.11:12080,10.2.2.12:12080 |
maxPostSize | 42991616 | - | Tomcatが受信するPostサイズの上限を設定する。byteで指定。指定しない場合: 2MB | |
javaHeapOpt | -Xms512m -Xmx1024m | - | java heap size Option等を指定するパラメータ。XmsはLuxorが使用するメモリの最小値を指し、Xmxは最大値を指す。Xmxの値を物理メモリの1/3~1/2に設定することを推奨。 | |
softCommitInterval | 5 | - | SolrのSoftCommit間隔(秒数)。インデックスへの更新発生後コミットするまでの秒数を指定 この間発生した更新はまとめてコミットされる。値が大きいとコミット処理によるサーバ負荷を軽減できるが、更新が検索結果に反映されるまでに時間を要してしまう。 |
|
optimizeInterval | 7200 | - | SolrのOptimize間隔(秒数)。インデックスへの更新発生後、オプティマイズを実施するまでの秒数を指定 値が大きいと、オプティマイズによるサーバ負荷を軽減できる。 オプティマイズしないままでは、検索パフォーマンスが劣化する。 Ver.2.1から初期値修正。以前は1800s。 |
|
luxorUserPass | ○ | luxor:dreamarts | - | Tomcat Basic認証で設定するID:Password。SolrのAdmin画面にログインする場合の認証に利用する。 |
iseApacheUser | △ | luxor | - | INSUITE® Apache Basic認証に設定されているUser名。削除は手動で行う必要がある ※INSUITE®にてLuxor検索エンジンを使用し、Basic認証を利用する場合は必須。 |
iseApachePass | △ | dreamarts | - | INSUITE® Apache Basic認証に設定されているPassowrd。削除は手動で行う必要がある ※ INSUITE®にてLuxor検索エンジンを使用し、Basic認証を利用する場合は必須。 |
luxorQRsCache | 1024 | - | 1以上の整数。単位はMB。検索に該当したドキュメントのIDをキャッシュするサイズの上限値。※最適な設定を算出するのは難しいため、現状は初期値での運用を推奨。 | |
luxorDocCache | 1024 | - | luxorDocCache はドキュメントIDの先にあるLuceneのドキュメントオブジェクトをキャッシュします。1以上の整数。単位はMB。検索に該当したドキュメントの内容をキャッシュするサイズの上限値。※最適な設定を算出するのは難しいため、現状は初期値での運用を推奨。 | |
maxHostConnections | 64 | - | APサーバ接続先(iseUrl、sdbUrlの設定値)ごとの最大同時接続数 Luxorは検索結果を出力した後、各データの閲覧権限をINSUITE® AP及びSm@rtDB APサーバにリクエストする。同時に多数のユーザが検索を行った場合に本設定を超えた接続リクエストがAPサーバに送られないように制限する。 設定値は、ご利用環境のAPサーバが通常どの程度接続数に余裕があるかを考慮して決定してください。 設定値は、ご利用環境のAPサーバが通常どの程度接続数に余裕があるかを考慮して決定してください。 APサーバ接続先(iseUrl、sdbUrlの設定値)が同一だった場合、maxTotalConnectionsと本設定の小さい方が採用されます。 |
|
maxTotalConnections | 256 | 1.1.0 | APサーバ全ホスト(IPアドレスかFQDN)への最大同時接続数 maxHostConnectionsと同様だが、INSUITE® AP及びSm@rtDB APサーバへの合計の最大接続数を制限する。 APサーバ接続先(iseUrl、sdbUrlの設定値)が同一だった場合、maxHostConnectionsと本設定の小さい方が採用されます。 |
|
maxSearchRow | 1000 | - | 検索該当総数の上限値。設定可能値:1~2147483647。上限値は各機能(INSUITE®及びSm@rtDB)の合算となる点はご注意ください。 例えば、1000に設定する際、検索対象が1コアの場合は、1000件を上限として検索する。3コアの場合は、それぞれのコアに対して333件、333件、334件を上限として検索する。 この上限値を超えると、以下のメッセージが表示される 「全文検索の結果が上限を超えたため、一部しか表示されていない可能性があります。」 本設定に応じて、INSUITE®またはSm@rtDB APサーバおよびLuxorサーバのメモリ使用量が増加するため、実際の数値設定は利用シーンに合わせて設定してください。 |
|
permitRows | なし | 1.3.0 | 検索結果のうち権限チェックをする対象の上限値。設定可能値:1~maxSearchRowの値 Luxorサーバの性能を考慮する場合、maxSearchRowの設定値より小さい値を設定してください。上限値を超えると、以下のメッセージが表示される。 「全文検索の結果が上限を超えたため、一部しか表示されていない可能性があります。」 Luxorは1回の検索に対し、INSUITE®(またはSm@rtDB)のAPサーバに1回の権限チェックリクエストを送る。permitRowsはLuxorからINSUITE®(またはSm@rtDB)へ渡すリクエストの上限値を設定する。上限値permitRowsは各機能(INSUITE®及びSm@rtDB)の合算となる点はご注意ください。 例えば、permitRowsを"1000"に設定する際、検索対象が1コアの場合は、1000件を上限として検索する。3コアの場合は、それぞれのコアに対して333件、333件、334件を上限として検索する。 |
|
maxAccess | なし | 1.3.0 | 検索の同時アクセス数の上限値。設定可能値:1~10000。未設定時は制限なし。 アクセス数を超えると、以下のメッセージが画面に表示される 「全文検索の同時アクセス上限を超えました。暫く待ってから、再検索してください。」 |
|
fileDownload ReadTimeout |
300 | 1.2.1 | 添付ファイルのインデックス作成時、INSUITE®、Sm@rtDBのAPサーバからコンテンツを読み込む際のタイムアウト設定(単位秒)。 | |
fileDownload ConnectTimeout |
300 | 1.2.1 | LuxorサーバからINSUITE®、Sm@rtDB APサーバへリクエストし、接続するまでのタイムアウトの設定(単位:秒)。 | |
schemaISEVer | ◯ | DAT | 2.0.0 | INSUITE®のスキーマのバージョン設定。 DAT:DATokenizerFactoryトークナイザを使用するスキーマを利用 JPT:JapaneseTokenizerFactoryトークナイザを使用するスキーマを利用 schemaSDBVerと同じ設定をしてください。 |
schemaSDBVer | ◯ | DAT | 2.0.0 | Sm@rtDBのスキーマのバージョン設定。 DAT:DATokenizerFactoryトークナイザを使用するスキーマを利用。 JPT:JapaneseTokenizerFactoryトークナイザを使用するスキーマを利用。 schemaISEVerと同じ設定をしてください。 |
maxRetriesOn NoHttpResponseException |
1 | 1.3.6 | 1以上の整数 LuxorからSolrへの問い合わせ時にNoHttpResponseExceptionが発生した際のretry数を設定。 設定値が大きくなると、性能劣化の恐れがある。 |
|
retriesDelayOn NoHttpResponseException |
500 | 1.3.6 | 1以上の整数。単位はミリ秒(ms)、maxRetriesOnNoHttpResponseExceptionに設定したretryを実施する場合の時間間隔。この時間間隔は2回目以降は倍々に増加する。 | |
tomcatStopMaxWait | 300(秒) | - | Solr用のTomcatを手動停止する際、設定値が過ぎた場合、強制終了させる設定。 | |
logMaxBackupDays | 0(単位:日) | 1.3.8 | 日時によりログファイルの分割を行うDailyRollingFileAppenderに対し、ログ保存期間を超えたLuxorのsolr.logとluxor.logを削除するログローテート設定。デフォルト値は0。設定値が0の場合、ログローテートは行われない。0以上の整数値を設定。 ※ログローテート対象は、現時点でのlog4j.xmlのDatePatternにより生成されたログのみとする。DatePatternが変更された場合、変更前のDatePatternにより生成されたログファイルはローテート対象外となり処理しないため、ご注意ください。 ※ logMaxBackupDays変更時、setup.confの設定反映とSolr用のTomcat再起動が必要。 |
|
updateThreadNum | 1 | 2.1.0 | インデックス作成処理のスレッド数。1~4に設定可能。※ CPU内核数の前提で2~4に変更することが推奨。 インデックス作成処理では、スレッド数に比例するメモリ消費量が発生する。サーバのメモリを確保した上、マルチスレッドに変更してください。 |
|
downloadTextSize | 1MB | 2.1.0 | 添付ファイルのインデックシング上限サイズ。 0からの正整数を設定してください。単位はMB。 ※ デフォルト1MBの場合、概ね30万以上の文字数と相当するサイズとなり、以前の10,000語制限よりインデクシング対象範囲が拡大されます。 設定値が0の場合、添付ファイルのインデックシング処理をせず、添付ファイル以外のデータ本体のみインデックシングする。 設定値が空きの場合、デフォルト値と同様。 負数に設定する場合、無制限にすべてインデックシング対象とする。 |
|
authCheckTimeout | 290 | 2.1.1 | LuxorからINSUITEやSm@rtDBへの接続異常や製品APサーバ高負荷による権限チェックのレスポンスが長時間でLuxorに戻らない時、権限チェック処理がタイムアウトすると中止する仕組み。単位: 秒(s) | |
profLogLimitTime | 0 | 2.1.1 | 検索処理時間がprofLogLimitTimeの値をより長い場合、infoレベルのログとして時間の詳細を出力する。デフォルト0の場合、該当ログを出力しない。単位: 秒(s) | |
suggesterBuildTime | 02:00:00 | 2.2.0 | 検索オートコンプリート機能はインデックスとして保存された検索履歴情報を利用しています。検索履歴の有効はビルド処理が必要です。リアルタイムでビルドすることはサーバリソースが消費されるため、夜間の時間帯にビルド処理を行うことはお薦めです。 設定フォーマット: HH:mm:ss 初期値: 02:00:00 |
|
useBlockPermitFilterCondition | false | 2.3.0 | 「文書レイアウトブロック権限制御の閲覧可能条件」が設定されるときに、権限制御するかしないかのオプション。 false: 権限制御しない true: 権限制御する 権限制御と検索パフォーマンスがトレードオフ関係、検索パフォーマンスを優先する場合、シンプル且つ妥当な権限制御を設計することを推奨する。 |
INSUITE® APサーバの設定
INSUITE® APサーバの設定は次の二つがあります。
domain.dat(Luxorサーバへの接続情報を設定)
conf_search_luxor.dat(Luxorの各種設定を保持するファイル)
ここでは、domain.datとconf_search_luxor.datファイル内のLuxor関連パラメータのみをまとめています。他のパラメータについては、『INSUITE®アプリケーション・アドミニストレーション・ガイド』を参照してください。
表 INSUITE®からLuxorへの接続設定(/home/DreamArts/data/system/domain.dat)
パラメータ | 初期値 | 説明 |
---|---|---|
luxor_domain | なし | Luxorサーバへ送信する検索リクエストの送信先を指定するパラメータ ・INSUITE® AP・管理サーバからアクセス可能なLuxorサーバのドメイン名かIPアドレスを指定してください。(ドメイン名はINSUITE®サーバ上にて使える状態にしておく必要がある。) 複数指定はできない。Luxorサーバが複数台構成の場合、ロードバランサで設定したLuxorサーバのドメイン名かIPアドレスを指定してください。 |
luxor_port | なし | Luxorサーバへ送信する検索リクエストの送信先のポートを指定するパラメータ ・Luxorサーバがリクエストを受け付けるポート番号を指定してください。 |
luxor_rdir | /solr | Luxorサーバへ送信する検索リクエストの送信先のディレクトリを指定するパラメータ ・Luxorサーバにて、検索リクエストを受け付けるディレクトリ。 通常変更する必要はなし。 |
luxor_allow_ip | なし | 閲覧権限をチェックするリクエストの送信先を許可するIPアドレスを指定するパラメータ INSUITE® APから見た場合のLuxorサーバのIPアドレスを指定してください。(カンマ区切りで複数可) ※Luxorインストール時の設定ファイルsetup.confのiseUrlに"localhost"を指定する場合、luxor_allow_ipには"127.0.0.1"を指定してください。 ※必ずIPアドレスを指定してください。ドメイン名は無効 ※ Luxorインストール時setup.confのiseUrlにロードバランサーIPを設定する場合は、INSUITE®からみたロードバランサーの仮想IPを指定してください。 |
※ domain.datのパラメータと値の記載方法は"PARAM=VALUE"または"PARAM[TABキー]VALUE"です。スペースは含まないでください。
luxor_allow_ip=xxx.xxx.xxx.xxx
luxor_allow_ip[TAB]xxx.xxx.xxx.xxx
下記は設定例:
# vi /home/DreamArts/data/system/domain.dat
--------------
luxor_allow_ip=10.1.1.1
luxor_domain=10.1.1.1
luxor_port=10080
luxor_rdir=/solr
--------------
表 Luxorのインストールに関連する設定(/home/DreamArts/data/custom/conf_search_luxor.dat)
パラメータ | 初期値 | 説明 |
---|---|---|
engine | luxor | 検索エンジンの指定。※ V3.4.0インストーラーを使用した場合、Luxorとして固定されているため、conf_search_luxor.datの検索エンジンの設定に"namazu"が設定されてもLuxorを使用する。 |
lib_folder_path | 1 | 統合検索のフォルダパスを表示するオプション。 1:フォルダパスを表示する(デフォルト)。 0:表示しない。 |
basic_auth | on | Luxorサーバとの通信時にBasic認証を使用する。 on:Basic認証ON(デフォルトはON)。※推奨設定 off:Basic認証OFF。 |
auth_user | luxor | Luxorサーバとの通信時にBasic認証を使用する場合のユーザ名。 |
auth_pass | dreamarts | Luxorサーバとの通信時にBasic認証を使用する場合のパスワード。 |
Sm@rtDB APサーバの設定
Sm@rtDB APサーバの設定は次の二つがあります。
hibiki.xml(Sm@rtDBのAPサーバから見た場合のLuxorサーバのIPアドレスを指定)
default.xml(Luxorサーバへの認証情報を設定&検索エンジンの種類指定)
ここでは、hibiki.xmlとdefault.xmlファイル内のLuxor関連パラメータのみをまとめています。他のパラメータについては、『Sm@rtDB_運用ガイド』を参照してください。
表 LuxorサーバとAPサーバ間の接続設定(/etc/hibiki/hibiki.xml)
パラメータ | 初期値 | 説明 |
---|---|---|
webServiceHosts | なし | 閲覧権限チェックのリクエストを許可するIPアドレスを指定するパラメータ。Sm@rtDBのAPサーバから見た場合のLuxorサーバのIPアドレスを指定してください。 複数指定可能。Luxorが複数台構成の場合、すべてのLuxorサーバIPアドレスを設定してください。 |
LuxorサーバIPアドレスが10.2.2.147である場合の追加例:
# vi /etc/hibiki/hibiki.xml
<system>
<!--
ひびきアプリケーションのアクセスURLルートメールなどによるURL通知のために使用される。
-->
<property name="contextUrl" value="http://10.2.2.144/hibiki/"/>
<property name="webServiceHosts" value="10.2.2.147,10.2.2.0/24,localhost,127.0.0.1"/>
</system>
全文検索エンジンにLuxorを使用する場合は、default.xmlにて以下の指定が必要になります。
Luxorサーバへの認証情報を設定&検索エンジンの種類指定
検索エンジンの種類指定
設定ファイル名:/etc/hibiki/default.xml
親要素:default-values.system.fullTextSearch
表 検索エンジンの種類設定
要素名称 | 初期値 | 説明 |
---|---|---|
service | luxor | 検索エンジンの種類を設定する [luxor]タグは、この設定を"luxor"に設定時に有効 。 |
Luxorサーバへの認証情報を設定
設定ファイル名:/etc/hibiki/default.xml
親要素:default-values.system.fullTextSearch.luxor.server
表 LuxorサーバとSm@rtDBサーバ間の接続設定
要素名称 | 初期値 | 説明 |
---|---|---|
contextUrl | - | LuxorサーバのURLを設定する。APサーバからLuxorサーバへの認証時に使用。 サーバ複数台構成の場合、ロードバランサで設定したLuxorサーバを指定してください。 |
auth.username | luxor | 認証用のユーザIDを設定する。 |
auth.password | dreamarts | 認証用のパスワードを設定する。 |