Solr
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

Solrのインストール

7.2-7.3 (CE、DXP); 7.4 DXP U60+

Solrは、Apache Luceneをベースに開発されたエンタープライズサーチプラットフォームとして人気があります。信頼性、スケーラビリティ、フォールトトレラントに優れています。詳しくは こちらです。

警告

Liferay 7.4では、Solrはメンテナンスモードになっています。

これらの手順では、互換性のあるLiferayバージョンにSolr 8をインストールする方法について説明します。 Solr 7をインストールする場合、必要に応じてバージョン名を調整してください。

重要

Solrを使用する際には、重要な制約事項があります。インストール前にSolrの制限事項をお読みください。

互換性

互換性のあるSolrおよびLiferayのバージョンとパッチレベルごとの詳細については、検索エンジン互換性マトリックスを参照してください。

Solrコネクタをダウンロードしています

警告

ブラックリストとコネクタの設定が完了し、 Solrが稼働するまでは、稼働中のLiferayにSolrコネクタをインストールしないでください。

Solrへのコネクターをまだ取得していない場合、

  1. 実行中の Liferay で、コントロール パネル → マーケットプレイス → ストアに移動します。ログインしてください。

  2. アプリへのアクセス権を付与します。

  3. Solr 8を検索し、Liferayのインストールに対応するアプリを選択します。

    ライフレイフレーバーSolrコネクタ名
    Liferay Portal/コミュニティエディションLiferay CE コネクタから Solr 8 への接続
    Liferay DXPLiferayとSolrのコネクタ8
  4. アプリのランディングページにある「無料」ボタンをクリックしてください。

  5. 既存のプロジェクトがあれば選択し、なければ新規に追加してください。

  6. 条件に同意して「購入」をクリックしてください。

購入後、[Past Versions]ページからLPKGファイルをダウンロードしてください。

  1. 以下のURLのhttps://liferay.com user.nameを置き換えてください。

    CE: https://web.liferay.com/web/[user.name]/apps/-/marketplace_apps/225525277/versions DXP: https://web.liferay.com/web/[user.name]/apps/-/marketplace_apps/182518167/versions

  2. アプリをクリックして、アプリのLPKGファイルをダウンロードしてください。

お使いのLiferayのバージョンとパッチレベルに対応するアプリケーションのバージョンについては、検索エンジンの互換性マトリックスを参照してください。

Elasticsearch専用機能の無効化

Liferay Connector to Solrをインストールする際には、ブラックリストに登録するか、無効にする必要があります。

  • Elasticsearchでのみ動作する特定のDXP機能用のモジュール
  • Liferay Connector to Elasticsearchモジュールの組み合わせ

Elasticsearch専用機能のブラックリスト登録

重要

先に進む前に、Liferayを停止してください。

Elasticsearch専用機能をブラックリスト化するには、

  1. Liferay DXP 7.4 では、ポータルプロパティまたは Docker 環境変数を使用して、すべてのLiferay Enterprise Search機能を無効にします。

    portal-ext.propertiesにこのプロパティを追加してください。

    enterprise.product.enterprise.search.enabled=false
    

    このDocker環境変数を設定してください。

    LIFERAY_ENTERPRISE_PERIOD_PRODUCT_PERIOD_ENTERPRISE_PERIOD_SEARCH_PERIOD_ENABLED=false
    

    詳細については、 「Liferay Enterprise Search の有効化」を参照してください。

  2. ブラックリスト設定ファイルを作成します。名前はLiferayのバージョンによって異なります。

    Liferay 7.4 の場合、作成します

    com.liferay.portal.bundle.blacklist.internal.configuration.BundleBlacklistConfiguration.config
    

    Liferay 7.2 および 7.3 の場合、

    com.liferay.portal.bundle.blacklist.internal.BundleBlacklistConfiguration.config
    
  3. お使いのLiferayのバージョンに応じた設定を入力してください。

    Liferay 7.4:

    blacklistBundleSymbolicNames=[\
       "com.liferay.portal.search.elasticsearch7.api",\
       "com.liferay.portal.search.elasticsearch7.impl",\
       "com.liferay.portal.search.elasticsearch7.spi",\
    ]
    

    この設定により、Elasticsearch 7検索エンジンコネクタのモジュールが無効になります。 enterprise.product.enterprise.search.enabled=falseプロパティは、 Liferay Enterprise Searchモジュールを無効にします。 Solrをインストールすると、互換性のない他の機能が自動的に無効になります。

    Liferay 7.2 および 7.3:

    blacklistBundleSymbolicNames=[\
       "com.liferay.portal.search.elasticsearch7.api",\
       "com.liferay.portal.search.elasticsearch7.impl",\
       "com.liferay.portal.search.elasticsearch7.spi",\
       "com.liferay.portal.search.tuning.rankings.web",\
       "com.liferay.portal.search.tuning.synonyms.web",\
       "com.liferay.portal.search.tuning.web",\
       "com.liferay.portal.search.tuning.web.api"\
    ]
    
  4. ファイルをLiferayのosgi/configsフォルダに配置してください。

Solrのインストールと設定

Liferay用のSolrをインストールし、設定します。

  1. 互換性のあるSolrサーバーをダウンロードして解凍してください。

  2. solr-[version]/server/solrに移動します。

  3. liferayという名前の新しいフォルダを作成し、 liferay/confとliferay/dataという 2 つのサブフォルダを作成します。

  4. configsets/_default/confの内容をliferay/confフォルダにコピーしてください。

  5. Liferay Connector to Solr 8のLPKGファイルをアーカイブマネージャーで開きます。

  6. Liferay Connector to Solr 8 - Impl.lpkgを開きます。

  7. com.liferay.portal.search.solr8.impl.jarファイルを開き、展開します。

    META-INF/resources/solrconfig.xml
    

    そして

    META-INF/resources/schema.xml
    

    に

    liferay/conf
    

    これにより、既存のsolrconfig.xmlファイルとschema.xmlファイルが、Liferayから送られてくるデータのインデックス作成方法をSolrに指示するファイルに置き換えられます。

  8. liferayフォルダ内にcore.propertiesファイルを作成し、以下の設定を追加してください。

    config=solrconfig.xml
    dataDir=data
    name=liferay
    schema=schema.xml
    
  9. チェックポイント: liferayフォルダの構造は以下のようになりました。

    liferay
    ├── conf
    │   ├── lang
    │   │   ├── contractions_ca.txt
    │   │   ├── ....txt
    │   ├── managed-schema
    │   ├── protwords.txt
    │   ├── schema.xml
    │   ├── solrconfig.xml
    │   ├── stopwords.txt
    │   └── synonyms.txt
    ├── core.properties
    └── data
    
  10. Solrサーバーを起動するには、Solrインストールフォルダの最上位フォルダ( solr-[version] )から以下のコマンドを入力してください。

    ./bin/solr start -f
    
  11. Solrサーバーはデフォルトでポート8983で待機します。 http://localhost:8983/solr/#/~coresにアクセスし(ローカルホストとしてlocalhostを使用してテストしている場合)、 liferayコアが利用可能であることを確認してください。

これでSolrがインストールされ、起動しました。次にLiferay用のSolrコネクタをインストールし、設定します。

Solrコネクタのインストールと設定

重要

先に進む前に、Liferayを停止してください。

Solrへのコネクタがインストールされると、Liferay Connector to Solrのデフォルト値がSolr自身のデフォルトと一致するため、デフォルトの構成がテストインストールで機能します。利用可能な設定の完全なリストは、 設定のリファレンス を参照してください。本番環境では、最低限、コネクタの読み取りと書き込みのURLを設定する必要があります。

Liferayのosgi/configsフォルダにデプロイされた設定ファイルを使用して、Solrコネクタのデフォルト設定を編集するのが最も一般的です。

  1. ファイル名

    com.liferay.portal.search.solr8.configuration.SolrConfiguration.config
    
  2. ダウンロードしたSolrコネクタLPKGをLiferayのosgi/marketplaceフォルダにコピーし、その設定ファイルをosgi/configsに配置します。

  3. Liferayを起動します。

  4. LiferayでSolrとの接続を確認してください。グローバルメニューを開き、コントロールパネル→検索に移動して、接続が有効になっていることを確認してください。

    検索管理コンソールでSolrへの接続を確認してください。

  5. LiferayのデータをSolrに再インデックスします。グローバルメニューを開き、コントロールパネル→検索に移動します。インデックス操作ペインで、「検索インデックスの再インデックス」オプションの横にある「実行」をクリックします。

    スペルチェックのインデックスも再インデックスしてください。

SolrCloudによる高可用性

Solrサーバーのクラスターが必要な場合は、SolrCloudを使用します。なお、SolrCloudを実運用で使用するには、 外部のZooKeeperアンサンブルを設定する必要があります。 ZooKeeper は、SolrCloudクラスターのような分散システムを管理するための、集中型のコーディネーションサービスです。

ここで紹介する手順は、SolrCloudをLiferayで構成するために必要な最低限のものです。例えば、この手順では、1台のマシンでのSolrCloud構成について説明します。本番環境では、複数の物理マシンまたは仮想マシンを使用する必要があります。これらの手順は、上記の「Solrのインストールと設定」の手順を既に完了していることを前提としています。詳しくは SolrCloudガイドをご参照ください。

  1. Solrサーバーが実行中の場合は停止してください。

  2. Solrのインストールディレクトリ内のconfigsetsフォルダ( solr-[version]/server/solr/configsets )に移動します。

  3. liferay_configsという名前のフォルダを作成します。

  4. solr-[version]/server/solr/liferayにあるconfフォルダを、先ほど作成したliferay_configsフォルダにコピーしてください。

    configset/liferay_configsフォルダにはSolrCloud Liferayコレクションの設定が含まれており、ZooKeeperにアップロードされます。以前に設定したliferayサーバーからconfフォルダーをコピーすると、Liferay Solr アダプターに付属のschema.xmlとsolrconfig.xmlファイルが使用されます。

  5. SolrCloudクラスターを設定するには、対話型のSolrCloudセッションを起動してください。 Solrのインストールルートから、以下を実行します。

    ./bin/solr -e cloud
    
  6. セットアップウィザードを完了してください。以下の手順は、2ノードのクラスタを作成する方法を示しています。

    • ノード数として2を入力してください。

    • ポート番号8983と7574を指定してください(デフォルト値)。両方のノードは、ログに表示されている起動コマンドで起動されます。

      Starting up Solr on port 8983 using command:
      "bin/solr" start -cloud -p 8983 -s "example/cloud/node1/solr"
      
      Waiting up to 180 seconds to see Solr running on port 8983 [|]  [-]
      Started Solr server on port 8983 (pid=8846). Happy searching!
      
      
      Starting up Solr on port 7574 using command:
      "bin/solr" start -cloud -p 7574 -s "example/cloud/node2/solr" -z localhost:9983
      
      Waiting up to 180 seconds to see Solr running on port 7574 [|]  [/]
      Started Solr server on port 7574 (pid=9026). Happy searching!
      
    • コレクションにliferay という名前を付けます。

    • コレクションを2つの断片に分割します。

    • シャードごとに2つのレプリカを指定してください。

    • 設定を選択するよう求められたら、 liferay_configsと入力します。クラスターが起動すると、以下のようなログメッセージが表示されるはずです。

    SolrCloud example running, please visit http://localhost:8983/solr
    

これで、ローカルのSolrCloudクラスターにliferayという名前の新しいコレクションが作成されました。 status コマンドを実行して、その状態を確認します。

./bin/solr status

ログ出力では、ノードが見つかったことと、各ノードの情報が一覧表示されます。

Found 2 Solr nodes:

Solr process 725273 running on port 8983
{
   "solr_home":"/home/me/_temp/solr-8.11.2/example/cloud/node1/solr",
   "version":"8.11.2 17dee71932c683e345508113523e764c3e4c80fa - mdrob - 2022-06-13 11:27:54",
   "startTime":"2023-01-05T20:29:45.779Z",
   "uptime":"0 days, 0 hours, 1 minutes, 29 seconds",
   "memory":"99.6 MB (%19.4) of 512 MB",
   "cloud":{
      "ZooKeeper":"localhost:9983",
      "liveNodes":"2",
      "collections":"1"}}
...

SolrCloudモードで実行中のSolrを停止するには、次のように stop コマンドを使用します。

./bin/solr stop -all

SolrCloud 用の Solr コネクタを設定する

LiferayでSolrCloudをサポートするには、LiferayのSolrコネクタでクライアントタイプをCLOUDに指定します。

  1. システム設定またはOSGi構成ファイルから、クライアントタイプをCLOUDに設定します。

    clientType="CLOUD"
    
  2. Liferayを起動します。 SolrコネクタLPKGをインストールしてから初めて起動する場合は、ログに記載されている手順に従ってLiferayを再起動してください。

[Solr システム設定]のエントリーから、「Client Type」を「Cloud」に設定します。

Solrコネクタ構成リファレンス

設定ファイルを使用するだけでなく、システム設定を使用してSolr 8の設定を更新することができます。

Liferayの[システム設定]アプリケーションからSolrを設定することは、開発中やテスト中に最も役立ちます。

以下は、デフォルトの設定と、Solrコネクタアプリケーションをインストールしたときに利用可能になる設定(システム設定の検索カテゴリまたは .config ファイルで設定可能)です。これらの設定は、限られた値を受け入れるものです。

設定ファイル: com.liferay.portal.search.solr8.configuration.SolrConfiguration.config \

システム設定項目: Solr 8

authenticationMode=["BASIC" or "CERT"]
clientType=["REPLICATED" or "CLOUD"]
defaultCollection="liferay"
logExceptionsOnly=B"true"
readURL="http://localhost:8983/solr/liferay"
writeURL="http://localhost:8983/solr/liferay"
zkHost="localhost:9983"

設定ファイル: com.liferay.portal.search.solr8.configuration.SolrHttpClientFactoryConfiguration.config \

システム設定エントリ: Solr 8 HTTPクライアントファクトリー

basicAuthPassword="solr"
basicAuthUserName="solr"
defaultMaxConnectionsPerRoute="20"
maxTotalConnections="20"

設定ファイル: com.liferay.portal.search.solr8.configuration.SolrSSLSocketFactoryConfiguration.config \

システム設定項目: Solr 8 SSL Factory

keyStorePassword="secret"
keyStorePath="classpath:/keystore.jks"
keyStoreType="JKS"
trustStorePassword="secret"
trustStorePath="classpath:/truststore.jks"
trustStoreType="JKS"
verifyServerCertificate=B"true"
verifyServerName=B"true"