Skip to content

Commit

Permalink
Add Docker docs for Auditbeat (elastic#5619)
Browse files Browse the repository at this point in the history
* Add Docker docs for Auditbeat

Closes elastic#5132
  • Loading branch information
ninaspitfire authored and andrewkroh committed Nov 17, 2017
1 parent 75ad4f6 commit 0d376ab
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 3 deletions.
20 changes: 18 additions & 2 deletions auditbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,24 @@ tar xzvf {beatname_lc}-{version}-darwin-x86_64.tar.gz

endif::[]

[[docker]]
*docker:*

ifeval::["{release-state}"=="unreleased"]

Version {stack-version} of {beatname_uc} has not yet been released.

endif::[]

ifeval::["{release-state}"!="unreleased"]

["source", "shell", subs="attributes"]
------------------------------------------------
docker pull {dockerimage}
------------------------------------------------

endif::[]

[[win]]
*win:*

Expand Down Expand Up @@ -278,5 +296,3 @@ The dashboards are provided as examples. We recommend that you
{kibana-ref}/dashboard.html[customize] them to meet your needs.

image:./images/auditbeat-file-integrity-dashboard.png[Auditbeat File Integrity Dashboard]


15 changes: 15 additions & 0 deletions auditbeat/docs/running-on-docker.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
include::../../libbeat/docs/shared-docker.asciidoc[]

[float]
==== Special requirements

Under Docker, {beatname_uc} runs as a non-root user, but requires some privileged
capabilities to operate correctly. Ensure that the +AUDIT_CONTROL+ and +AUDIT_READ+
capabilities are available to the container.

It is also essential to run {beatname_uc} in the host PID namespace.

["source","sh",subs="attributes"]
----
docker run --cap-add=AUDIT_CONTROL,AUDIT_READ --pid=host {dockerimage}
----
7 changes: 6 additions & 1 deletion auditbeat/docs/setting-up-running.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,13 @@ This section includes additional information on how to set up and run

* <<command-line-options>>

//MAINTAINERS: If you add a new file to this section, make sure you update the bulletedl ist ^^ too.
* <<running-on-docker>>


//MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too.

include::../../libbeat/docs/shared-directory-layout.asciidoc[]

include::../../libbeat/docs/command-reference.asciidoc[]

include::./running-on-docker.asciidoc[]

0 comments on commit 0d376ab

Please sign in to comment.