Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for Docker images #4312

Merged
merged 1 commit into from May 23, 2017

Conversation

Projects
None yet
4 participants
@jarpy
Copy link
Contributor

jarpy commented May 15, 2017

  • 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).
@dedemorton
Copy link
Contributor

dedemorton left a comment

LGTM (just one minor comment). Thanks so much for the refactoring!

code can be found on
https://github.com/elastic/beats-docker/tree/{doc-branch}[GitHub].

=== Configuring {beatname_uc} on Docker

This comment has been minimized.

Copy link
@dedemorton

dedemorton May 15, 2017

Contributor

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.

This comment has been minimized.

Copy link
@jarpy

jarpy May 16, 2017

Author Contributor

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

@dliappis
Copy link

dliappis left a comment

I added a few comments for the non linux platforms, apart from those this LGTM!


endif::[]

The base image is https://hub.docker.com/_/centos/[Centos 7] and the source

This comment has been minimized.

Copy link
@dliappis

dliappis May 16, 2017

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.

This comment has been minimized.

Copy link
@dliappis

dliappis May 16, 2017

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

This comment has been minimized.

Copy link
@dliappis

dliappis May 16, 2017

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.

@jarpy

This comment has been minimized.

Copy link
Contributor Author

jarpy commented May 17, 2017

Thanks, @dliappis. Added your suggestions.

@jarpy

This comment has been minimized.

Copy link
Contributor Author

jarpy commented May 22, 2017

OK to merge this now, @ruflin?

@ruflin

This comment has been minimized.

Copy link
Collaborator

ruflin commented May 22, 2017

Happy to merge if @dliappis gives a 👍

@ruflin

This comment has been minimized.

Copy link
Collaborator

ruflin commented May 22, 2017

jenkins, retest it

@ruflin

ruflin approved these changes May 22, 2017

@dliappis

This comment has been minimized.

Copy link

dliappis commented May 23, 2017

LGTM from me as well

@ruflin ruflin merged commit 8915c16 into elastic:master May 23, 2017

6 of 7 checks passed

beats-ci Build finished.
Details
CLA Commit author is a member of Elasticsearch
Details
codecov/patch Coverage not affected when comparing a09c903...cb1b4e9
Details
codecov/project 63.41% (+0.03%) compared to a09c903
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
default Build finished.
Details
@ruflin

This comment has been minimized.

Copy link
Collaborator

ruflin commented May 23, 2017

@dedemorton Can you take care of the backporting in case we backport this?

@dedemorton

This comment has been minimized.

Copy link
Contributor

dedemorton commented May 23, 2017

@ruflin Sure. I just need to backport this to 5.4 right?

@jarpy

This comment has been minimized.

Copy link
Contributor Author

jarpy commented May 25, 2017

@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 added a commit that referenced this pull request Jun 6, 2017

dedemorton added a commit to dedemorton/beats that referenced this pull request Jun 16, 2017

dedemorton added a commit that referenced this pull request Jun 21, 2017

ramon-garcia added a commit to ramon-garcia/beats that referenced this pull request Dec 5, 2017

athom added a commit to athom/beats that referenced this pull request Jan 25, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.