Add docs for Docker images #4312
Conversation
ninaspitfire
commented
May 15, 2017
ninaspitfire
commented
- Add Docker image info to the Getting Started pages.
- Add/extend dedicated Docker page for each (Unix) Beat.
- Refactor some duplicated fragments into includes with attributes.
- Remove some whitespaces (sorry for the noisy diff, my editor just did this stuff).
ruflin
added
docs
needs_backport
libbeat/docs/shared-docker.asciidoc
Outdated
| code can be found on | ||
| https://github.com/elastic/beats-docker/tree/{doc-branch}[GitHub]. | ||
|
|
||
| === Configuring {beatname_uc} on Docker |
There was a problem hiding this comment.
I'd add a [float] tag to make this a sub-section of the main topic (right now, when the doc is built, it becomes a separate topic). You might need to add [float] tags to the other sub-sections in this topic. The main point is that all the content about Running on Docker should be in a single topic, IMHO.
There was a problem hiding this comment.
Thanks! I added the [float] tags; it looks much better now.
I'm glad I didn't cross a line with the refactors. I always get nervous pushing patches for new projects in new languages. :)
libbeat/docs/shared-docker.asciidoc
Outdated
|
|
||
| endif::[] | ||
|
|
||
| The base image is https://hub.docker.com/_/centos/[Centos 7] and the source |
There was a problem hiding this comment.
Use [centos:7] for consistency.
|
|
||
| [float] | ||
| [[monitoring-host]] | ||
| === Monitoring the Host Machine | ||
| When executing Metricbeat in a container, there are some important | ||
| things to be aware of if you want to monitor the host machine or other | ||
| containers. Let's walk-through some examples using Docker as our container | ||
| orchestration tool. |
There was a problem hiding this comment.
A few clarifications or warnings could be provided for Docker on Windows + Mac users where the bind mounts won't work as expected.
| isolated virtual network, with a limited view of network traffic. You may wish | ||
| to connect the container directly to the host network in order to see traffic | ||
| destined for, and originating from, the host system. With +docker run+, this can | ||
| be achieved by specifying +--network=host+. |
There was a problem hiding this comment.
Same comment here, for users on Docker for Mac+Windows have a VM layer that won't let them sniff things happening on the real host OS, unless settings have been tweaker.
|
Thanks, @dliappis. Added your suggestions. |
|
OK to merge this now, @ruflin? |
|
Happy to merge if @dliappis gives a 👍 |
|
jenkins, retest it |
|
LGTM from me as well |
|
@dedemorton Can you take care of the backporting in case we backport this? |
|
@ruflin Sure. I just need to backport this to 5.4 right? |
|
@dedemorton: yes, thanks. The images in question existed in "alpha" state earlier, but I think it's best to call 5.4 the release version, and thus only backport that far. |
dedemorton
removed
the
needs_backport
Backport: elastic#4312, elastic#4405, and elastic#4408 into 5.4
