Skip to content

Commit 47faab2

Browse files
authored
Merge pull request #1043 from dliappis/re-enable-support-for-5.6
Re-enable `5.6` for Elastic products
2 parents 4991d9c + 95d1533 commit 47faab2

23 files changed

+214
-0
lines changed

elasticsearch/README-short.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Elasticsearch is a powerful open source search and analytics engine that makes data easy to explore.

elasticsearch/content.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# What is Elasticsearch?
2+
3+
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.
4+
5+
Elasticsearch is a registered trademark of Elasticsearch BV.
6+
7+
> [wikipedia.org/wiki/Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch)
8+
9+
%%LOGO%%
10+
11+
# How to use this image
12+
13+
## Cluster
14+
15+
**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).
16+
17+
As a result, this image does not support clustering out of the box and extra configuration must be set in order to support it.
18+
19+
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`).
20+
21+
One example of adding clustering support is to pass the configuration on the `docker run`:
22+
23+
```console
24+
$ docker run -d --name elas elasticsearch -Etransport.host=0.0.0.0 -Ediscovery.zen.minimum_master_nodes=1
25+
```
26+
27+
See the following sections of the upstream documentation for more information:
28+
29+
- [Setup Elasticsearch » Important System Configuration » Virtual memory](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/vm-max-map-count.html)
30+
- [Setup Elasticsearch » Bootstrap Checks » Maximum map count check](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/_maximum_map_count_check.html)
31+
32+
This [comment in elastic/elasticsearch#4978](https://github.com/elastic/elasticsearch/issues/4978#issuecomment-258676104) shows why this change was added in upstream.
33+
34+
> 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.
35+
36+
## Running Containers
37+
38+
You can run the default `elasticsearch` command simply:
39+
40+
```console
41+
$ docker run -d elasticsearch
42+
```
43+
44+
You can also pass in additional flags to `elasticsearch`:
45+
46+
```console
47+
$ docker run -d elasticsearch -Des.node.name="TestNode"
48+
```
49+
50+
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`:
51+
52+
```console
53+
$ docker run -d -v "$PWD/config":/usr/share/elasticsearch/config elasticsearch
54+
```
55+
56+
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:
57+
58+
```console
59+
$ docker run -d -v "$PWD/esdata":/usr/share/elasticsearch/data elasticsearch
60+
```
61+
62+
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.
63+
64+
## %%STACK%%
65+
66+
Run `docker stack deploy -c stack.yml %%REPO%%` (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).

elasticsearch/deprecated.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
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.
2+
3+
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).

elasticsearch/github-repo

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://github.com/docker-library/elasticsearch

elasticsearch/license.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
View [license information](https://github.com/elasticsearch/elasticsearch/blob/66b5ed86f7adede8102cd4d979b9f4924e5bd837/LICENSE.txt) for the software contained in this image.

elasticsearch/logo.png

6.68 KB
Loading

elasticsearch/maintainer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.common-templates/maintainer-community.md

elasticsearch/stack.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: '3.1'
2+
3+
services:
4+
5+
elasticsearch:
6+
image: elasticsearch
7+
8+
kibana:
9+
image: kibana
10+
ports:
11+
- 5601:5601

kibana/README-short.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Kibana gives shape to any kind of data — structured and unstructured — indexed in Elasticsearch.

kibana/content.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# What is Kibana?
2+
3+
Kibana is an open source data visualization plugin for Elasticsearch. It provides visualization capabilities on top of the content indexed on an Elasticsearch cluster. Users can create bar, line and scatter plots, or pie charts and maps on top of large volumes of data.
4+
5+
Kibana is a registered trademark of Elasticsearch BV.
6+
7+
> [wikipedia.org/wiki/Kibana](https://en.wikipedia.org/wiki/Kibana)
8+
9+
%%LOGO%%
10+
11+
# How to use this image
12+
13+
You can run the default `%%REPO%%` command simply:
14+
15+
```console
16+
$ docker run --link some-elasticsearch:elasticsearch -d %%REPO%%
17+
```
18+
19+
You can also pass in additional flags to `%%REPO%%`:
20+
21+
```console
22+
$ docker run --link some-elasticsearch:elasticsearch -d %%REPO%% --plugins /somewhere/else
23+
```
24+
25+
This image includes `EXPOSE 5601` ([default `port`](https://www.elastic.co/guide/en/kibana/5.2/settings.html)). If you'd like to be able to access the instance from the host without the container's IP, standard port mappings can be used:
26+
27+
```console
28+
$ docker run --name some-%%REPO%% --link some-elasticsearch:elasticsearch -p 5601:5601 -d %%REPO%%
29+
```
30+
31+
You can also provide the address of elasticsearch via `ELASTICSEARCH_URL` environnement variable:
32+
33+
```console
34+
$ docker run --name some-kibana -e ELASTICSEARCH_URL=http://some-elasticsearch:9200 -p 5601:5601 -d kibana
35+
```
36+
37+
Then, access it via `http://localhost:5601` or `http://host-ip:5601` in a browser.
38+
39+
## %%STACK%%
40+
41+
Run `docker stack deploy -c stack.yml %%REPO%%` (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).

kibana/deprecated.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This image has been deprecated in favor of the [official `kibana` image](https://www.elastic.co/guide/en/kibana/current/_pulling_the_image.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.
2+
3+
Elastic provides open-source support for Kibana via the [elastic/kibana GitHub repository](https://github.com/elastic/kibana) and the Docker image via the [elastic/kibana-docker GitHub repository](https://github.com/elastic/kibana-docker), as well as community support via its [forums](https://discuss.elastic.co/c/kibana).

kibana/github-repo

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://github.com/docker-library/kibana

kibana/license.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
View [license information](https://github.com/elastic/kibana/blob/4557a6fc0ba08c5e7ac813a180179e5e2631c90a/LICENSE.md) for the software contained in this image.

kibana/logo.png

4.3 KB
Loading

kibana/maintainer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.common-templates/maintainer-community.md

kibana/stack.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: '3.1'
2+
3+
services:
4+
5+
kibana:
6+
image: kibana
7+
ports:
8+
- 5601:5601
9+
10+
elasticsearch:
11+
image: elasticsearch
12+

logstash/README-short.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Logstash is a tool for managing events and logs.

logstash/content.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# What is Logstash?
2+
3+
Logstash is a tool that can be used to collect, process and forward events and log messages. Collection is accomplished via number of configurable input plugins including raw socket/packet communication, file tailing and several message bus clients. Once an input plugin has collected data it can be processed by any number of filters which modify and annotate the event data. Finally events are routed to output plugins which can forward the events to a variety of external programs including Elasticsearch, local files and several message bus implementations.
4+
5+
> [wikitech.wikimedia.org/wiki/Logstash](https://wikitech.wikimedia.org/wiki/Logstash)
6+
7+
%%LOGO%%
8+
9+
# How to use this image
10+
11+
## Start Logstash with commandline configuration
12+
13+
If you need to run logstash with configuration provided on the commandline, you can use the logstash image as follows:
14+
15+
```console
16+
$ docker run -it --rm logstash -e 'input { stdin { } } output { stdout { } }'
17+
```
18+
19+
## Start Logstash with configuration file
20+
21+
If you need to run logstash with a configuration file, `logstash.conf`, that's located in your current directory, you can use the logstash image as follows:
22+
23+
```console
24+
$ docker run -it --rm -v "$PWD":/config-dir logstash -f /config-dir/logstash.conf
25+
```
26+
27+
### Using a `Dockerfile`
28+
29+
If you'd like to have a production Logstash image with a pre-baked configuration file, use of a `Dockerfile` is recommended:
30+
31+
```dockerfile
32+
FROM logstash
33+
34+
COPY logstash.conf /some/config-dir/
35+
36+
CMD ["-f", "/some/config-dir/logstash.conf"]
37+
```
38+
39+
Then, build with `docker build -t my-logstash .` and deploy with something like the following:
40+
41+
```console
42+
$ docker run -d my-logstash
43+
```
44+
45+
## Installing plugins
46+
47+
If you need to add any logstash plugins that do not ship with Logstash by default, the simplest solution is a Dockerfile using `logstash-plugin` included with Logsatsh. You can also pack in your customized config file.
48+
49+
```dockerfile
50+
FROM logstash:5
51+
52+
RUN logstash-plugin install logstash-filter-de_dot
53+
54+
COPY logstash.conf /some/config-dir/
55+
56+
CMD ["-f", "/some/config-dir/logstash.conf"]
57+
```
58+
59+
Then, build with `docker build -t my-logstash .` and deploy just like the previous example:
60+
61+
```console
62+
$ docker run -d my-logstash
63+
```

logstash/deprecated.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This image has been deprecated in favor of the [official `logstash` image](https://www.elastic.co/guide/en/logstash/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.
2+
3+
Elastic provides open-source support for Logstash via the [elastic/logstash GitHub repository](https://github.com/elastic/logstash) and the Docker image via the [elastic/logstash-docker GitHub repository](https://github.com/elastic/logstash-docker), as well as community support via its [forums](https://discuss.elastic.co/c/logstash).

logstash/github-repo

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://github.com/docker-library/logstash

logstash/license.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
View [license information](https://github.com/elastic/logstash/blob/master/LICENSE) for the software contained in this image.

logstash/logo.png

2.87 KB
Loading

logstash/maintainer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.common-templates/maintainer-community.md

0 commit comments

Comments
 (0)