Skip to content

Commit

Permalink
Update info about loading dashboards and index templates (elastic#4778)…
Browse files Browse the repository at this point in the history
… (elastic#4818)

Update Auditbeat docs with changes from testing
  • Loading branch information
dedemorton authored and andrewkroh committed Aug 2, 2017
1 parent 9ef3a77 commit 465bd0c
Show file tree
Hide file tree
Showing 48 changed files with 715 additions and 439 deletions.
6 changes: 6 additions & 0 deletions auditbeat/docs/configuring-howto.asciidoc
Expand Up @@ -23,9 +23,11 @@ The following topics describe how to configure {beatname_uc}:
* <<configuration-general-options>>
* <<{beatname_lc}-configuration-reloading>>
* <<configuring-output>>
* <<configuration-ssl>>
* <<filtering-and-enhancing-data>>
* <<configuring-ingest-node>>
* <<configuration-path>>
* <<setup-kibana-endpoint>>
* <<configuration-dashboards>>
* <<configuration-template>>
* <<configuration-logging>>
Expand All @@ -46,12 +48,16 @@ include::./reload-configuration.asciidoc[]
:allplatforms:
include::../../libbeat/docs/outputconfig.asciidoc[]

include::../../libbeat/docs/shared-ssl-config.asciidoc[]

include::./auditbeat-filtering.asciidoc[]

include::../../libbeat/docs/shared-config-ingest.asciidoc[]

include::../../libbeat/docs/shared-path-config.asciidoc[]

include::../../libbeat/docs/shared-kibana-config.asciidoc[]

include::../../libbeat/docs/setup-config.asciidoc[]

include::../../libbeat/docs/loggingconfig.asciidoc[]
Expand Down
29 changes: 29 additions & 0 deletions auditbeat/docs/faq-ulimit.asciidoc
@@ -0,0 +1,29 @@
[float]
[[ulimit]]
=== {beatname_uc} fails to watch folders because too many files are open?

Because of the way file monitoring is implemented on macOS, you may see a
warning similar to the following:

[source,shell]
----
eventreader_fsnotify.go:42: WARN [audit.file] Failed to watch /usr/bin: too many
open files (check the max number of open files allowed with 'ulimit -a')
----

To resolve this issue, run {beatname_uc} with the `ulimit` set to a larger
value, for example:

["source","sh",subs="attributes"]
----
sudo sh -c 'ulimit -n 8192 && ./{beatname_uc} -e
----

Or:

["source","sh",subs="attributes"]
----
sudo su
ulimit -n 8192
./{beatname_lc} -e
----
3 changes: 3 additions & 0 deletions auditbeat/docs/faq.asciidoc
Expand Up @@ -5,5 +5,8 @@ This section contains frequently asked questions about {beatname_uc}. Also check
out the
https://discuss.elastic.co/c/beats/{beatname_lc}[{beatname_uc} discussion forum].

include::./faq-ulimit.asciidoc[]

include::../../libbeat/docs/faq-limit-bandwidth.asciidoc[]

include::../../libbeat/docs/shared-faq.asciidoc[]
72 changes: 34 additions & 38 deletions auditbeat/docs/getting-started.asciidoc
@@ -1,8 +1,6 @@
[id="{beatname_lc}-getting-started"]
== Getting started with {beatname_uc}

//TODO: The getting started content needs to be changed to reflect changes in command-line syntax, dashboard loading, etc.

To get started with your own {beatname_uc} setup, install and configure these
related products:

Expand All @@ -19,8 +17,9 @@ install, configure, and run {beatname_uc}:
* <<{beatname_lc}-installation>>
* <<{beatname_lc}-configuration>>
* <<{beatname_lc}-template>>
* <<load-kibana-dashboards>>
* <<{beatname_lc}-starting>>
* <<{beatname_lc}-sample-dashboards>>
* <<view-kibana-dashboards>>
* <<command-line-options>>
* <<directory-layout>>

Expand Down Expand Up @@ -160,53 +159,43 @@ auditbeat.modules:
-------------------------------------
+
If you accept the default configuration without specifying additional modules,
{beatname_uc} uses a default configuration that's tailored to the operating system
where {beatname_uc} is running.
{beatname_uc} uses a configuration that's tailored to the operating system where
{beatname_uc} is running.
+
See <<configuring-howto-{beatname_lc}>> for more details about configuring modules.

. If you are sending output to Elasticsearch, set the IP address and port where
{beatname_uc} can find the Elasticsearch installation:
. If you are sending output to Elasticsearch (and not using Logstash), set the
IP address and port where {beatname_uc} can find the Elasticsearch installation:
+
[source,yaml]
----------------------------------------------------------------------
output.elasticsearch:
hosts: ["192.168.1.42:9200"]
hosts: ["127.0.0.1:9200"]
----------------------------------------------------------------------
+
If you are sending output to Logstash, see
If you are sending output to Logstash, make sure you
<<logstash-output,Configure the Logstash output>> instead.

. If you plan to use the sample Kibana dashboards provided with {beatname_uc},
configure the Kibana endpoint:
+
[source,yaml]
----------------------------------------------------------------------
setup.kibana:
host: "localhost:5601"
----------------------------------------------------------------------
+
--
Where `host` is the hostname and port of the machine where Kibana is running,
for example, `localhost:5601`.

TIP: If you specify a path after the port number, you need to include
the scheme and port: `http://localhost:5601/path`.
include::../../libbeat/docs/step-configure-kibana-endpoint.asciidoc[]

--
include::../../libbeat/docs/step-test-config.asciidoc[]

//TODO: Add link that mentions security settings and points to docs about setup.kibana for more info.

//REVIEWERS: Wondering if I should protocol, username, and password in the example. We tend to leave that out, but not sure if that's the best thing to do.
include::../../libbeat/docs/step-look-at-config.asciidoc[]

[id="{beatname_lc}-template"]
=== Step 3: Load the index template in Elasticsearch

:allplatforms:
include::../../libbeat/docs/shared-template-load.asciidoc[]

[[load-kibana-dashboards]]
=== Step 4: Set up the Kibana dashboards

:allplatforms:
include::../../libbeat/docs/dashboards.asciidoc[]

[id="{beatname_lc}-starting"]
=== Step 4: Start {beatname_uc}
=== Step 5: Start {beatname_uc}

Run {beatname_uc} by issuing the appropriate command for your platform.

Expand All @@ -218,14 +207,14 @@ start {beatname_uc} in the foreground.

["source","sh",subs="attributes"]
----------------------------------------------------------------------
sudo /etc/init.d/{beatname_lc} start
sudo service {beatname_lc} start
----------------------------------------------------------------------

*rpm:*

["source","sh",subs="attributes"]
----------------------------------------------------------------------
sudo /etc/init.d/{beatname_lc} start
sudo service {beatname_lc} start
----------------------------------------------------------------------

*mac:*
Expand All @@ -236,9 +225,13 @@ sudo chown root {beatname_lc}.yml <1>
sudo ./{beatname_lc} -e -c {beatname_lc}.yml -d "publish"
----------------------------------------------------------------------
<1> To monitor system files, you'll be running {beatname_uc} as root, so you
need to change ownership of the configuration file (see
need to change ownership of the configuration file, or run {beatname_uc} with
`-strict.perms=false` specified. See
{libbeat}/config-file-permissions.html[Config File Ownership and Permissions]
in the _Beats Platform Reference_).
in the _Beats Platform Reference_.

If you see a warning about too many open files, you need to increase the
`ulimit`. See the <<ulimit,FAQ>> for more details.

*win:*

Expand All @@ -265,15 +258,18 @@ Elasticsearch instance.
On Windows, if you don't have cURL installed, simply point your browser to the
URL.

[id="{beatname_lc}-sample-dashboards"]
=== Step 5: Load sample Kibana dashboards
[[view-kibana-dashboards]]
=== Step 6: View the sample Kibana dashboards

To make it easier for you to start auditing the activities of users and
processes on your system, we have created sample {beatname_uc} dashboards.
processes on your system, we have created example {beatname_uc} dashboards.
You loaded the dashboards earlier when you ran the `setup` command.

include::../../libbeat/docs/opendashboards.asciidoc[]

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]

:allplatforms:
include::../../libbeat/docs/dashboards.asciidoc[]

Binary file modified auditbeat/docs/images/kibana-created-indexes.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified auditbeat/docs/images/kibana-navigation-vis.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions auditbeat/docs/index.asciidoc
Expand Up @@ -2,8 +2,6 @@

include::../../libbeat/docs/version.asciidoc[]

:release-state: unreleased

:libbeat: http://www.elastic.co/guide/en/beats/libbeat/{doc-branch}
:kibana-ref: https://www.elastic.co/guide/en/kibana/{doc-branch}
:beatsdevguide: http://www.elastic.co/guide/en/beats/devguide/{doc-branch}
Expand Down
4 changes: 4 additions & 0 deletions auditbeat/docs/reload-configuration.asciidoc
Expand Up @@ -45,3 +45,7 @@ auditbeat.modules:
- /www/wordpress/wp-content
- /www/wordpress/wp-includes
------------------------------------------------------------------------------

NOTE: On systems with POSIX file permissions, all Beats configuration files are
subject to ownership and file permission checks. If you encounter config loading
errors related to file ownership, see {libbeat}/config-file-permissions.html.
6 changes: 6 additions & 0 deletions filebeat/docs/configuring-howto.asciidoc
Expand Up @@ -24,9 +24,11 @@ The following topics describe how to configure Filebeat:
* <<configuration-general-options>>
* <<filebeat-configuration-reloading>>
* <<configuring-output>>
* <<configuration-ssl>>
* <<filtering-and-enhancing-data>>
* <<configuring-ingest-node>>
* <<configuration-path>>
* <<setup-kibana-endpoint>>
* <<configuration-dashboards>>
* <<configuration-template>>
* <<configuration-logging>>
Expand All @@ -50,6 +52,8 @@ include::./reload-configuration.asciidoc[]
:allplatforms:
include::../../libbeat/docs/outputconfig.asciidoc[]

include::../../libbeat/docs/shared-ssl-config.asciidoc[]

include::./load-balancing.asciidoc[]

include::./filebeat-filtering.asciidoc[]
Expand All @@ -58,6 +62,8 @@ include::../../libbeat/docs/shared-config-ingest.asciidoc[]

include::../../libbeat/docs/shared-path-config.asciidoc[]

include::../../libbeat/docs/shared-kibana-config.asciidoc[]

include::../../libbeat/docs/setup-config.asciidoc[]

include::../../libbeat/docs/loggingconfig.asciidoc[]
Expand Down

0 comments on commit 465bd0c

Please sign in to comment.