From b4b0ad5b56423986b0fae23ba5c2e74537004913 Mon Sep 17 00:00:00 2001 From: Michelle Sausa Date: Thu, 20 Sep 2018 15:50:57 -0700 Subject: [PATCH 1/4] Update Kibana docs --- elasticsearch/content.md | 63 +++++++++++-------------------------- elasticsearch/deprecated.md | 3 -- elasticsearch/github-repo | 2 +- elasticsearch/license.md | 2 +- elasticsearch/maintainer.md | 2 +- kibana/content.md | 50 +++++++++++++++-------------- kibana/deprecated.md | 3 -- kibana/get-help.md | 1 + kibana/github-repo | 2 +- kibana/issues.md | 3 ++ kibana/license.md | 2 +- kibana/maintainer.md | 2 +- 12 files changed, 55 insertions(+), 80 deletions(-) delete mode 100644 elasticsearch/deprecated.md mode change 120000 => 100644 elasticsearch/maintainer.md delete mode 100644 kibana/deprecated.md create mode 100644 kibana/get-help.md create mode 100644 kibana/issues.md mode change 120000 => 100644 kibana/maintainer.md diff --git a/elasticsearch/content.md b/elasticsearch/content.md index 62029a0be..a3a6a6417 100644 --- a/elasticsearch/content.md +++ b/elasticsearch/content.md @@ -1,66 +1,39 @@ # 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. +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. > [wikipedia.org/wiki/Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch) %%LOGO%% +# About This Image + +This default distribution is governed by the Elastic License, and includes the [full set of free features](https://www.elastic.co/subscriptions). + +View the detailed release notes [here](https://www.elastic.co/guide/en/elasticsearch/reference/6.4/release-notes-6.4.1.html). + +Not the version you're looking for? View all supported [past releases](https://www.docker.elastic.co). + # How to use this image -## Cluster +**Note:** Pulling an images requires using a specific version number tag. The `latest` tag is not supported. -**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). +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/). -As a result, this image does not support clustering out of the box and extra configuration must be set in order to support it. +For full Elasticsearch documentation see [here](https://www.elastic.co/guide/en/elasticsearch/reference/6.4/index.html). -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`). +**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).** -One example of adding clustering support is to pass the configuration on the `docker run`: +## Running in Development Mode ```console -$ docker run -d --name elas elasticsearch -Etransport.host=0.0.0.0 -Ediscovery.zen.minimum_master_nodes=1 +$ docker pull elasticsearch:tag ``` -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 +$ docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" elasticsearch:tag ``` +## Running in Production Mode -You can also pass in additional flags to `elasticsearch`: +See [Install Elasticsearch with Docker](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/docker.html) -```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 deleted file mode 100644 index 7075f7c50..000000000 --- a/elasticsearch/deprecated.md +++ /dev/null @@ -1,3 +0,0 @@ -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). diff --git a/elasticsearch/github-repo b/elasticsearch/github-repo index 181f18470..d318bc510 100644 --- a/elasticsearch/github-repo +++ b/elasticsearch/github-repo @@ -1 +1 @@ -https://github.com/docker-library/elasticsearch +https://github.com/elastic/elasticsearch diff --git a/elasticsearch/license.md b/elasticsearch/license.md index 1d728f2ae..7f2d2887a 100644 --- a/elasticsearch/license.md +++ b/elasticsearch/license.md @@ -1 +1 @@ -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. diff --git a/elasticsearch/maintainer.md b/elasticsearch/maintainer.md deleted file mode 120000 index e727ff069..000000000 --- a/elasticsearch/maintainer.md +++ /dev/null @@ -1 +0,0 @@ -../.common-templates/maintainer-community.md \ No newline at end of file diff --git a/elasticsearch/maintainer.md b/elasticsearch/maintainer.md new file mode 100644 index 000000000..b656a395e --- /dev/null +++ b/elasticsearch/maintainer.md @@ -0,0 +1 @@ +[the Elastic Product Team](%%GITHUB-REPO%%) \ No newline at end of file diff --git a/kibana/content.md b/kibana/content.md index e07675bda..751f4f0d5 100644 --- a/kibana/content.md +++ b/kibana/content.md @@ -1,41 +1,45 @@ # 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 an open source analytics and visualization platform designed to work with Elasticsearch. You use Kibana to search, view, and interact with data stored in Elasticsearch indices. You can easily perform advanced data analysis and visualize your data in a variety of charts, tables, and maps. -Kibana is a registered trademark of Elasticsearch BV. - -> [wikipedia.org/wiki/Kibana](https://en.wikipedia.org/wiki/Kibana) +> For more information about Kibana, please visit [www.elastic.co/products/kibana](https://www.elastic.co/products/kibana) %%LOGO%% +# About This Image + +This default distribution is governed by the Elastic License, and includes the [full set of free features](https://www.elastic.co/subscriptions). + +View the detailed release notes [here](https://www.elastic.co/guide/en/kibana/current/release-notes.html). + +Not the version you're looking for? View all supported [past releases](https://www.docker.elastic.co). + # How to use this image -You can run the default `%%REPO%%` command simply: +**Note:** Pulling an images requires using a specific version number tag. The `latest` tag is not supported. + +For Kibana 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/). + +For full Kibana documentation see [here](https://www.elastic.co/guide/en/kibana/index.html). + +## Running in Development Mode + +In the given example, Kibana will a attach to a user defined network (useful for connecting to other services (e.g. Elasticsearch)). If network has not yet been created, this can be done with the following command: ```console -$ docker run --link some-elasticsearch:elasticsearch -d %%REPO%% -``` +$ docker network create somenetwork +``` +*Note: In this example, Kibana is using the default configuration and expects to connect to a running Elasticsearch instance at http://localhost:9200* -You can also pass in additional flags to `%%REPO%%`: +Run Kibana ```console -$ docker run --link some-elasticsearch:elasticsearch -d %%REPO%% --plugins /somewhere/else +$ docker run -d --name kibana --net somenetwork -p 5601:5601 kibana:tag ``` -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: +Kibana can be accessed by browser via `http://localhost:5601` or `http://host-ip:5601` -```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: +## Running in Production Mode -```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). +For additional information on running and configuring Kibana on Docker, see [Running Kibana on Docker](https://www.elastic.co/guide/en/kibana/current/docker.html) diff --git a/kibana/deprecated.md b/kibana/deprecated.md deleted file mode 100644 index dfcd3919c..000000000 --- a/kibana/deprecated.md +++ /dev/null @@ -1,3 +0,0 @@ -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. - -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/get-help.md b/kibana/get-help.md new file mode 100644 index 000000000..a42de0612 --- /dev/null +++ b/kibana/get-help.md @@ -0,0 +1 @@ +the [Kibana Discuss Forums](https://discuss.elastic.co/c/kibana), the [Elastic community](https://www.elastic.co/community) diff --git a/kibana/github-repo b/kibana/github-repo index 8d408c0b5..2c16d876c 100644 --- a/kibana/github-repo +++ b/kibana/github-repo @@ -1 +1 @@ -https://github.com/docker-library/kibana +https://github.com/elastic/kibana-docker diff --git a/kibana/issues.md b/kibana/issues.md new file mode 100644 index 000000000..f4d66961e --- /dev/null +++ b/kibana/issues.md @@ -0,0 +1,3 @@ +For issues with the Kibana Docker image: %%GITHUB-REPO%%/issues + +For issues with Kibana: [https://github.com/elastic/kibana/issues](https://github.com/elastic/kibana/issues) diff --git a/kibana/license.md b/kibana/license.md index cebde469d..235b4ac7c 100644 --- a/kibana/license.md +++ b/kibana/license.md @@ -1 +1 @@ -View [license information](https://github.com/elastic/kibana/blob/4557a6fc0ba08c5e7ac813a180179e5e2631c90a/LICENSE.md) for the software contained in this image. +View [license information](https://github.com/elastic/kibana/blob/master/licenses/ELASTIC-LICENSE.txt) for the software contained in this image. diff --git a/kibana/maintainer.md b/kibana/maintainer.md deleted file mode 120000 index e727ff069..000000000 --- a/kibana/maintainer.md +++ /dev/null @@ -1 +0,0 @@ -../.common-templates/maintainer-community.md \ No newline at end of file diff --git a/kibana/maintainer.md b/kibana/maintainer.md new file mode 100644 index 000000000..1d4f595ba --- /dev/null +++ b/kibana/maintainer.md @@ -0,0 +1 @@ +[the Elastic Team](%%GITHUB-REPO%%) From 97cf051c84baad4585e2c35eaf402f69629122f2 Mon Sep 17 00:00:00 2001 From: Michelle Sausa Date: Wed, 3 Oct 2018 12:36:06 -0600 Subject: [PATCH 2/4] Fix markdown formatting --- kibana/content.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/kibana/content.md b/kibana/content.md index 751f4f0d5..ec8508f2f 100644 --- a/kibana/content.md +++ b/kibana/content.md @@ -16,9 +16,9 @@ Not the version you're looking for? View all supported [past releases](https://w # How to use this image -**Note:** Pulling an images requires using a specific version number tag. The `latest` tag is not supported. +**Note:** Pulling an images requires using a specific version number tag. The `latest` tag is not supported. -For Kibana 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/). +For Kibana 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/). For full Kibana documentation see [here](https://www.elastic.co/guide/en/kibana/index.html). @@ -28,7 +28,8 @@ In the given example, Kibana will a attach to a user defined network (useful for ```console $ docker network create somenetwork -``` +``` + *Note: In this example, Kibana is using the default configuration and expects to connect to a running Elasticsearch instance at http://localhost:9200* Run Kibana @@ -39,7 +40,6 @@ $ docker run -d --name kibana --net somenetwork -p 5601:5601 kibana:tag Kibana can be accessed by browser via `http://localhost:5601` or `http://host-ip:5601` - ## Running in Production Mode For additional information on running and configuring Kibana on Docker, see [Running Kibana on Docker](https://www.elastic.co/guide/en/kibana/current/docker.html) From 73fda0976265ed39224f0d87b975343331eea319 Mon Sep 17 00:00:00 2001 From: Michelle Sausa Date: Wed, 3 Oct 2018 18:05:44 -0600 Subject: [PATCH 4/4] Reverting ES related changes --- elasticsearch/content.md | 63 ++++++++++++++++++++++++++----------- elasticsearch/github-repo | 2 +- elasticsearch/license.md | 2 +- elasticsearch/maintainer.md | 2 +- 4 files changed, 48 insertions(+), 21 deletions(-) mode change 100644 => 120000 elasticsearch/maintainer.md diff --git a/elasticsearch/content.md b/elasticsearch/content.md index a3a6a6417..62029a0be 100644 --- a/elasticsearch/content.md +++ b/elasticsearch/content.md @@ -1,39 +1,66 @@ # What is Elasticsearch? -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 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%% -# About This Image - -This default distribution is governed by the Elastic License, and includes the [full set of free features](https://www.elastic.co/subscriptions). - -View the detailed release notes [here](https://www.elastic.co/guide/en/elasticsearch/reference/6.4/release-notes-6.4.1.html). - -Not the version you're looking for? View all supported [past releases](https://www.docker.elastic.co). - # How to use this image -**Note:** Pulling an images requires using a specific version number tag. The `latest` tag is not supported. +## Cluster -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/). +**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). -For full Elasticsearch documentation see [here](https://www.elastic.co/guide/en/elasticsearch/reference/6.4/index.html). +As a result, this image does not support clustering out of the box and extra configuration must be set in order to support it. -**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).** +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`). -## Running in Development Mode +One example of adding clustering support is to pass the configuration on the `docker run`: ```console -$ docker pull elasticsearch:tag +$ 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 -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" elasticsearch:tag +$ docker run -d elasticsearch ``` -## Running in Production Mode -See [Install Elasticsearch with Docker](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/docker.html) +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/github-repo b/elasticsearch/github-repo index d318bc510..181f18470 100644 --- a/elasticsearch/github-repo +++ b/elasticsearch/github-repo @@ -1 +1 @@ -https://github.com/elastic/elasticsearch +https://github.com/docker-library/elasticsearch diff --git a/elasticsearch/license.md b/elasticsearch/license.md index 7f2d2887a..1d728f2ae 100644 --- a/elasticsearch/license.md +++ b/elasticsearch/license.md @@ -1 +1 @@ -View [license information](https://github.com/elastic/elasticsearch/blob/6.4/licenses/ELASTIC-LICENSE.txt) for the software contained in this image. +View [license information](https://github.com/elasticsearch/elasticsearch/blob/66b5ed86f7adede8102cd4d979b9f4924e5bd837/LICENSE.txt) for the software contained in this image. diff --git a/elasticsearch/maintainer.md b/elasticsearch/maintainer.md deleted file mode 100644 index b656a395e..000000000 --- a/elasticsearch/maintainer.md +++ /dev/null @@ -1 +0,0 @@ -[the Elastic Product Team](%%GITHUB-REPO%%) \ No newline at end of file diff --git a/elasticsearch/maintainer.md b/elasticsearch/maintainer.md new file mode 120000 index 000000000..e727ff069 --- /dev/null +++ b/elasticsearch/maintainer.md @@ -0,0 +1 @@ +../.common-templates/maintainer-community.md \ No newline at end of file