How to: Basic Elasticsearch installation. (RHEL/SUSE)

Slavik

XenForo moderator
Staff member
Basic Elasticsearch Installation (RHEL / SUSE)

@Floren has an amazing repo for RHEL 6 and 7, the Elasticsearch RPM he provides is perfectly set up and currently I suggest using it.

The old manual setup guide can be found below.

Step 1) Install the Axivo Repo: https://www.axivo.com/resources/repository-setup.1/

Step 2) Install ElasticSearch: https://www.axivo.com/resources/elasticsearch-setup.11/




This guide is provided to show how to do a basic (vanilla get up and go) install of Elasticsearch (0.90.0 Beta 1), the Elasticsearch Service Wrapper and the required Java Runtime Environment (JRE) (1.7.0_17) on RHEL / SUSE. This guide will not cover running a dedicated Elasticsearch user.

For Debian/Ubuntu users, a guide can be found here.

This guide assumes the user has basic knowledge of SSH and prior to starting the steps below has logged in as root. This guide also assumes the user does not currently have any JRE installed. You can check if you have JRE installed by typing

Code:
java -version

As of writing, the current file locations for JRE are as follows:

32 bit
Code:
http://download.oracle.com/otn-pub/java/jdk/7u17-b02/jre-7u17-linux-i586.rpm

64 bit
Code:
http://download.oracle.com/otn-pub/java/jdk/7u17-b02/jre-7u17-linux-x64.rpm

The guide will be shown using the 64 bit install, however if you are using a 32 bit system, change the file names as appropriate.

Please note, whilst this is a simple and easy setup, I take no responsibility for any damages or losses that may occur to your system by following the steps below. If you are unsure at any stage, please ask for assistance or seek the help of a qualified Linux Systems Administrator.

Installing the JRE
Type the following commands into your SSH terminal.
Code:
cd /tmp
wget http://download.oracle.com/otn-pub/java/jdk/7u17-b02/jre-7u17-linux-x64.rpm
rpm -ivh jre-7u17-linux-x64.rpm
java -version

Assuming everything was done correctly, you should get the following output.

Code:
# java -version
java version "1.7.0_17"
Java(TM) SE Runtime Environment (build 1.7.0_17)
Java HotSpot(TM) 64-Bit Server VM (build 22.0-b10, mixed mode)

Install Elasticsearch

Code:
cd /
curl -L -O -k https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-0.90.0.Beta1.zip
unzip elasticsearch-0.90.0.Beta1.zip
mv elasticsearch-0.90.0.Beta1 elasticsearch

Install the Elasticsearch Service Wrapper

Code:
curl -L -k http://github.com/elasticsearch/elasticsearch-servicewrapper/tarball/master | tar -xz
mv *servicewrapper*/service elasticsearch/bin/
elasticsearch/bin/service/elasticsearch install
ln -s `readlink -f elasticsearch/bin/service/elasticsearch` /usr/local/bin/rcelasticsearch
rcelasticsearch start

Assuming everything was done correctly, you should see the following output.

Code:
rcelasticsearch start
Starting ElasticSearch...
Waiting for ElasticSearch......
running: PID: xxxxx

Basic Configuration

You should do some basic configuration of Elasticsearch before installing the addon in XenForo.


1) Open up /elasticsearch/config/elasticsearch.yml and on line 32 edit

Code:
# cluster.name: elasticsearch

To

Code:
cluster.name: PUT-SOMETHING-UNIQUE-HERE

on line 199 edit

Code:
# network.host: 192.168.0.1

to

Code:
network.host: 127.0.0.1

On line 211 edit

Code:
# http.port: 9200

to

Code:
http.port: 9200

Save and Close


2) Open up /elasticsearch/bin/service/elasticsearch.conf on line 2 edit

Code:
set.default.ES_HEAP_SIZE=1024

To a number suitable for the size of your forum.

I reccomend approximately 1 GB for the HEAP_SIZE per 1 million posts on your forum.

1 Million Posts: 1024
2 Million Posts: 2048
3 Million Posts: 3072
4 Million Posts: 4096
etc

This will not mean the service will use all that available memory, however it will have it at its disposal if required.

So for example a 3 Million Post forum would edit

Code:
set.default.ES_HEAP_SIZE=1024

to

Code:
set.default.ES_HEAP_SIZE=3072



Save and Exit.


3) Optional - Move the Elasticsearch data directory.

Your linux install may be configured in such a way that your install partition is only a few Gb in size, and placing a large Elasticsearch index there is not ideal.

In which case you will want to move the index directory to a different, larger, location (in this example /var/elasticsearch)

Code:
cd /var
mkdir elasticsearch

Open up /elasticsearch/config/elasticsearch.yml on line 143 edit

Code:
# path.data: /path/to/data

to

Code:
path.data: /var/elasticsearch

Save and Exit

4) Restart the Elasticsearch Service

In SSH type

Code:
rcelasticsearch restart

You should get the following output

Code:
rcelasticsearch restart
Stopping ElasticSearch...
Stopped ElasticSearch.
Starting ElasticSearch...
Waiting for ElasticSearch......
running: PID: xxxxx

Elasticsearch is now runing with your updated config.



Install the XenForo Enhanced Search Addon

1) Turn your board off into maintainance mode*

2) Download the addon from your customer area at http://xenforo.com/customers/

3) Follow the instructions found at http://xenforo.com/help/enhanced-search/

4) Wait for your indexes to be rebuilt

5) Open your board.

6) Install the index pre-warmer.

As of 0.90.0 Beta an index pre-warmer is available. This keeps your search index "warm" in active memory so when a search is done, the access time latency is highly reduced.

Installing this is simple, in SSH simply run the following replacing the *INDEX NAME* with the name of your ES index.

Code:
curl -XPUT localhost:9200/*INDEX NAME*/_warmer/warmer_1 -d '{
    "query" : {
        "match_all" : {}
    }
}'

You should have the following returned

Code:
{"ok":true,"acknowledged":true}


*You may leave your board open during the re-index process.

Congratulations. Your board should now be running XenForo Enhanced Search.
 
Last edited:
After all the various version differences between java, ES and methods used to install either and their incompatibilities, it sure would be nice to see an updated step by step centos install guide.. All this trial and error bit is frustrating and I would never recommend installing this on a production server without lots of system admin experience. Especially since a lot of the info is dated.
 
After all the various version differences between java, ES and methods used to install either and their incompatibilities, it sure would be nice to see an updated step by step centos install guide.. All this trial and error bit is frustrating and I would never recommend installing this on a production server without lots of system admin experience. Especially since a lot of the info is dated.

The information itself is all fine, just grab the latest java and ES versions from their respective websites.
 
The information itself is all fine, just grab the latest java and ES versions from their respective websites.
A while back, when I first purchased Enhanced Search, I did just that. I found myself at a time when the latest release of ES was incompatible with the latest version of Java.

Also, Oracle's website was a bit challenging. I chose the wrong type of Java several times because it wasn't clear as to what was needed.

So while I can agree that for the most part, the information is fine, but incomplete. Especially for noobs like myself.
 
I would advice to just go with the setup and with the in the setup mentioned releases. I have the latest releases of both java and elasticsearch and I could not download (wget) java from the shell. The how to was updated to include the index pre-warmer. Guess this is more for the multi-million boards, they have dedicated admins anyway.

The great thing is, if you have a question or a problem, you get an answer usually always within a day, if not even a solution in a few hours.
 
So while I can agree that for the most part, the information is fine, but incomplete. Especially for noobs like myself.

Guess this is more for the multi-million boards, they have dedicated admins anyway.

Exactly,

If your uncomfortable with doing anything outside of following a guide line for line, then you realy should be looking at getting someone else to manage/install your server for you.
 
I agree.. While not impossible to figure out, a dedicated admin would be the ideal for sure. And questions being answered so quickly is certainly a plus. :)
It is! You get the guy having created the how to answering your posts here, this is really a great service. Usually you get an answer within a few hours if not even sooner. It's more of an hobby for me to use the latest releases on a production board, most linux releases always take a long time before implementing newer releases into their packages: there is always a risk about incompatibility. xenforo always wants to have their clients a stable production environment: because that means less service requests. So I would definitely go with the core functionality, so you do not have to worry about the technical stuff and can concentrate more on your community.
 
How can I autostart elasticsearch after boot?

# chkconfig /usr/local/bin/rcelasticsearch on
error reading information on service /usr/local/bin/rcelasticsearch: No such file or directory

# pwd
/usr/local/bin
# ls rc*
rcelasticsearch
 
How can I autostart elasticsearch after boot?

# chkconfig /usr/local/bin/rcelasticsearch on
error reading information on service /usr/local/bin/rcelasticsearch: No such file or directory

# pwd
/usr/local/bin
# ls rc*
rcelasticsearch

chkconfig --add rcelasticsearch
chkconfig rcelasticsearch on
 
I get this on centos 6.5:

# chkconfig --add /usr/local/bin/rcelasticsearch
error reading information on service rcelasticsearch: No such file or directory
# chkconfig --add rcelasticsearch
error reading information on service rcelasticsearch: No such file or directory
 
@Slavik, I'm looking at Elastic as we speak.
I'm confused with the warmer part. I looked at the elasticsearch.yml file and I don't see anywhere mentioned the index name?
Rich (BB code):
curl -XPUT localhost:9200/*INDEX NAME*/_warmer/warmer_1 -d '{
    "query" : {
        "match_all" : {}
    }
}'
Thanks for your clarification.
 
Top Bottom