Import the Elasticsearch PGP Key
We sign all of our packages with the Elasticsearch Signing Key (PGP key
Download and install the public signing key:
Installing from the RPM repository
Create a file called elasticsearch.repo in the /etc/yum.repos.d/ directory for RedHat based distributions, or in the /etc/zypp/repos.d/ directory for OpenSuSE based distributions, containing:
And your repository is ready for use. You can now install Elasticsearch with one of the following commands:
Use yum on CentOS and older Red Hat based distributions.
Use dnf on Fedora and other newer Red Hat distributions.
Use zypper on OpenSUSE based distributions
Download and install the RPM manually
The RPM for Elasticsearch v5.6.3 can be downloaded from the website and installed as follows:
Compare the SHA produced by sha1sum or shasum with the
On systemd-based distributions, the installation scripts will attempt to set kernel parameters (e.g., vm.max_map_count); you can skip this by masking the systemd-sysctl.service unit.
SysV init vs systemd
Elasticsearch is not started automatically after installation. How to start and stop Elasticsearch depends on whether your system uses SysV init or systemd (used by newer distributions). You can tell which is being used by running this command:
Running Elasticsearch with SysV init
Use the chkconfig command to configure Elasticsearch to start automatically when the system boots up:
Elasticsearch can be started and stopped using the service command:
If Elasticsearch fails to start for any reason, it will print the reason for failure to STDOUT. Log files can be found in /var/log/elasticsearch/.
Running Elasticsearch with systemd
To configure Elasticsearch to start automatically when the system boots up, run the following commands:
Elasticsearch can be started and stopped as follows:
These commands provide no feedback as to whether Elasticsearch was started successfully or not. Instead, this information will be written in the log files located in /var/log/elasticsearch/.
By default the Elasticsearch service doesn’t log information in the systemd journal. To enable journalctl logging, the --quiet option must be removed from the ExecStart command line in the elasticsearch.service file.
When systemd logging is enabled, the logging information are available using the journalctl commands:
To tail the journal:
To list journal entries for the elasticsearch service:
To list journal entries for the elasticsearch service starting from a given time:
Check man journalctl or
Checking that Elasticsearch is running
You can test that your Elasticsearch node is running by sending an HTTP request to port 9200 on localhost:
which should give you a response something like this:
Configuring Elasticsearch
Elasticsearch defaults to using /etc/elasticsearch for runtime configuration. The ownership of this directory and all files in this directory are set to root:elasticsearch on package installation and the directory has the setgid flag set so that any files and subdirectories created under /etc/elasticsearch are created with this ownership as well (e.g., if a keystore is created using the
Elasticsearch loads its configuration from the /etc/elasticsearch/elasticsearch.yml file by default. The format of this config file is explained in
The RPM also has a system configuration file (/etc/sysconfig/elasticsearch), which allows you to set the following parameters:
ES_USER
The user to run as, defaults to elasticsearch.
ES_GROUP
The group to run as, defaults to elasticsearch.
JAVA_HOME
Set a custom Java path to be used.
MAX_OPEN_FILES
Maximum number of open files, defaults to 65536.
MAX_LOCKED_MEMORY
Maximum locked memory size. Set to unlimited if you use the bootstrap.memory_lock option in elasticsearch.yml.
MAX_MAP_COUNT
Maximum number of memory map areas a process may have. If you use mmapfs as index store type, make sure this is set to a high value. For more information, check the
LOG_DIR
Log directory, defaults to /var/log/elasticsearch.
DATA_DIR
Data directory, defaults to /var/lib/elasticsearch.
CONF_DIR
Configuration file directory (which needs to include elasticsearch.yml and log4j2.properties files), defaults to /etc/elasticsearch.
ES_JAVA_OPTS
Any additional JVM system properties you may want to apply.
RESTART_ON_UPGRADE
Configure restart on package upgrade, defaults to false. This means you will have to restart your elasticsearch instance after installing a package manually. The reason for this is to ensure, that upgrades in a cluster do not result in a continuous shard reallocation resulting in high network traffic and reducing the response times of your cluster.
Distributions that use systemd require that system resource limits be configured via systemd rather than via the /etc/sysconfig/elasticsearch file. See
Directory layout of RPM
The RPM places config files, logs, and the data directory in the appropriate locations for an RPM-based system:
Type Description Default Location Setting
home
Elasticsearch home directory or $ES_HOME
/usr/share/elasticsearch
bin
Binary scripts including elasticsearch to start a node and elasticsearch-plugin to install plugins
/usr/share/elasticsearch/bin
conf
Configuration files including elasticsearch.yml
/etc/elasticsearch
path.conf
conf
Environment variables including heap size, file descriptors.
/etc/sysconfig/elasticsearch
data
The location of the data files of each index / shard allocated on the node. Can hold multiple locations.
/var/lib/elasticsearch
path.data
logs
Log files location.
/var/log/elasticsearch
path.logs
plugins
Plugin files location. Each plugin will be contained in a subdirectory.
/usr/share/elasticsearch/plugins
repo
Shared file system repository locations. Can hold multiple locations. A file system repository can be placed in to any subdirectory of any directory specified here.
Not configured
path.repo
script
Location of script files.
/etc/elasticsearch/scripts
We sign all of our packages with the Elasticsearch Signing Key (PGP key
You must be registered for see links
, available from
You must be registered for see links
) with fingerprint:
Code:
4609 5ACC 8548 582C 1A26 99A9 D27D 666C D88E 42B4Download and install the public signing key:
Code:
rpm --import https://artifacts.elastic.co/GPG-KEY-elasticsearchInstalling from the RPM repository
You must be registered for see links
Create a file called elasticsearch.repo in the /etc/yum.repos.d/ directory for RedHat based distributions, or in the /etc/zypp/repos.d/ directory for OpenSuSE based distributions, containing:
Code:
[elasticsearch-5.x]
name=Elasticsearch repository for 5.x packages
baseurl=https://artifacts.elastic.co/packages/5.x/yum
gpgcheck=1
gpgkey=https://artifacts.elastic.co/GPG-KEY-elasticsearch
enabled=1
autorefresh=1
type=rpm-mdAnd your repository is ready for use. You can now install Elasticsearch with one of the following commands:
Code:
sudo yum install elasticsearch
sudo dnf install elasticsearch
sudo zypper install elasticsearchUse yum on CentOS and older Red Hat based distributions.
Use dnf on Fedora and other newer Red Hat distributions.
Use zypper on OpenSUSE based distributions
Download and install the RPM manually
You must be registered for see links
The RPM for Elasticsearch v5.6.3 can be downloaded from the website and installed as follows:
Code:
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.6.3.rpm
sha1sum elasticsearch-5.6.3.rpm
sudo rpm --install elasticsearch-5.6.3.rpmCompare the SHA produced by sha1sum or shasum with the
You must be registered for see links
.
You must be registered for see images
On systemd-based distributions, the installation scripts will attempt to set kernel parameters (e.g., vm.max_map_count); you can skip this by masking the systemd-sysctl.service unit.
SysV init vs systemd
You must be registered for see links
Elasticsearch is not started automatically after installation. How to start and stop Elasticsearch depends on whether your system uses SysV init or systemd (used by newer distributions). You can tell which is being used by running this command:
Code:
ps -p 1Running Elasticsearch with SysV init
You must be registered for see links
Use the chkconfig command to configure Elasticsearch to start automatically when the system boots up:
Code:
sudo chkconfig --add elasticsearchElasticsearch can be started and stopped using the service command:
Code:
sudo -i service elasticsearch start
sudo -i service elasticsearch stopIf Elasticsearch fails to start for any reason, it will print the reason for failure to STDOUT. Log files can be found in /var/log/elasticsearch/.
Running Elasticsearch with systemd
You must be registered for see links
To configure Elasticsearch to start automatically when the system boots up, run the following commands:
Code:
sudo /bin/systemctl daemon-reload
sudo /bin/systemctl enable elasticsearch.serviceElasticsearch can be started and stopped as follows:
Code:
sudo systemctl start elasticsearch.service
sudo systemctl stop elasticsearch.service
systemctl status elasticsearchThese commands provide no feedback as to whether Elasticsearch was started successfully or not. Instead, this information will be written in the log files located in /var/log/elasticsearch/.
By default the Elasticsearch service doesn’t log information in the systemd journal. To enable journalctl logging, the --quiet option must be removed from the ExecStart command line in the elasticsearch.service file.
When systemd logging is enabled, the logging information are available using the journalctl commands:
To tail the journal:
Code:
sudo journalctl -fTo list journal entries for the elasticsearch service:
Code:
sudo journalctl --unit elasticsearchTo list journal entries for the elasticsearch service starting from a given time:
Code:
sudo journalctl --unit elasticsearch --since "2016-10-30 18:17:16"Check man journalctl or
You must be registered for see links
for more command line options.Checking that Elasticsearch is running
You must be registered for see links
You can test that your Elasticsearch node is running by sending an HTTP request to port 9200 on localhost:
Code:
GET /which should give you a response something like this:
Code:
{
"name" : "Cp8oag6",
"cluster_name" : "elasticsearch",
"cluster_uuid" : "AT69_T_DTp-1qgIJlatQqA",
"version" : {
"number" : "5.6.3",
"build_hash" : "f27399d",
"build_date" : "2016-03-30T09:51:41.449Z",
"build_snapshot" : false,
"lucene_version" : "6.6.1"
},
"tagline" : "You Know, for Search"
}Configuring Elasticsearch
You must be registered for see links
Elasticsearch defaults to using /etc/elasticsearch for runtime configuration. The ownership of this directory and all files in this directory are set to root:elasticsearch on package installation and the directory has the setgid flag set so that any files and subdirectories created under /etc/elasticsearch are created with this ownership as well (e.g., if a keystore is created using the
You must be registered for see links
). It is expected that this be maintained so that the Elasticsearch process can read the files under this directory via the group permissions.Elasticsearch loads its configuration from the /etc/elasticsearch/elasticsearch.yml file by default. The format of this config file is explained in
You must be registered for see links
.The RPM also has a system configuration file (/etc/sysconfig/elasticsearch), which allows you to set the following parameters:
ES_USER
The user to run as, defaults to elasticsearch.
ES_GROUP
The group to run as, defaults to elasticsearch.
JAVA_HOME
Set a custom Java path to be used.
MAX_OPEN_FILES
Maximum number of open files, defaults to 65536.
MAX_LOCKED_MEMORY
Maximum locked memory size. Set to unlimited if you use the bootstrap.memory_lock option in elasticsearch.yml.
MAX_MAP_COUNT
Maximum number of memory map areas a process may have. If you use mmapfs as index store type, make sure this is set to a high value. For more information, check the
You must be registered for see links
about max_map_count. This is set via sysctl before starting elasticsearch. Defaults to 262144.LOG_DIR
Log directory, defaults to /var/log/elasticsearch.
DATA_DIR
Data directory, defaults to /var/lib/elasticsearch.
CONF_DIR
Configuration file directory (which needs to include elasticsearch.yml and log4j2.properties files), defaults to /etc/elasticsearch.
ES_JAVA_OPTS
Any additional JVM system properties you may want to apply.
RESTART_ON_UPGRADE
Configure restart on package upgrade, defaults to false. This means you will have to restart your elasticsearch instance after installing a package manually. The reason for this is to ensure, that upgrades in a cluster do not result in a continuous shard reallocation resulting in high network traffic and reducing the response times of your cluster.
Distributions that use systemd require that system resource limits be configured via systemd rather than via the /etc/sysconfig/elasticsearch file. See
You must be registered for see links
for more information.Directory layout of RPM
You must be registered for see links
The RPM places config files, logs, and the data directory in the appropriate locations for an RPM-based system:
Type Description Default Location Setting
home
Elasticsearch home directory or $ES_HOME
/usr/share/elasticsearch
bin
Binary scripts including elasticsearch to start a node and elasticsearch-plugin to install plugins
/usr/share/elasticsearch/bin
conf
Configuration files including elasticsearch.yml
/etc/elasticsearch
path.conf
conf
Environment variables including heap size, file descriptors.
/etc/sysconfig/elasticsearch
data
The location of the data files of each index / shard allocated on the node. Can hold multiple locations.
/var/lib/elasticsearch
path.data
logs
Log files location.
/var/log/elasticsearch
path.logs
plugins
Plugin files location. Each plugin will be contained in a subdirectory.
/usr/share/elasticsearch/plugins
repo
Shared file system repository locations. Can hold multiple locations. A file system repository can be placed in to any subdirectory of any directory specified here.
Not configured
path.repo
script
Location of script files.
/etc/elasticsearch/scripts
