Merge pull request #1324 from jethr0null/kibana-docs

Update Kibana docs
This commit is contained in:
Tianon Gravi 2018-10-05 10:26:37 -07:00 committed by GitHub
commit f9249c1de8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 34 additions and 29 deletions

View File

@ -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
```
You can also pass in additional flags to `%%REPO%%`:
*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
```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%%
```
## Running in Production Mode
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).
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)

View File

@ -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).

1
kibana/get-help.md Normal file
View File

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

View File

@ -1 +1 @@
https://github.com/docker-library/kibana
https://github.com/elastic/kibana-docker

3
kibana/issues.md Normal file
View File

@ -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)

View File

@ -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.

View File

@ -1 +0,0 @@
../.common-templates/maintainer-community.md

1
kibana/maintainer.md Normal file
View File

@ -0,0 +1 @@
[the Elastic Team](%%GITHUB-REPO%%)