|
|
@@ -14,29 +14,26 @@ WARNING:
|
|
|
|
|
|
-->
|
|
|
|
|
|
-# **DEPRECATION NOTICE**
|
|
|
-
|
|
|
-This image has been deprecated in favor of the [official `elasticsearch` image](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html) provided and maintained by [elastic.co](https://www.elastic.co/). The list of images available from Elastic can be found at [www.docker.elastic.co](https://www.docker.elastic.co/). The images found here will receive no further updates once the `6.0.0` release is available upstream. Please adjust your usage accordingly.
|
|
|
-
|
|
|
-Elastic provides open-source support for Elasticsearch via the [elastic/elasticsearch GitHub repository](https://github.com/elastic/elasticsearch) and the Docker image via the [elastic/elasticsearch-docker GitHub repository](https://github.com/elastic/elasticsearch-docker), as well as community support via its [forums](https://discuss.elastic.co/c/elasticsearch).
|
|
|
-
|
|
|
# Supported tags and respective `Dockerfile` links
|
|
|
|
|
|
+- [`6.4.1` (*6.4.1/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/41ec004d537b2d5d1a4bdd5664fbee018f8cb98e/6.4.1/Dockerfile)
|
|
|
+- [`6.4.0` (*6.4.0/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/936f5c437c1509a8ee090868b030ca2f89cc0021/6.4.0/Dockerfile)
|
|
|
+- [`6.4.2` (*6/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/41ec004d537b2d5d1a4bdd5664fbee018f8cb98e/6/Dockerfile)
|
|
|
- [`5.6.12`, `5.6`, `5`, `latest` (*5/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/b30b4e51e77c6289be522b1d5c3d64918b9d77d9/5/Dockerfile)
|
|
|
- [`5.6.12-alpine`, `5.6-alpine`, `5-alpine`, `alpine` (*5/alpine/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/b30b4e51e77c6289be522b1d5c3d64918b9d77d9/5/alpine/Dockerfile)
|
|
|
-- [`2.4.6`, `2.4`, `2` (*2.4/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/8e87587ac5d6b44a8382a229162c88e65618c30a/2.4/Dockerfile)
|
|
|
-- [`2.4.6-alpine`, `2.4-alpine`, `2-alpine` (*2.4/alpine/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/8e87587ac5d6b44a8382a229162c88e65618c30a/2.4/alpine/Dockerfile)
|
|
|
|
|
|
# Quick reference
|
|
|
|
|
|
- **Where to get help**:
|
|
|
- [the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://blog.docker.com/2016/11/introducing-docker-community-directory-docker-community-slack/), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
|
|
|
+ the [Elasticsearch Discuss Forums](https://discuss.elastic.co/c/elasticsearch), the [Elastic community](https://www.elastic.co/community)
|
|
|
|
|
|
- **Where to file issues**:
|
|
|
- [https://github.com/docker-library/elasticsearch/issues](https://github.com/docker-library/elasticsearch/issues)
|
|
|
+ For issues with Elasticsearch Docker Image: https://github.com/elastic/elasticsearch-docker/issues
|
|
|
+
|
|
|
+For issues with Elasticsearch: [https://github.com/elastic/elasticsearch/issues](https://github.com/elastic/elasticsearch/issues)
|
|
|
|
|
|
- **Maintained by**:
|
|
|
- [the Docker Community](https://github.com/docker-library/elasticsearch)
|
|
|
+ [the Elastic Team](https://github.com/elastic/elasticsearch-docker)
|
|
|
|
|
|
- **Supported architectures**: ([more info](https://github.com/docker-library/official-images#architectures-other-than-amd64))
|
|
|
[`amd64`](https://hub.docker.com/r/amd64/elasticsearch/)
|
|
|
@@ -57,88 +54,47 @@ Elastic provides open-source support for Elasticsearch via the [elastic/elastics
|
|
|
|
|
|
# What is Elasticsearch?
|
|
|
|
|
|
-Elasticsearch is a search server based on Lucene. It provides a distributed, multitenant-capable full-text search engine with a RESTful web interface and schema-free JSON documents.
|
|
|
+Elasticsearch is a distributed, RESTful search and analytics engine capable of solving a growing number of use cases. As the heart of the Elastic Stack, it centrally stores your data so you can discover the expected and uncover the unexpected.
|
|
|
|
|
|
-Elasticsearch is a registered trademark of Elasticsearch BV.
|
|
|
-
|
|
|
-> [wikipedia.org/wiki/Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch)
|
|
|
+> For more information about Elasticsearch, please visit [www.elastic.co/products/elasticsearch](https://www.elastic.co/products/elasticsearch)
|
|
|
|
|
|
|
|
|
|
|
|
-# How to use this image
|
|
|
-
|
|
|
-## Cluster
|
|
|
-
|
|
|
-**Note:** since 5.0, Elasticsearch only listens on `localhost` by default on both http and transport, so this image sets `http.host` to `0.0.0.0` (given that `localhost` is not terribly useful in the Docker context).
|
|
|
-
|
|
|
-As a result, this image does not support clustering out of the box and extra configuration must be set in order to support it.
|
|
|
-
|
|
|
-Supporting clustering implies having Elasticsearch in a production mode which is more strict about the bootstrap checks that it performs, especially when checking the value of `vm.max_map_count` which is not namespaced and thus must be set to an acceptable value on the host (as opposed to simply using `--sysctl` on `docker run`).
|
|
|
-
|
|
|
-One example of adding clustering support is to pass the configuration on the `docker run`:
|
|
|
-
|
|
|
-```console
|
|
|
-$ docker run -d --name elas elasticsearch -Etransport.host=0.0.0.0 -Ediscovery.zen.minimum_master_nodes=1
|
|
|
-```
|
|
|
+# About This Image
|
|
|
|
|
|
-See the following sections of the upstream documentation for more information:
|
|
|
+This default distribution is governed by the Elastic License, and includes the [full set of free features](https://www.elastic.co/subscriptions).
|
|
|
|
|
|
-- [Setup Elasticsearch » Important System Configuration » Virtual memory](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/vm-max-map-count.html)
|
|
|
-- [Setup Elasticsearch » Bootstrap Checks » Maximum map count check](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/_maximum_map_count_check.html)
|
|
|
+View the detailed release notes [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/es-release-notes.html).
|
|
|
|
|
|
-This [comment in elastic/elasticsearch#4978](https://github.com/elastic/elasticsearch/issues/4978#issuecomment-258676104) shows why this change was added in upstream.
|
|
|
+Not the version you're looking for? View all supported [past releases](https://www.docker.elastic.co).
|
|
|
|
|
|
-> Elasticsearch will not start in production mode if `vm.max_map_count` is not high enough. [...] If the value on your system is NOT high enough, then your cluster is going to crash and burn at some stage and you will lose data.
|
|
|
+# How to use this image
|
|
|
|
|
|
-## Running Containers
|
|
|
+**Note:** Pulling an images requires using a specific version number tag. The `latest` tag is not supported.
|
|
|
|
|
|
-You can run the default `elasticsearch` command simply:
|
|
|
+For Elasticsearch versions prior to 6.4.0 a full list of images, tags, and documentation can be found at [docker.elastic.co](https://www.docker.elastic.co/).
|
|
|
|
|
|
-```console
|
|
|
-$ docker run -d elasticsearch
|
|
|
-```
|
|
|
+For full Elasticsearch documentation see [here](https://www.elastic.co/guide/en/elasticsearch/reference/index.html).
|
|
|
|
|
|
-You can also pass in additional flags to `elasticsearch`:
|
|
|
+**The commands below are intended for deploying in a development context only. For production installation and configuration, see [Install Elasticsearch with Docker](https://www.elastic.co/guide/en/elasticsearch/reference/6.4/docker.html).**
|
|
|
|
|
|
-```console
|
|
|
-$ docker run -d elasticsearch -Des.node.name="TestNode"
|
|
|
-```
|
|
|
+## Running in Development Mode
|
|
|
|
|
|
-This image comes with a default set of configuration files for `elasticsearch`, but if you want to provide your own set of configuration files, you can do so via a volume mounted at `/usr/share/elasticsearch/config`:
|
|
|
+Create user defined network (useful for connecting to other services attached to the same network (e.g. Kibana)):
|
|
|
|
|
|
```console
|
|
|
-$ docker run -d -v "$PWD/config":/usr/share/elasticsearch/config elasticsearch
|
|
|
+$ docker network create somenetwork
|
|
|
```
|
|
|
|
|
|
-This image is configured with a volume at `/usr/share/elasticsearch/data` to hold the persisted index data. Use that path if you would like to keep the data in a mounted volume:
|
|
|
+Run Elasticsearch:
|
|
|
|
|
|
```console
|
|
|
-$ docker run -d -v "$PWD/esdata":/usr/share/elasticsearch/data elasticsearch
|
|
|
-```
|
|
|
-
|
|
|
-This image includes `EXPOSE 9200 9300` ([default `http.port`](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-http.html)), so standard container linking will make it automatically available to the linked containers.
|
|
|
-
|
|
|
-## ... via [`docker stack deploy`](https://docs.docker.com/engine/reference/commandline/stack_deploy/) or [`docker-compose`](https://github.com/docker/compose)
|
|
|
-
|
|
|
-Example `stack.yml` for `elasticsearch`:
|
|
|
-
|
|
|
-```yaml
|
|
|
-version: '3.1'
|
|
|
-
|
|
|
-services:
|
|
|
-
|
|
|
- elasticsearch:
|
|
|
- image: elasticsearch
|
|
|
-
|
|
|
- kibana:
|
|
|
- image: kibana
|
|
|
- ports:
|
|
|
- - 5601:5601
|
|
|
+$ docker run -d --name elasticsearch --net somenetwork -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" elasticsearch:tag
|
|
|
```
|
|
|
|
|
|
-[](http://play-with-docker.com?stack=https://raw.githubusercontent.com/docker-library/docs/9efeec18b6b2ed232cf0fbd3914b6211e16e242c/elasticsearch/stack.yml)
|
|
|
+## Running in Production Mode
|
|
|
|
|
|
-Run `docker stack deploy -c stack.yml elasticsearch` (or `docker-compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:5601`, `http://localhost:5601`, or `http://host-ip:5601` (as appropriate).
|
|
|
+See [Install Elasticsearch with Docker](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/docker.html)
|
|
|
|
|
|
# Image Variants
|
|
|
|
|
|
@@ -158,7 +114,7 @@ To minimize image size, it's uncommon for additional related tools (such as `git
|
|
|
|
|
|
# License
|
|
|
|
|
|
-View [license information](https://github.com/elasticsearch/elasticsearch/blob/66b5ed86f7adede8102cd4d979b9f4924e5bd837/LICENSE.txt) for the software contained in this image.
|
|
|
+View [license information](https://github.com/elastic/elasticsearch/blob/6.4/licenses/ELASTIC-LICENSE.txt) for the software contained in this image.
|
|
|
|
|
|
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
|
|
|
|
Docker Library Bot