Skip to content

Commit b4b0ad5

Browse files
committed
Update Kibana docs
1 parent 7df9e7d commit b4b0ad5

12 files changed

+49
-74
lines changed

elasticsearch/content.md

+15-42
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,39 @@
11
# What is Elasticsearch?
22

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.
3+
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.
64

75
> [wikipedia.org/wiki/Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch)
86
97
%%LOGO%%
108

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:
9+
# About This Image
2810

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)
11+
This default distribution is governed by the Elastic License, and includes the [full set of free features](https://www.elastic.co/subscriptions).
3112

32-
This [comment in elastic/elasticsearch#4978](https://github.com/elastic/elasticsearch/issues/4978#issuecomment-258676104) shows why this change was added in upstream.
13+
View the detailed release notes [here](https://www.elastic.co/guide/en/elasticsearch/reference/6.4/release-notes-6.4.1.html).
3314

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.
15+
Not the version you're looking for? View all supported [past releases](https://www.docker.elastic.co).
3516

36-
## Running Containers
17+
# How to use this image
3718

38-
You can run the default `elasticsearch` command simply:
19+
**Note:** Pulling an images requires using a specific version number tag. The `latest` tag is not supported.
3920

40-
```console
41-
$ docker run -d elasticsearch
42-
```
21+
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/).
4322

44-
You can also pass in additional flags to `elasticsearch`:
23+
For full Elasticsearch documentation see [here](https://www.elastic.co/guide/en/elasticsearch/reference/6.4/index.html).
4524

46-
```console
47-
$ docker run -d elasticsearch -Des.node.name="TestNode"
48-
```
25+
**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).**
4926

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`:
27+
## Running in Development Mode
5128

5229
```console
53-
$ docker run -d -v "$PWD/config":/usr/share/elasticsearch/config elasticsearch
30+
$ docker pull elasticsearch:tag
5431
```
5532

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-
5833
```console
59-
$ docker run -d -v "$PWD/esdata":/usr/share/elasticsearch/data elasticsearch
34+
$ docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" elasticsearch:tag
6035
```
36+
## Running in Production Mode
6137

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%%
38+
See [Install Elasticsearch with Docker](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/docker.html)
6539

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

-3
This file was deleted.

elasticsearch/github-repo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
https://github.com/docker-library/elasticsearch
1+
https://github.com/elastic/elasticsearch

elasticsearch/license.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
View [license information](https://github.com/elasticsearch/elasticsearch/blob/66b5ed86f7adede8102cd4d979b9f4924e5bd837/LICENSE.txt) for the software contained in this image.
1+
View [license information](https://github.com/elastic/elasticsearch/blob/6.4/licenses/ELASTIC-LICENSE.txt) for the software contained in this image.

elasticsearch/maintainer.md

-1
This file was deleted.

elasticsearch/maintainer.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[the Elastic Product Team](%%GITHUB-REPO%%)

kibana/content.md

+24-20
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,45 @@
11
# What is Kibana?
22

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.
3+
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.
44

5-
Kibana is a registered trademark of Elasticsearch BV.
6-
7-
> [wikipedia.org/wiki/Kibana](https://en.wikipedia.org/wiki/Kibana)
5+
> For more information about Kibana, please visit [www.elastic.co/products/kibana](https://www.elastic.co/products/kibana)
86
97
%%LOGO%%
108

9+
# About This Image
10+
11+
This default distribution is governed by the Elastic License, and includes the [full set of free features](https://www.elastic.co/subscriptions).
12+
13+
View the detailed release notes [here](https://www.elastic.co/guide/en/kibana/current/release-notes.html).
14+
15+
Not the version you're looking for? View all supported [past releases](https://www.docker.elastic.co).
16+
1117
# How to use this image
1218

13-
You can run the default `%%REPO%%` command simply:
19+
**Note:** Pulling an images requires using a specific version number tag. The `latest` tag is not supported.
1420

15-
```console
16-
$ docker run --link some-elasticsearch:elasticsearch -d %%REPO%%
17-
```
21+
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/).
1822

19-
You can also pass in additional flags to `%%REPO%%`:
23+
For full Kibana documentation see [here](https://www.elastic.co/guide/en/kibana/index.html).
2024

21-
```console
22-
$ docker run --link some-elasticsearch:elasticsearch -d %%REPO%% --plugins /somewhere/else
23-
```
25+
## Running in Development Mode
2426

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:
27+
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:
2628

2729
```console
28-
$ docker run --name some-%%REPO%% --link some-elasticsearch:elasticsearch -p 5601:5601 -d %%REPO%%
29-
```
30+
$ docker network create somenetwork
31+
```
32+
*Note: In this example, Kibana is using the default configuration and expects to connect to a running Elasticsearch instance at http://localhost:9200*
3033

31-
You can also provide the address of elasticsearch via `ELASTICSEARCH_URL` environnement variable:
34+
Run Kibana
3235

3336
```console
34-
$ docker run --name some-kibana -e ELASTICSEARCH_URL=http://some-elasticsearch:9200 -p 5601:5601 -d kibana
37+
$ docker run -d --name kibana --net somenetwork -p 5601:5601 kibana:tag
3538
```
3639

37-
Then, access it via `http://localhost:5601` or `http://host-ip:5601` in a browser.
40+
Kibana can be accessed by browser via `http://localhost:5601` or `http://host-ip:5601`
41+
3842

39-
## %%STACK%%
43+
## Running in Production Mode
4044

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).
45+
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)

kibana/deprecated.md

-3
This file was deleted.

kibana/get-help.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
the [Kibana Discuss Forums](https://discuss.elastic.co/c/kibana), the [Elastic community](https://www.elastic.co/community)

kibana/github-repo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
https://github.com/docker-library/kibana
1+
https://github.com/elastic/kibana-docker

kibana/issues.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
For issues with the Kibana Docker image: %%GITHUB-REPO%%/issues
2+
3+
For issues with Kibana: [https://github.com/elastic/kibana/issues](https://github.com/elastic/kibana/issues)

kibana/license.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
View [license information](https://github.com/elastic/kibana/blob/4557a6fc0ba08c5e7ac813a180179e5e2631c90a/LICENSE.md) for the software contained in this image.
1+
View [license information](https://github.com/elastic/kibana/blob/master/licenses/ELASTIC-LICENSE.txt) for the software contained in this image.

kibana/maintainer.md

-1
This file was deleted.

kibana/maintainer.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[the Elastic Team](%%GITHUB-REPO%%)

0 commit comments

Comments
 (0)