Free and Open, Distributed, RESTful Search Engine
Find a file
Rory Hunter d2dbef5063
Convert repository plugins to modules (#81870)
Closes #81652.

Convert the `repository-azure`, `repository-gcs` and `repository-s3`
plugins into modules, so that they are always included in the
Elasticsearch distribution. Also change plugin installation, removal
and syncing so that attempting to add or remove these plugins still
succeeds but is now a no-op.
2022-01-10 10:45:42 +00:00
.ci Convert repository plugins to modules (#81870) 2022-01-10 10:45:42 +00:00
.github Add GitHub action for synchronizing commits from master to main branch 2021-08-24 15:51:33 -07:00
.idea Allow for debugging of rest test clusters during test execution (#79085) 2021-10-14 12:48:45 -07:00
benchmarks Use Java 14 switch expressions (#82178) 2022-01-10 09:53:35 +01:00
build-conventions Update checkstyle to latest 8.x release (#82186) 2022-01-05 12:45:51 +01:00
build-tools Use Java 14 switch expressions (#82178) 2022-01-10 09:53:35 +01:00
build-tools-internal Convert repository plugins to modules (#81870) 2022-01-10 10:45:42 +00:00
ccr/images [DOCS] Update remote cluster docs (#77043) 2021-09-22 16:02:33 -04:00
client Use Java 14 switch expressions (#82178) 2022-01-10 09:53:35 +01:00
dev-tools Improve atomic push script to support worktrees (#68873) 2021-02-11 10:13:15 -08:00
distribution Convert repository plugins to modules (#81870) 2022-01-10 10:45:42 +00:00
docs Convert repository plugins to modules (#81870) 2022-01-10 10:45:42 +00:00
gradle/wrapper Update gradle wrapper to 7.3.3 (#82057) 2021-12-23 06:57:43 -05:00
libs Use Java 14 switch expressions (#82178) 2022-01-10 09:53:35 +01:00
licenses Keep low level rest client under Apache 2 software license (#68694) 2021-02-08 11:13:31 -08:00
modules Convert repository plugins to modules (#81870) 2022-01-10 10:45:42 +00:00
plugins Convert repository plugins to modules (#81870) 2022-01-10 10:45:42 +00:00
qa Convert repository plugins to modules (#81870) 2022-01-10 10:45:42 +00:00
rest-api-spec Mute 3 cat/indices segment tests (#82025) 2021-12-22 12:25:28 +00:00
server Convert repository plugins to modules (#81870) 2022-01-10 10:45:42 +00:00
test Use Java 14 switch expressions (#82178) 2022-01-10 09:53:35 +01:00
x-pack Convert repository plugins to modules (#81870) 2022-01-10 10:45:42 +00:00
.backportrc.json Add version for 7.17.0 2021-12-16 07:02:32 -08:00
.dir-locals.el Go back to 140 column limit in .dir-locals.el 2017-04-14 08:50:53 -06:00
.editorconfig Formatting escape hatch (#81806) 2021-12-16 16:18:34 +00:00
.git-blame-ignore-revs Fix typo in instructions for ignore-revs (#80058) 2021-11-04 12:10:55 +11:00
.gitattributes Assert no carriage returns in release notes test samples (#77238) 2021-09-07 20:45:23 +01:00
.gitignore Move custom checkstyle rule implementations to build-conventions project (#74017) 2021-06-10 16:06:44 -07:00
build.gradle Enable BWC tests after adjusting Lucene version for 7.17 (#81956) (#81965) 2021-12-20 21:07:49 -05:00
BUILDING.md Document how to test a dev version of a 3party dependency (#78962) 2021-10-13 05:23:37 -04:00
CONTRIBUTING.md Update CONTRIBUTING.md (#80106) 2022-01-06 12:46:14 -05:00
gradle.properties Fix Spotless failing with InvocationTargetException on JDK 16 (#73246) 2021-05-20 08:46:20 +02:00
gradlew Update Gradle wrapper to 7.2 (#75894) 2021-08-18 05:11:28 -04:00
gradlew.bat Update gradle wrapper to 6.6 (#59909) 2020-08-11 10:17:33 +02:00
LICENSE.txt Update sources with new SSPL+Elastic-2.0 license headers 2021-02-02 16:10:53 -08:00
NOTICE.txt Remove Joda dependency (#79007) 2021-10-13 17:37:31 -07:00
README.asciidoc [DOCS] Refactor quick start guide and README (#71331) 2021-04-20 09:32:21 -04:00
settings.gradle Check whether stdout is a real console (#79882) 2021-10-28 14:06:33 +11:00
TESTING.asciidoc Fix docs for passing JVM args to ./gradlew run (#81253) 2021-12-03 09:16:23 +00:00
Vagrantfile Introduce ES_JAVA_HOME (#68954) 2021-02-17 12:41:23 -05:00

= Elasticsearch

Elasticsearch is the distributed, RESTful search and analytics engine at the
heart of the https://www.elastic.co/products[Elastic Stack]. You can use
Elasticsearch to store, search, and manage data for:

* Logs
* Metrics
* A search backend
* Application monitoring
* Endpoint security

\... and more!

To learn more about Elasticsearch's features and capabilities, see our
https://www.elastic.co/products/elasticsearch[product page].

[[get-started]]
== Get started

The simplest way to set up Elasticsearch is to create a managed deployment with
https://www.elastic.co/cloud/as-a-service[Elasticsearch Service on Elastic
Cloud].

If you prefer to install and manage Elasticsearch yourself, you can download
the latest version from 
https://www.elastic.co/downloads/elasticsearch[elastic.co/downloads/elasticsearch].

For more installation options, see the
https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html[Elasticsearch installation
documentation].

[[upgrade]]
== Upgrade

To upgrade from an earlier version of Elasticsearch, see the
https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html[Elasticsearch upgrade
documentation].

[[build-source]]
== Build from source

Elasticsearch uses https://gradle.org[Gradle] for its build system.

To build a distribution for your local OS and print its output location upon
completion, run:
----
./gradlew localDistro
----

To build a distribution for another platform, run the related command:
----
./gradlew :distribution:archives:linux-tar:assemble
./gradlew :distribution:archives:darwin-tar:assemble
./gradlew :distribution:archives:windows-zip:assemble
----

To build distributions for all supported platforms, run:
----
./gradlew assemble
----

Distributions are output to `distributions/archives`.

To run the test suite, see xref:TESTING.asciidoc[TESTING].

[[docs]]
== Documentation

For the complete Elasticsearch documentation visit
https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html[elastic.co].

For information about our documentation processes, see the
xref:docs/README.asciidoc[docs README].

[[contribute]]
== Contribute

For contribution guidelines, see xref:CONTRIBUTING.md[CONTRIBUTING]. 

[[questions]]
== Questions? Problems? Suggestions?

* To report a bug or request a feature, create a
https://github.com/elastic/elasticsearch/issues/new/choose[GitHub Issue]. Please
ensure someone else hasn't created an issue for the same topic.

* Need help using Elasticsearch? Reach out on the
https://discuss.elastic.co[Elastic Forum] or https://ela.st/slack[Slack]. A
fellow community member or Elastic engineer will be happy to help you out.