Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
D
docker-elk
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
JIRA
JIRA
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
段孔乐
docker-elk
Commits
fbe0fa29
Unverified
Commit
fbe0fa29
authored
Aug 20, 2020
by
BubbaJames
Committed by
GitHub
Aug 20, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Replace block quotes with emphasis; bold warnings, italic info (#524)
Co-authored-by:
Antoine Cotten
<
hello@acotten.com
>
parent
c0dcc248
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
26 additions
and
25 deletions
+26
-25
README.md
README.md
+26
-25
No files found.
README.md
View file @
fbe0fa29
...
@@ -9,9 +9,9 @@ Run the latest version of the [Elastic stack][elk-stack] with Docker and Docker
...
@@ -9,9 +9,9 @@ Run the latest version of the [Elastic stack][elk-stack] with Docker and Docker
It gives you the ability to analyze any data set by using the searching/aggregation capabilities of Elasticsearch and
It gives you the ability to analyze any data set by using the searching/aggregation capabilities of Elasticsearch and
the visualization power of Kibana.
the visualization power of Kibana.
>
:information_source: The Docker images backing this stack include [Stack Features][stack-features] (formerly X-Pack)
*
:information_source: The Docker images backing this stack include
[
Stack Features
][
stack-features
]
(formerly X-Pack)
with
[
paid features
][
paid-features
]
enabled by default (see
[
How to disable paid
with
[
paid features
][
paid-features
]
enabled by default (see
[
How to disable paid
features
](
#how-to-disable-paid-features
)
features](#how-to-disable-paid-features) to disable them). The
[
trial license
][
trial-license
]
is valid for 30 days.
to disable them).
**The [trial license][trial-license] is valid for 30 days**
.
*
Based on the official Docker images from Elastic:
Based on the official Docker images from Elastic:
...
@@ -63,8 +63,8 @@ Other available stack variants:
...
@@ -63,8 +63,8 @@ Other available stack variants:
*
[
Docker Compose
](
https://docs.docker.com/compose/install/
)
version
**1.20.0**
or newer
*
[
Docker Compose
](
https://docs.docker.com/compose/install/
)
version
**1.20.0**
or newer
*
1.5 GB of RAM
*
1.5 GB of RAM
>
:information_source: Especially on Linux, make sure your user has the [required permissions][linux-postinstall] to
*
:information_source: Especially on Linux, make sure your user has the
[
required permissions
][
linux-postinstall
]
to
> interact with the Docker daemon.
interact with the Docker daemon.
*
By default, the stack exposes the following ports:
By default, the stack exposes the following ports:
*
5000: Logstash TCP input
*
5000: Logstash TCP input
...
@@ -72,9 +72,9 @@ By default, the stack exposes the following ports:
...
@@ -72,9 +72,9 @@ By default, the stack exposes the following ports:
*
9300: Elasticsearch TCP transport
*
9300: Elasticsearch TCP transport
*
5601: Kibana
*
5601: Kibana
>
:warning: Elasticsearch's [bootstrap checks][booststap-checks] were purposely disabled to facilitate the setup of the
**
:warning: Elasticsearch's
[
bootstrap checks
][
booststap-checks
]
were purposely disabled to facilitate the setup of the
>
Elastic stack in development environments. For production setups, we recommend users to set up their host according to
Elastic stack in development environments. For production setups, we recommend users to set up their host according to
> the instructions from the Elasticsearch documentation: [Important System Configuration][es-sys-config].
the instructions from the Elasticsearch documentation:
[
Important System Configuration
][
es-sys-config
]
.
**
### SELinux
### SELinux
...
@@ -108,8 +108,8 @@ current major version (7.x).
...
@@ -108,8 +108,8 @@ current major version (7.x).
To use a different version of the core Elastic components, simply change the version number inside the
`.env`
file. If
To use a different version of the core Elastic components, simply change the version number inside the
`.env`
file. If
you are upgrading an existing stack, please carefully read the note in the next section.
you are upgrading an existing stack, please carefully read the note in the next section.
>
:warning: Always pay attention to the [official upgrade instructions][upgrade] for each individual component before
**
:warning: Always pay attention to the
[
official upgrade instructions
][
upgrade
]
for each individual component before
performing a stack upgrade.
performing a stack upgrade.
**
Older major versions are also supported on separate branches:
Older major versions are also supported on separate branches:
...
@@ -126,8 +126,8 @@ $ docker-compose up
...
@@ -126,8 +126,8 @@ $ docker-compose up
You can also run all services in the background (detached mode) by adding the
`-d`
flag to the above command.
You can also run all services in the background (detached mode) by adding the
`-d`
flag to the above command.
>
:warning: You must rebuild the stack images with `docker-compose build` whenever you switch branch or update the
**
:warning: You must rebuild the stack images with
`docker-compose build`
whenever you switch branch or update the
> version of an already existing stack.
version of an already existing stack.
**
If you are starting the stack for the very first time, please read the section below attentively.
If you are starting the stack for the very first time, please read the section below attentively.
...
@@ -145,7 +145,7 @@ $ docker-compose down -v
...
@@ -145,7 +145,7 @@ $ docker-compose down -v
### Setting up user authentication
### Setting up user authentication
> :information_source: Refer to [How to disable paid features](#how-to-disable-paid-features) to disable authentication.
*:information_source: Refer to [How to disable paid features](#how-to-disable-paid-features) to disable authentication.*
The stack is pre-configured with the following
**privileged**
bootstrap user:
The stack is pre-configured with the following
**privileged**
bootstrap user:
...
@@ -176,9 +176,9 @@ Use the `kibana_system` user (`kibana` for releases <7.8.0) inside the Kibana co
...
@@ -176,9 +176,9 @@ Use the `kibana_system` user (`kibana` for releases <7.8.0) inside the Kibana co
Replace the password for the
`elastic`
user inside the Logstash pipeline file (
`logstash/pipeline/logstash.conf`
).
Replace the password for the
`elastic`
user inside the Logstash pipeline file (
`logstash/pipeline/logstash.conf`
).
> :information_source: Do not use the `logstash_system` user inside the Logstash *pipeline
* file, it does not have
*:information_source: Do not use the `logstash_system` user inside the Logstash **pipeline*
*
file, it does not have
>
sufficient permissions to create indices. Follow the instructions at [Configuring Security in Logstash][ls-security]
sufficient permissions to create indices. Follow the instructions at
[
Configuring Security in Logstash
][
ls-security
]
> to create a user with suitable roles.
to create a user with suitable roles.
*
See also the
[
Configuration
](
#configuration
)
section below.
See also the
[
Configuration
](
#configuration
)
section below.
...
@@ -188,8 +188,8 @@ See also the [Configuration](#configuration) section below.
...
@@ -188,8 +188,8 @@ See also the [Configuration](#configuration) section below.
$
docker-compose restart kibana logstash
$
docker-compose restart kibana logstash
```
```
>
:information_source: Learn more about the security of the Elastic stack at [Tutorial: Getting started with
*
:information_source: Learn more about the security of the Elastic stack at
[
Tutorial: Getting started with
> security][sec-tutorial].
security]
[
sec-tutorial
]
.
*
### Injecting data
### Injecting data
...
@@ -221,8 +221,8 @@ When Kibana launches for the first time, it is not configured with any index pat
...
@@ -221,8 +221,8 @@ When Kibana launches for the first time, it is not configured with any index pat
#### Via the Kibana web UI
#### Via the Kibana web UI
>
:information_source: You need to inject data into Logstash before being able to configure a Logstash index pattern via
*
:information_source: You need to inject data into Logstash before being able to configure a Logstash index pattern via
the Kibana web UI.
the Kibana web UI.
*
Navigate to the _Discover_ view of Kibana from the left sidebar. You will be prompted to create an index pattern. Enter
Navigate to the _Discover_ view of Kibana from the left sidebar. You will be prompted to create an index pattern. Enter
`logstash-*`
to match Logstash indices then, on the next page, select
`@timestamp`
as the time filter field. Finally,
`logstash-*`
to match Logstash indices then, on the next page, select
`@timestamp`
as the time filter field. Finally,
...
@@ -243,12 +243,13 @@ $ curl -XPOST -D- 'http://localhost:5601/api/saved_objects/index-pattern' \
...
@@ -243,12 +243,13 @@ $ curl -XPOST -D- 'http://localhost:5601/api/saved_objects/index-pattern' \
-d
'{"attributes":{"title":"logstash-*","timeFieldName":"@timestamp"}}'
-d
'{"attributes":{"title":"logstash-*","timeFieldName":"@timestamp"}}'
```
```
The created pattern will automatically be marked as the default index pattern as soon as the Kibana UI is opened for the first time.
The created pattern will automatically be marked as the default index pattern as soon as the Kibana UI is opened for the
first time.
## Configuration
## Configuration
>
:information_source: Configuration is not dynamically reloaded, you will need to restart individual components after
*
:information_source: Configuration is not dynamically reloaded, you will need to restart individual components after
any configuration change.
any configuration change.
*
### How to configure Elasticsearch
### How to configure Elasticsearch
...
@@ -382,8 +383,8 @@ If all components get deployed without any error, the following command will sho
...
@@ -382,8 +383,8 @@ If all components get deployed without any error, the following command will sho
$
docker stack services elk
$
docker stack services elk
```
```
>
:information_source: To scale Elasticsearch in Swarm mode, configure *zen* to use the DNS name `tasks.elasticsearch`
*
:information_source: To scale Elasticsearch in Swarm mode, configure *
zen
*
to use the DNS name
`tasks.elasticsearch`
instead of
`elasticsearch`
.
instead of
`elasticsearch`
.
*
[
elk-stack
]:
https://www.elastic.co/elk-stack
[
elk-stack
]:
https://www.elastic.co/elk-stack
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment