|
|
@@ -1,158 +0,0 @@
|
|
|
-<!--
|
|
|
-
|
|
|
-********************************************************************************
|
|
|
-
|
|
|
-WARNING:
|
|
|
-
|
|
|
- DO NOT EDIT "elasticsearch/README.md"
|
|
|
-
|
|
|
- IT IS AUTO-GENERATED
|
|
|
-
|
|
|
- (from the other files in "elasticsearch/" combined with a set of templates)
|
|
|
-
|
|
|
-********************************************************************************
|
|
|
-
|
|
|
--->
|
|
|
-
|
|
|
-# **DEPRECATED**
|
|
|
-
|
|
|
-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 upstream images are available to pull via `docker.elastic.co/elasticsearch/elasticsearch:[version]` like `5.4.2`. The images found here will receive no further updates once the `5.6.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
|
|
|
-
|
|
|
-- [`5.5.2`, `5.5`, `5`, `latest` (*5/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/094b4b6bff8626a2391404413a2e338c48ef7a26/5/Dockerfile)
|
|
|
-- [`5.5.2-alpine`, `5.5-alpine`, `5-alpine`, `alpine` (*5/alpine/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/094b4b6bff8626a2391404413a2e338c48ef7a26/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)
|
|
|
-
|
|
|
-- **Where to file issues**:
|
|
|
- [https://github.com/docker-library/elasticsearch/issues](https://github.com/docker-library/elasticsearch/issues)
|
|
|
-
|
|
|
-- **Maintained by**:
|
|
|
- [the Docker Community](https://github.com/docker-library/elasticsearch)
|
|
|
-
|
|
|
-- **Published image artifact details**:
|
|
|
- [repo-info repo's `repos/elasticsearch/` directory](https://github.com/docker-library/repo-info/blob/master/repos/elasticsearch) ([history](https://github.com/docker-library/repo-info/commits/master/repos/elasticsearch))
|
|
|
- (image metadata, transfer size, etc)
|
|
|
-
|
|
|
-- **Image updates**:
|
|
|
- [official-images PRs with label `library/elasticsearch`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Felasticsearch)
|
|
|
- [official-images repo's `library/elasticsearch` file](https://github.com/docker-library/official-images/blob/master/library/elasticsearch) ([history](https://github.com/docker-library/official-images/commits/master/library/elasticsearch))
|
|
|
-
|
|
|
-- **Source of this description**:
|
|
|
- [docs repo's `elasticsearch/` directory](https://github.com/docker-library/docs/tree/master/elasticsearch) ([history](https://github.com/docker-library/docs/commits/master/elasticsearch))
|
|
|
-
|
|
|
-- **Supported Docker versions**:
|
|
|
- [the latest release](https://github.com/docker/docker/releases/latest) (down to 1.6 on a best-effort basis)
|
|
|
-
|
|
|
-# 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 registered trademark of Elasticsearch BV.
|
|
|
-
|
|
|
-> [wikipedia.org/wiki/Elasticsearch](https://en.wikipedia.org/wiki/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
|
|
|
-```
|
|
|
-
|
|
|
-See the following sections of the upstream documentation for more information:
|
|
|
-
|
|
|
-- [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)
|
|
|
-
|
|
|
-This [comment in elastic/elasticsearch#4978](https://github.com/elastic/elasticsearch/issues/4978#issuecomment-258676104) shows why this change was added in upstream.
|
|
|
-
|
|
|
-> 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.
|
|
|
-
|
|
|
-## Running Containers
|
|
|
-
|
|
|
-You can run the default `elasticsearch` command simply:
|
|
|
-
|
|
|
-```console
|
|
|
-$ docker run -d elasticsearch
|
|
|
-```
|
|
|
-
|
|
|
-You can also pass in additional flags to `elasticsearch`:
|
|
|
-
|
|
|
-```console
|
|
|
-$ docker run -d elasticsearch -Des.node.name="TestNode"
|
|
|
-```
|
|
|
-
|
|
|
-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`:
|
|
|
-
|
|
|
-```console
|
|
|
-$ docker run -d -v "$PWD/config":/usr/share/elasticsearch/config elasticsearch
|
|
|
-```
|
|
|
-
|
|
|
-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:
|
|
|
-
|
|
|
-```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
|
|
|
-```
|
|
|
-
|
|
|
-[](http://play-with-docker.com?stack=https://raw.githubusercontent.com/docker-library/docs/96c08fac215f64844b9db61038a571b86534a12b/elasticsearch/stack.yml)
|
|
|
-
|
|
|
-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).
|
|
|
-
|
|
|
-# Image Variants
|
|
|
-
|
|
|
-The `elasticsearch` images come in many flavors, each designed for a specific use case.
|
|
|
-
|
|
|
-## `elasticsearch:<version>`
|
|
|
-
|
|
|
-This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
|
|
-
|
|
|
-## `elasticsearch:alpine`
|
|
|
-
|
|
|
-This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
|
|
-
|
|
|
-This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
|
|
-
|
|
|
-To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
|
|
-
|
|
|
-# License
|
|
|
-
|
|
|
-View [license information](https://github.com/elasticsearch/elasticsearch/blob/66b5ed86f7adede8102cd4d979b9f4924e5bd837/LICENSE.txt) for the software contained in this image.
|
Tianon Gravi
