- Elasticsearch Guide: other versions:
- Getting Started
- Setup
- Breaking changes
- Breaking changes in 2.0
- Removed features
- Network changes
- Multiple
path.data
striping - Mapping changes
- CRUD and routing changes
- Query DSL changes
- Search changes
- Aggregation changes
- Parent/Child changes
- Scripting changes
- Index API changes
- Snapshot and Restore changes
- Plugin and packaging changes
- Setting changes
- Stats, info, and
cat
changes - Java API changes
- Breaking changes in 2.0
- API Conventions
- Document APIs
- Search APIs
- Aggregations
- Metrics Aggregations
- Bucket Aggregations
- Children Aggregation
- Date Histogram Aggregation
- Date Range Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IPv4 Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Range Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Terms Aggregation
- Pipeline Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Warmers
- Shadow replica indices
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Optimize
- Upgrade
- cat APIs
- Cluster APIs
- Query DSL
- Mapping
- Field datatypes
- Meta-Fields
- Mapping parameters
analyzer
boost
coerce
copy_to
doc_values
dynamic
enabled
fielddata
format
geohash
geohash_precision
geohash_prefix
ignore_above
ignore_malformed
include_in_all
index
index_options
lat_lon
fields
norms
null_value
position_increment_gap
precision_step
properties
search_analyzer
similarity
store
term_vector
- Dynamic Mapping
- Transform
- Analysis
- Analyzers
- Tokenizers
- Token Filters
- Standard Token Filter
- ASCII Folding Token Filter
- Length Token Filter
- Lowercase Token Filter
- Uppercase Token Filter
- NGram Token Filter
- Edge NGram Token Filter
- Porter Stem Token Filter
- Shingle Token Filter
- Stop Token Filter
- Word Delimiter Token Filter
- Stemmer Token Filter
- Stemmer Override Token Filter
- Keyword Marker Token Filter
- Keyword Repeat Token Filter
- KStem Token Filter
- Snowball Token Filter
- Phonetic Token Filter
- Synonym Token Filter
- Compound Word Token Filter
- Reverse Token Filter
- Elision Token Filter
- Truncate Token Filter
- Unique Token Filter
- Pattern Capture Token Filter
- Pattern Replace Token Filter
- Trim Token Filter
- Limit Token Count Token Filter
- Hunspell Token Filter
- Common Grams Token Filter
- Normalization Token Filter
- CJK Width Token Filter
- CJK Bigram Token Filter
- Delimited Payload Token Filter
- Keep Words Token Filter
- Keep Types Token Filter
- Classic Token Filter
- Apostrophe Token Filter
- Character Filters
- ICU Analysis Plugin
- Modules
- Index Modules
- Testing
- Glossary of terms
- Release Notes
WARNING: Version 2.0 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Running as a Service on Linux
editRunning as a Service on Linux
editIn order to run elasticsearch as a service on your operating system, the provided packages try to make it as easy as possible for you to start and stop elasticsearch during reboot and upgrades.
Linux
editCurrently our build automatically creates a debian package and an RPM package, which is available on the download page. The package itself does not have any dependencies, but you have to make sure that you installed a JDK.
Each package features a configuration file, which allows you to set the following parameters
|
The user to run as, defaults to |
|
The group to run as, defaults to |
|
The heap size to start with |
|
The size of the new generation heap |
|
The maximum size of the direct memory |
|
Maximum number of open files, defaults to |
|
Maximum locked memory size. Set to "unlimited" if you use the bootstrap.mlockall option in elasticsearch.yml. You must also set ES_HEAP_SIZE. |
|
Maximum number of memory map areas a process may have. If you use |
|
Log directory, defaults to |
|
Data directory, defaults to |
|
Configuration file directory (which needs to include |
|
Any additional java options you may want to apply. This may be useful, if you need to set the |
|
Configure restart on package upgrade, defaults to |
|
The absolute log file path for creating a garbage collection logfile, which is done by the JVM. Note that this logfile can grow pretty quick and thus is disabled by default. |
Debian/Ubuntu
editThe debian package ships with everything you need as it uses standard debian tools like update update-rc.d
to define the runlevels it runs on. The init script is placed at /etc/init.d/elasticsearch
as you would expect it. The configuration file is placed at /etc/default/elasticsearch
.
The debian package does not start up the service by default. The reason for this is to prevent the instance to accidentally join a cluster, without being configured appropriately. After installing using dpkg -i
you can use the following commands to ensure, that elasticsearch starts when the system is booted and then start up elasticsearch:
sudo update-rc.d elasticsearch defaults 95 10 sudo /etc/init.d/elasticsearch start
Users running Debian 8 or Ubuntu 14 or later may require configuration of systemd instead of update-rc.d
. In those cases, please refer to the Using systemd section.
Installing the oracle JDK
editThe usual recommendation is to run the Oracle JDK with elasticsearch. However Ubuntu and Debian only ship the OpenJDK due to license issues. You can easily install the oracle installer package though. In case you are missing the add-apt-repository
command under Debian GNU/Linux, make sure have at least Debian Jessie and the package python-software-properties
installed
sudo add-apt-repository ppa:webupd8team/java sudo apt-get update sudo apt-get install oracle-java8-installer java -version
The last command should verify a successful installation of the Oracle JDK.
RPM based distributions
editUsing chkconfig
editSome RPM based distributions are using chkconfig
to enable and disable services. The init script is located at /etc/init.d/elasticsearch
, where as the configuration file is placed at /etc/sysconfig/elasticsearch
. Like the debian package the RPM package is not started by default after installation, you have to do this manually by entering the following commands
sudo /sbin/chkconfig --add elasticsearch sudo service elasticsearch start
Using systemd
editDistributions like Debian Jessie, Ubuntu 14, and many of the SUSE derivitives do not use the chkconfig
tool to register services, but rather systemd
and its command /bin/systemctl
to start and stop services (at least in newer versions, otherwise use the chkconfig
commands above). The configuration file is also placed at /etc/sysconfig/elasticsearch
if the system is rpm based and /etc/default/elasticsearch
if it is deb. After installing the RPM, you have to change the systemd configuration and then start up elasticsearch
sudo /bin/systemctl daemon-reload sudo /bin/systemctl enable elasticsearch.service sudo /bin/systemctl start elasticsearch.service
Also note that changing the MAX_MAP_COUNT
setting in /etc/sysconfig/elasticsearch
does not have any effect, you will have to change it in /usr/lib/sysctl.d/elasticsearch.conf
in order to have it applied at startup.
On this page