Revert "Remove deprecated image docs"

This reverts commit 6fad642. This does _not_ include the generated `README.md` files -- we'll let @docker-library-bot recreate those.
judgej · Oct 23, 2017 · c6273ff · c6273ff
1 parent 4991d9c
commit c6273ff
Show file tree

Hide file tree

Showing 23 changed files with 214 additions and 0 deletions.
diff --git a/elasticsearch/README-short.txt b/elasticsearch/README-short.txt
@@ -0,0 +1 @@
+Elasticsearch is a powerful open source search and analytics engine that makes data easy to explore.
diff --git a/elasticsearch/content.md b/elasticsearch/content.md
@@ -0,0 +1,66 @@
+# 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)
+
+%%LOGO%%
+
+# 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.
+
+## %%STACK%%
+
+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).
diff --git a/elasticsearch/deprecated.md b/elasticsearch/deprecated.md
@@ -0,0 +1,3 @@
+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).
diff --git a/elasticsearch/github-repo b/elasticsearch/github-repo
@@ -0,0 +1 @@
+https://github.com/docker-library/elasticsearch
diff --git a/elasticsearch/license.md b/elasticsearch/license.md
@@ -0,0 +1 @@
+View [license information](https://github.com/elasticsearch/elasticsearch/blob/66b5ed86f7adede8102cd4d979b9f4924e5bd837/LICENSE.txt) for the software contained in this image.
diff --git a/elasticsearch/logo.png b/elasticsearch/logo.png
diff --git a/elasticsearch/maintainer.md b/elasticsearch/maintainer.md
@@ -0,0 +1 @@
+../.common-templates/maintainer-community.md
diff --git a/elasticsearch/stack.yml b/elasticsearch/stack.yml
@@ -0,0 +1,11 @@
+version: '3.1'
+
+services:
+
+    elasticsearch:
+        image: elasticsearch
+
+    kibana:
+        image: kibana
+        ports:
+            - 5601:5601
diff --git a/kibana/README-short.txt b/kibana/README-short.txt
@@ -0,0 +1 @@
+Kibana gives shape to any kind of data — structured and unstructured — indexed in Elasticsearch.
diff --git a/kibana/content.md b/kibana/content.md
@@ -0,0 +1,41 @@
+# What is Kibana?
+
+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.
+
+Kibana is a registered trademark of Elasticsearch BV.
+
+> [wikipedia.org/wiki/Kibana](https://en.wikipedia.org/wiki/Kibana)
+
+%%LOGO%%
+
+# How to use this image
+
+You can run the default `%%REPO%%` command simply:
+
+```console
+$ docker run --link some-elasticsearch:elasticsearch -d %%REPO%%
+```
+
+You can also pass in additional flags to `%%REPO%%`:
+
+```console
+$ docker run --link some-elasticsearch:elasticsearch -d %%REPO%% --plugins /somewhere/else
+```
+
+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:
+
+```console
+$ docker run --name some-%%REPO%% --link some-elasticsearch:elasticsearch -p 5601:5601 -d %%REPO%%
+```
+
+You can also provide the address of elasticsearch via `ELASTICSEARCH_URL` environnement variable:
+
+```console
+$ docker run --name some-kibana -e ELASTICSEARCH_URL=http://some-elasticsearch:9200 -p 5601:5601 -d kibana
+```
+
+Then, access it via `http://localhost:5601` or `http://host-ip:5601` in a browser.
+
+## %%STACK%%
+
+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).
diff --git a/kibana/deprecated.md b/kibana/deprecated.md
@@ -0,0 +1,3 @@
+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 upstream images are available to pull via `docker.elastic.co/kibana/kibana:[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 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).
diff --git a/kibana/github-repo b/kibana/github-repo
@@ -0,0 +1 @@
+https://github.com/docker-library/kibana
diff --git a/kibana/license.md b/kibana/license.md
@@ -0,0 +1 @@
+View [license information](https://github.com/elastic/kibana/blob/4557a6fc0ba08c5e7ac813a180179e5e2631c90a/LICENSE.md) for the software contained in this image.
diff --git a/kibana/logo.png b/kibana/logo.png
diff --git a/kibana/maintainer.md b/kibana/maintainer.md
@@ -0,0 +1 @@
+../.common-templates/maintainer-community.md
diff --git a/kibana/stack.yml b/kibana/stack.yml
@@ -0,0 +1,12 @@
+version: '3.1'
+
+services:
+
+    kibana:
+        image: kibana
+        ports:
+            - 5601:5601
+
+    elasticsearch:
+        image: elasticsearch
+
diff --git a/logstash/README-short.txt b/logstash/README-short.txt
@@ -0,0 +1 @@
+Logstash is a tool for managing events and logs.
diff --git a/logstash/content.md b/logstash/content.md
@@ -0,0 +1,63 @@
+# What is Logstash?
+
+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.
+
+> [wikitech.wikimedia.org/wiki/Logstash](https://wikitech.wikimedia.org/wiki/Logstash)
+
+%%LOGO%%
+
+# How to use this image
+
+## Start Logstash with commandline configuration
+
+If you need to run logstash with configuration provided on the commandline, you can use the logstash image as follows:
+
+```console
+$ docker run -it --rm logstash -e 'input { stdin { } } output { stdout { } }'
+```
+
+## Start Logstash with configuration file
+
+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:
+
+```console
+$ docker run -it --rm -v "$PWD":/config-dir logstash -f /config-dir/logstash.conf
+```
+
+### Using a `Dockerfile`
+
+If you'd like to have a production Logstash image with a pre-baked configuration file, use of a `Dockerfile` is recommended:
+
+```dockerfile
+FROM logstash
+
+COPY logstash.conf /some/config-dir/
+
+CMD ["-f", "/some/config-dir/logstash.conf"]
+```
+
+Then, build with `docker build -t my-logstash .` and deploy with something like the following:
+
+```console
+$ docker run -d my-logstash
+```
+
+## Installing plugins
+
+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.
+
+```dockerfile
+FROM logstash:5
+
+RUN logstash-plugin install logstash-filter-de_dot
+
+COPY logstash.conf /some/config-dir/
+
+CMD ["-f", "/some/config-dir/logstash.conf"]
+```
+
+Then, build with `docker build -t my-logstash .` and deploy just like the previous example:
+
+```console
+$ docker run -d my-logstash
+```
diff --git a/logstash/deprecated.md b/logstash/deprecated.md
@@ -0,0 +1,3 @@
+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 upstream images are available to pull via `docker.elastic.co/logstash/logstash:[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 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).
diff --git a/logstash/github-repo b/logstash/github-repo
@@ -0,0 +1 @@
+https://github.com/docker-library/logstash
diff --git a/logstash/license.md b/logstash/license.md
@@ -0,0 +1 @@
+View [license information](https://github.com/elastic/logstash/blob/master/LICENSE) for the software contained in this image.
diff --git a/logstash/logo.png b/logstash/logo.png
diff --git a/logstash/maintainer.md b/logstash/maintainer.md
@@ -0,0 +1 @@
+../.common-templates/maintainer-community.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Elasticsearch is a powerful open source search and analytics engine that makes data easy to explore.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		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).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		https://github.com/docker-library/elasticsearch
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		View [license information](https://github.com/elasticsearch/elasticsearch/blob/66b5ed86f7adede8102cd4d979b9f4924e5bd837/LICENSE.txt) for the software contained in this image.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Kibana gives shape to any kind of data — structured and unstructured — indexed in Elasticsearch.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Logstash is a tool for managing events and logs.