Liferay Elasticsearch Integration

 

Liferay Elasticsearch Integration

How to Configure Remote Elasticsearch for Liferay DXP



Overview


Liferay DXP 7.4 comes with embedded (sidecar) Elasticsearch 7 out-of-the-box. Using sidecar implementation is not recommended for production servers due to performance and security issues. This article explains how to install and configure a remote Elasticsearch server, and connect it with Liferay 7.4. Also, you’ll find how to visualize your Elasticsearch data using the Kibana tool.


Remote Elasticsearch Configuration


1. Find the required Elasticsearch version


When you start Liferay - you can see two interesting things about Elasticsearch  in logs:

1) A warning, indicating that sidecar Elasticsearch is not recommended to use;

2) An URL where sidecar Elasticsearch is running


Once you hit that URL - you can see the Elasticsearch version you need: 

2. Download Elasticsearch


Download Elasticsearch of the same version as running in Liferay from the official site:

Sample link for version 7.10.2: https://www.elastic.co/downloads/past-releases/elasticsearch-7-10-2


3. Configure Elasticsearch


Unzip the archive, and navigate to the [elasticsearch]/bin folder.

Install the required plugins:


./elasticsearch-plugin install analysis-icu

./elasticsearch-plugin install analysis-kuromoji

./elasticsearch-plugin install analysis-smartcn

./elasticsearch-plugin install analysis-stempel


Modify the [elasticsearch]/config/elasticsearch.yml file, and specify the cluster name:

cluster.name: LiferayElasticSearch



4. Run Elasticsearch


Run from [elasticsearch]/bin folder:


./elasticsearch


Check the logs, make sure Elasticsearch is running at http://127.0.0.1:9200/


5. Configure Elasticsearch in Liferay


Navigate to Control Panel -> Search to check the Elasticsearch connection:

It should be sidecar (default) at this moment.


Navigate to Control Panel -> System Settings -> Search -> Elasticsearch7.

Modify “EMBEDDED” Operation Mode with “REMOTE”, and check the "Production Mode Enabled" checkbox:

Make sure "Network Host Addresses" points to the standalone Elasticsearch URL, and "Cluster Name" is the same as defined in Elasticsearch configuration.


Save the configuration. Check again the Elasticsearch connection, and make sure it points to remote one now:


Switch to “Index Actions” tab, and Re-index the search indexes:


Bonus: Visualize Indexes with Kibana


Kibana is a separate Elastic tool for visualizing and analysis of Elasticsearch data. 


Download the Kibana compatible with Elasticsearch installation (the same version): 

https://www.elastic.co/downloads/past-releases#kibana


Unpack the archive, and run from [kibana]/bin folder:


./kibana


Monitor the logs, and wait until Kibana is started:


Navigate to the URL from logs (http://localhost:5601 by default):

Create Index Pattern using the liferay-[companyId] index:

Save the Index Pattern, navigate to Kibana -> Discover menu and see the Elasticsearch documents:


You can apply different filters and check the data in Elasticsearch matching the specified filters:


Enjoy 😏


Comments

Post a Comment

Popular posts from this blog

Liferay Search Container Example

Or how to implement a custom search container in Liferay Overview   Search Containers are used in Liferay to display the table data. This article shows a simple example of how to implement a custom search container.  Example < liferay-portlet :renderURL varImpl ="iteratorURL" /> < liferay-ui :search-container total =" <%= ProjectLocalServiceUtil. getProjectsCount (scopeGroupId) %> "                              delta ="10"                              emptyResultsMessage ="no-projects-found"                              iteratorURL =" <%= iteratorURL %> " >     < liferay-ui :search-container-results             results =" <%= ProjectLocalServiceUtil. getProjects (scopeGroupId, searchContainer.getStart(), searchContainer.getEnd()) %> " />     < liferay-ui :search-container-row className ="com.sample.sb.model.Project" modelVar ="project" keyP
Read more

Installing Blade CLI from Command Line

Installing Blade CLI from Command Line Download JPM Jar file Download biz.aQute.jpm.run.jar file using link: https://raw.githubusercontent.com/jpm4j/jpm4j.installers/master/dist/biz.aQute.jpm.run.jar Initialize JPM Run command: java -jar biz.aQute.jpm.run.jar init Install Blade Run command: jpm install -f https://releases.liferay.com/tools/blade-cli/latest/blade.jar to install blade. Update blade to make sure you have the latest version, sample:  blade update Current blade version 3.3.0.201811151753 Updating from: https://repository-cdn.liferay.com/nexus/content/repositories/liferay-public-releases/com/liferay/blade/com.liferay.blade.cli//3.8.0/com.liferay.blade.cli-3.8.0.jar Update completed successfully. Congratulations! Now you have Blade CLI installed. Sample command for mvc-portlet: blade create -t mvc-portlet -p com.demo.portlet -c DemoPortlet demo-portlet Enjoy 😏
Read more

Liferay Keycloak integration

Image
Liferay Keycloak integration using OpenID Overview This tutorial explains how to configure OpenID SSO between Liferay 7.2 and Keycloak 7.0.1 Installation instructions KeyCloak Configuration 1. Install and startup Keycloak server Download latest Keycloak server:  https://www.keycloak.org/downloads.html Unzip keycloak-7.0.1.zip folder. Run  keycloak-7.0.1/bin/standalone.sh  (or  keycloak-7.0.1/bin/standalone.bat ) file. Keycloak should be started on 8080 port:  http://localhost:8080 2. Create default admin user: and sign in to Admin Console. 3. Check OpenID configuration Click on "OpenID Endpoint Configuration": JSON configuration should appear, like this: { "issuer": "http://localhost:8080/auth/realms/master", "authorization_endpoint": "http://localhost:8080/auth/realms/master/protocol/openid-connect/auth", "token_endpoint": "http://localhost:8080/auth/realms/master/protocol/openid-con
Read more