This website uses cookies

We use limited tracking features to help improve our site. We also share information about site usage with our advertising and analytics partners, who may combine it with other information that you’ve provided to them or that they’ve collected from your use of their services. By continuing to use our site, you are consenting to our use of cookies. For more information, please review our privacy policy.
Mugo Web main content.

Installing eZ Find's Solr on CentOS 7

By: Benjamin Kroll | July 16, 2017 | eZ Publish add-ons, eZ Publish development tips, Web solutions, ezfind, solr, and centos

To set up Apache Solr -- the search platform that powers eZ Publish (through the eZ Find extension) and eZ Platform -- as a service on CentOS 7, you have at least two options. We’ll cover both: a manually created service for the new systemd as well as the older SystemV -- via the service script included with eZ Find.

What is systemd?

CentOS 7 features a new way of loading service scripts via systemd, which takes some getting used to for those coming from earlier versions of CentOS.

A very TLDR summary about systemd:
“systemd is an init system used in Linux distributions to bootstrap the user space and manage all subsequent processes, instead of the UNIX System V or Berkeley Software Distribution (BSD) init systems. ... One of systemd's main goals is to unify basic Linux configurations and service behaviors across all distributions.” [1]

A forum post by one of the developers for the ArchLinux distribution about systemd[2] features a more detailed explanation.[3]

systemd service setup

To set up a systemd service we’ll create a new service file.

$ sudo vi /etc/systemd/system/solr.service

[Unit]
Description=Apache SOLR
After=syslog.target network.target remote-fs.target nss-lookup.target

[Service]
WorkingDirectory=/var/www/ezpublish_legacy/extension/ezfind/java
PIDFile=/var/run/solr.pid
User=root
ExecStart=/usr/bin/java -Dezfind -jar start.jar
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/bin/kill -s QUIT $MAINPID
PrivateTmp=true

[Install]
WantedBy=multi-user.target

Starting, restarting, and stopping the service is handled via systemctl.
(Adding .service to the lines below is optional as systemctl will automatically look for it)

$ sudo systemctl start solr.service
$ sudo systemctl restart solr.service
$ sudo systemctl stop solr.service

Since systemctl doesn't give you feedback by default, run a status check to see if the service is working as expected.

$ sudo systemctl status solr.service

If the service is working as expected, the service can be enabled to start at boot.

$ sudo systemctl enable solr.service

Breaking it down

The [Unit] section

The Description setting is used to describe the service as well as its functionality. Being specific here will help to identify the service and its function down the track.
A number of systemd tools display this information.

The After setting defines the units that will be started before this unit. Units listed here are not dependencies. If dependencies are required, use the Requires or Wants settings.

The [Section] section

This section contains the service configuration. A service section should contain a Type setting, which controls how systemd handles this service.

If no Type or BusName setting are supplied, the service type defaults to ‘simple’, which means systemd considers the service to be started immediately. The main process of the service needs to be defined via ExecStart in that case.[4]

  • WorkingDirectory where the service's executable is located
  • PIDFile the service’s process id file location
  • User the user to run the service
  • ExecStart the command to run to start the service
  • ExecReload the command to run to reload the service
  • ExecStop the command to run to stop the service
  • PrivateTmp specifies the use of a private /tmp directory

The [Install] section

WantedBy specifies how the service unit should be enabled. The setting is not used by systemd at runtime, but when the service is enabled or disabled via systemctl.

A symlink is created in /etc/systemd/system/<wanted_by_value>.wants/<symlink_to_unit> creating a dependency so that the current units starts when the listed unit does.[5]

The systemd target multiuser.target is equivalent to the SystemV runlevels 2,3,4 (Set up a non-graphical multi-user system)[6]

SystemV service setup

While loading service scripts via systemd is new to CentOS 7, it still has legacy support for SystemV.

eZ Find includes service scripts for Debian, Gentoo, and RHEL out of the box.
We will use the RHEL script, following the instructions found at the top of the file located in <ezp_root>/extensions/ezfind/bin/scripts/rhel/solr.sh

$ vi <ezp_root>/extensions/ezfind/bin/scripts/rhel/solr.sh
...
# chkconfig: 2345 64 36
# description: SOLR indexing server
# processname: solr
# pidfile: /var/run/solr.pid

DESC="Solr indexing server"
NAME=solr
SOLR_HOME=/var/www/ezpublish_legacy/extension/ezfind/java # Set solr home here
JAVA_HOME= # Set java home here if java is not available in /usr/bin/java or /usr/local/bin/java
...
  1. Set the correct SOLR_HOME value (the java folder of your ezfind extension)
  2. Set the correct JAVA_HOME value
  3. Copy the file to /etc/init.d
  4. Make the service script executable e.g. chmod +x
  5. Run chkconfig --add solr

To check if your service was set up successfully, use chkconfig.

$ sudo chkconfig
...
network 0:off 1:off 2:on 3:on 4:on 5:on 6:off
solr 0:off 1:off 2:on 3:on 4:on 5:on 6:off

You can also check the service status via systemctl.

$ sudo systemctl status solr
...
solr.service - SYSV: SOLR indexing server
Loaded: loaded (/etc/rc.d/init.d/solr; vendor preset: disabled)
Active: active (running) since Mon 2017-02-20 05:10:32 UTC; 2 months 23 days ago
Docs: man:systemd-sysv-generator(8)
Main PID: 3271 (java)
...

To update the service description and name, change the values for DESC and NAME in the service script.
If you update those values, also update the chkconfig settings lines above it.

The first line of the chkconfig settings defines the run-levels and can be left as is.

Note: Also leave the # characters at the beginning of each line in place.

...
# description: SOLR indexing server (MyNameHere)
# processname: solr-mynamehere
# pidfile: /var/run/solr-mynamehere.pid

Links and sources

  1. https://en.wikipedia.org/wiki/Systemd
  2. https://freedesktop.org/wiki/Software/systemd
  3. https://bbs.archlinux.org/viewtopic.php?pid=1149530#p1149530
  4. https://www.digitalocean.com/community/tutorials/understanding-systemd-units-and-unit-files
  5. https://www.freedesktop.org/software/systemd/man/systemd.unit.html#id-1.9
  6. https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/System_Administrators_Guide/sect-Managing_Services_with_systemd-Targets.html

Related Blog Posts

solr
eZ Publish add-ons, eZ Publish development tips, Web solutions, ezfind, search, eZ Find, and Solr

eZ Find: How to return specific fields of indexed data

When working with eZ Find fetches, you may want to return only a specific sub-set of data for each of the search results, rather than the whole content object.

You can do that by using the eZ Find 'search' fetch's 'fields_to_return' parameter.

LEARN MORE
Mugo Web: Solr Frange Queries
Business solutions, eZ Publish add-ons, and User experience

Extending eZ Find: How to specify minimum relevance values using Solr frange queries

eZ Find, the enterprise search extension for eZ Publish and wrapper for the Apache Solr search engine, is a highly performant alternative to manually searching through databases. We recently extended eZ Find to support Solr frange queries, and specifically to support minimum relevance values.

LEARN MORE
Sorting results by date and relevance
eZ Publish development tips and Web solutions

Sorting search results by date-based relevance in eZ Find

The eZ Publish search extension eZ Find offers many sorting parameters for its search results, the most common being by relevance / score, and by date. On large sites, sorting by date can lead to non-relevant results showing up first. What if you want to sort by date and relevance, essentially boosting newer content but still giving you relevant results?

LEARN MORE
combination lock
eZ Publish add-ons, eZ Publish development tips, ezfind, solr, security, iptables, and jetty

Securing eZ Find's Solr installation

When using eZ Publish's eZ Find extension on a public facing site or project -- arguably any project -- it is vital to secure it to prevent unauthorized access and potential data loss. eZ Find is powered by Apache Solr, an open-source search server based on the Lucene Java search library. Its power and flexibility make eZ Find a great tool when working with a lot of content in eZ Publish.

There are a number of ways a Solr installation can be secured. We'll look at BasicAuth via Jetty UserRealms and iptables firewall rules in detail.

LEARN MORE
-
eZ Publish development tips, ezfind, solr, index, plugins, and search

Adding data to the eZ Find index with Index Time Plugins

Index time plugins are one of the most important techniques of extending eZ Find functionality; they allow you to control how and what data is indexed. Combined with custom eZ Find queries, this opens up huge opportunities for providing access to content, well beyond mere 'search'.

In this post we will look at some typical use cases, briefly consider out of the box functionality and then dive into why you would want to make use of index time plugins and how you would go about setting one up.

LEARN MORE


Mugo Web
Unit 205, 332 Columbia Street
New Westminster, BC
V3L 1A6, Canada

Phone: 604-637-6396
E-mail: hi@mugo.ca

SAY HI
Clients
Portfolio Blog About Meet the Team Contact

Site Map

© 2008-2024 Mugo Web. All rights reserved. | Privacy Policy