Go to file
Mark Vieira d2c52ef495
Split x-pack testing into multiple CI jobs (#88697)
2022-07-27 12:58:31 -07:00
.ci Add "part 3" pull request CI jobs 2022-07-27 12:39:30 -07:00
.github Remove GitHub action for syncing main branch with master 2022-07-22 16:19:58 -07:00
.idea Stop versioning Checkstyle IDE config (#87285) 2022-06-02 08:58:11 +01:00
benchmarks Add FieldDataContext (#88779) 2022-07-26 14:47:50 +01:00
build-conventions Add Checkstyle rule for broken switch cases (#88739) 2022-07-27 09:22:06 +01:00
build-tools Reinstate test cluster throttling behavior (#88664) 2022-07-21 12:24:24 +02:00
build-tools-internal Split x-pack testing into multiple CI jobs (#88697) 2022-07-27 12:58:31 -07:00
ccr/images [DOCS] Update remote cluster docs (#77043) 2021-09-22 16:02:33 -04:00
client Setup elasticsearch dependency monitoring with Snyk for production code (#88036) 2022-06-29 13:29:14 +02:00
dev-tools Improve atomic push script to support worktrees (#68873) 2021-02-11 10:13:15 -08:00
distribution Add support for reading stable plugin descriptors (#88731) 2022-07-26 10:28:24 +09:30
docs Format runtime geo_points (#85449) 2022-07-27 13:11:07 -04:00
gradle Remove random runner from build tools (internal) tests (#88577) 2022-07-20 08:04:26 +02:00
libs Fix EmbeddedImplClassLoaderTests on Windows (#88813) 2022-07-27 00:08:37 +01:00
licenses Keep low level rest client under Apache 2 software license (#68694) 2021-02-08 11:13:31 -08:00
modules Format runtime geo_points (#85449) 2022-07-27 13:11:07 -04:00
plugins Add FieldDataContext (#88779) 2022-07-26 14:47:50 +01:00
qa Add support for reading stable plugin descriptors (#88731) 2022-07-26 10:28:24 +09:30
rest-api-spec Format runtime geo_points (#85449) 2022-07-27 13:11:07 -04:00
server Format runtime geo_points (#85449) 2022-07-27 13:11:07 -04:00
test Add stable indicator for plugin descriptor (#88823) 2022-07-26 12:19:14 -07:00
x-pack Mute failing BWC tests 2022-07-27 09:00:21 -07:00
.backportrc.json Remove 8.5 branch from backport config 2022-07-27 09:28:58 -07:00
.dir-locals.el Go back to 140 column limit in .dir-locals.el 2017-04-14 08:50:53 -06:00
.editorconfig SQL: Fix FORMAT function to better comply with Microsoft SQL Server specification (#86225) 2022-05-18 12:03:00 +02: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 Stop versioning Checkstyle IDE config (#87285) 2022-06-02 08:58:11 +01:00
BUILDING.md Update references to master branch in developer documentation 2022-07-25 10:59:08 -07:00
CHANGELOG.md Add changelog (#83830) 2022-02-11 13:29:22 +00:00
CONTRIBUTING.md Update references to master branch in developer documentation 2022-07-25 10:59:08 -07: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
REST_API_COMPATIBILITY.md Update references to master branch in developer documentation 2022-07-25 10:59:08 -07:00
TESTING.asciidoc Update references to master branch in developer documentation 2022-07-25 10:59:08 -07:00
Vagrantfile Introduce ES_JAVA_HOME (#68954) 2021-02-17 12:41:23 -05:00
build.gradle Split x-pack testing into multiple CI jobs (#88697) 2022-07-27 12:58:31 -07:00
gradle.properties Allow easing testing of java ea versions using gradle java tool chain support (#88188) 2022-07-04 08:43:18 +02:00
gradlew Update to to Gradle wrapper 7.5 (#85141) 2022-07-19 08:12:19 +02:00
gradlew.bat Update to to Gradle wrapper 7.5 (#85141) 2022-07-19 08:12:19 +02:00
settings.gradle Remove duplicate definition of checkstyle version in use (#88339) 2022-07-15 19:31:50 +02:00

README.asciidoc

= 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.