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

[docs] Streamline beats getting started guides #17007

Merged
merged 42 commits into from
Jun 18, 2020
Merged
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
9fca58e
Move detail out of getting started guides
dedemorton Mar 14, 2020
78d1868
Changes in progress
dedemorton May 7, 2020
d5edbef
Add widgets
dedemorton May 8, 2020
98871be
Change tag width to 100%
dedemorton May 9, 2020
5c8b18f
remove unused css and red border
bmorelli25 May 11, 2020
aa992f2
breathing room below tab content
bmorelli25 May 11, 2020
ec5ae26
Remove inexplicable tab
dedemorton May 11, 2020
f13e935
Clean up wording
dedemorton May 12, 2020
46bf73c
Cleanup the getting started and move some stuff
dedemorton May 13, 2020
70023ad
Git auditbeat building
dedemorton May 14, 2020
352f9aa
Get all books building
dedemorton May 14, 2020
40c97db
More small changes
dedemorton May 14, 2020
5eac1e8
Fix build errors
dedemorton May 15, 2020
e48e739
Finish adding widgets and cleaning up gs guides
dedemorton May 16, 2020
7773f42
Fix widget filenames
dedemorton May 18, 2020
cde03dd
More cleanup work
dedemorton May 22, 2020
08c7af0
Add keystore tip to cloud example
dedemorton May 27, 2020
7cf5981
Another round of improvements
dedemorton May 28, 2020
58ada33
Delete redundant files
dedemorton May 28, 2020
09a5230
Replace dashboards in quick start topics
dedemorton May 29, 2020
16801a9
Change short titles for quick start guides
dedemorton May 29, 2020
59e2031
Make shared what's next list easier to include
dedemorton May 29, 2020
75b1f34
Remove modules quick start
dedemorton May 29, 2020
c8821a8
More cleanup
dedemorton May 30, 2020
56e06a9
Remove redundant files
dedemorton May 30, 2020
42e3281
Remove Logstash from the Winlogbeat quick start
dedemorton May 30, 2020
b7dcbbc
Remove old comments
dedemorton May 30, 2020
7e7f1d8
More cleanup work
dedemorton May 31, 2020
aee466d
Delete unused graphics
dedemorton May 31, 2020
4a8a003
Use correct spelling for GitHub
dedemorton Jun 4, 2020
6c7ffb6
Add formatting
dedemorton Jun 4, 2020
6514c40
Use correct capitalization for GitHub
dedemorton Jun 4, 2020
f003270
Use time filter instead of date range
dedemorton Jun 4, 2020
2e9f4ba
Change wording of headings as suggested during review
dedemorton Jun 6, 2020
be2a844
Add more fixes from the review
dedemorton Jun 16, 2020
e420b1d
Synchronize widget tab selection and fix bugs
dedemorton Jun 17, 2020
2227dcd
Include javascript only once in a file
dedemorton Jun 17, 2020
a7a2238
Add script and stylesheet to support tabbed panel
dedemorton Jun 18, 2020
cb7a36d
Fix step numbering
dedemorton Jun 18, 2020
be0b7e1
Include code for displaying tabbed panel
dedemorton Jun 18, 2020
0827608
Add javascript and css for tabbed panel
dedemorton Jun 18, 2020
c8d9c7d
Fix code include
dedemorton Jun 18, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
More cleanup work
dedemorton committed May 31, 2020
commit 7e7f1d87a27b5e314f3617727bba717f7483b6f4
9 changes: 4 additions & 5 deletions auditbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -88,8 +88,8 @@ include::{libbeat-dir}/shared/config-check.asciidoc[]
{beatname_uc} comes with predefined assets for parsing, indexing, and
visualizing your data. To load these assets:

. Make sure the user specified in +{beatname_lc}.yml+ has the
<<privileges-to-setup-beats,privileges needed to set up {beatname_uc}>>.
. Make sure the user specified in +{beatname_lc}.yml+ is
<<privileges-to-setup-beats,authorized to set up {beatname_uc}>>.

. From the installation directory, run:
+
@@ -114,9 +114,8 @@ environment. If you're using a different output, such as {ls}, see
=== Step 5: Start {beatname_uc}

Before starting {beatname_uc}, modify the user credentials in
+{beatname_lc}.yml+ and specify a user who has restricted privileges,
especially if you're running {beatname_uc} in a production environment.
For more information, see <<privileges-to-publish-events>>.
+{beatname_lc}.yml+ and specify a user who is
<<privileges-to-publish-events,authorized to publish events>>.

To start {beatname_uc}, run:

2 changes: 1 addition & 1 deletion auditbeat/docs/setting-up-running.asciidoc
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@
<titleabbrev>Set up and run</titleabbrev>
++++

Before reading this section, see the
Before reading this section, see
<<{beatname_lc}-installation-configuration>> for basic
installation instructions to get you started.

2 changes: 1 addition & 1 deletion auditbeat/docs/upgrading.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[upgrading-auditbeat]]
== Upgrade Auditbeat

For information about upgrading to a new version, see the following topics:
For information about upgrading to a new version, see:

* {beats-ref}/breaking-changes.html[Breaking Changes]
* {beats-ref}/upgrading.html[Upgrade]
Empty file removed connecting-to-es.asciidoc
Empty file.
30 changes: 16 additions & 14 deletions filebeat/docs/filebeat-modules-options.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:modulename: system nginx mysql

[id="configuration-{beatname_lc}-modules"]
== Configure modules

@@ -11,7 +13,7 @@ NOTE: Using {beatname_uc} modules is optional. You may decide to
<<configuration-{beatname_lc}-options,configure inputs manually>> if you're using
a log type that isn't supported, or you want to use a different setup.

{beatname_uc} <<{beatname_lc}-modules,modules>> provide a quick way for you to
{beatname_uc} <<{beatname_lc}-modules,modules>> provide a quick way to
get started processing common log formats. They contain default configurations,
{es} ingest node pipeline definitions, and {kib} dashboards to help you
implement and deploy a log monitoring solution.
@@ -23,13 +25,16 @@ Before running {beatname_uc} with modules enabled, make sure you also set up the
environment to use {kib} dashboards. See
<<{beatname_lc}-installation-configuration>> for more information.

include::{libbeat-dir}/shared-note-file-permissions.asciidoc[]

[float]
[[configure-modules-d-configs]]
=== Configure modules in the `modules.d` directory

The `modules.d` directory contains default configurations for all the modules
available in {beatname_uc}. To enable or disable specific module configurations under `modules.d`, run the
<<modules-command,`modules enable` or `modules disable`>> commands. For example:
available in {beatname_uc}. To enable or disable specific module configurations
under `modules.d`, run the
<<modules-command,`modules enable` or `modules disable`>> command. For example:

include::{libbeat-dir}/tab-widgets/enable-modules-widget.asciidoc[]

@@ -38,10 +43,10 @@ your OS and that the behavior of the module is appropriate for your environment.
To change the default behavior, configure variable settings. For a list of
available settings, see the documentation under <<{beatname_lc}-modules>>.

For advanced use cases, you can also override input settings. See
<<advanced-settings>>.
For advanced use cases, you can also
<<advanced-settings,override input settings>>.

TIP: You can also enable modules at runtime by using the
TIP: You can enable modules at runtime by using the
<<{beatname_lc}-modules,--modules flag>>. This is useful if you're getting started
and want to try things out. Any modules specified at the command line are loaded
along with any modules that are enabled in the configuration file or `modules.d`
@@ -54,7 +59,7 @@ line is used.

[float]
[[configure-modules-config-file]]
=== Configure modules in the configuration file
=== Configure modules in the +{beatname_lc}.yml+ file

When possible, you should use the config files in the `modules.d` directory.

@@ -65,12 +70,12 @@ directory. You can continue to configure modules in the +{beatname_lc}.yml+
file, but you won't be able to use the `modules` command to enable and disable
configurations because the command requires the `modules.d` layout.

To enable specific modules in the +{beatname_lc}.yml+ config file, you can add
To enable specific modules in the +{beatname_lc}.yml+ config file, add
entries to the +{beatname_lc}.modules+ list. Each entry in the list begins with
a dash (-) and is followed by settings for that module.

The following example shows a configuration that runs the `nginx`,`mysql`, and
`system` modules.
`system` modules:

["source","yaml",subs="attributes"]
----
@@ -80,11 +85,6 @@ The following example shows a configuration that runs the `nginx`,`mysql`, and
- module: system
----

The default module configurations assume that the logs you’re harvesting are
in the location expected for your OS and that the behavior of the module is
appropriate for your environment. To change the default configurations, you need
to set variables in module configuration.

// REVIEWERS: Deleting the section about configuring variable settings because
// it doesn't really add much value to users who are looking at the module
// config docs. It's just an extra hop.
@@ -127,3 +127,5 @@ You can also enable `close_eof` for all inputs created by any of the modules:
----------------------------------------------------------------------
-M "*.*.input.close_eof=true"
----------------------------------------------------------------------

:modulename!:
11 changes: 6 additions & 5 deletions filebeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -111,8 +111,8 @@ include::{libbeat-dir}/shared/config-check.asciidoc[]
{beatname_uc} comes with predefined assets for parsing, indexing, and
visualizing your data. To load these assets:

. Make sure the user specified in +{beatname_lc}.yml+ has the
<<privileges-to-setup-beats,privileges needed to set up {beatname_uc}>>.
. Make sure the user specified in +{beatname_lc}.yml+ is
<<privileges-to-setup-beats,authorized to set up {beatname_uc}>>.

. From the installation directory, run:
+
@@ -144,9 +144,8 @@ environment. If you're using a different output, such as {ls}, see:
=== Step 5: Start {beatname_uc}

Before starting {beatname_uc}, modify the user credentials in
+{beatname_lc}.yml+ and specify a user who has restricted privileges,
especially if you're running {beatname_uc} in a production environment.
For more information, see <<privileges-to-publish-events>>.
+{beatname_lc}.yml+ and specify a user who is
<<privileges-to-publish-events,authorized to publish events>>.

To start {beatname_uc}, run:

@@ -173,3 +172,5 @@ Now that you have your logs streaming into {es}, learn how to unify your logs,
metrics, uptime, and application performance data.

include::{libbeat-dir}/shared/obs-apps.asciidoc[]

:modulename!:
8 changes: 6 additions & 2 deletions filebeat/docs/howto/override-config-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
[id="override-{beatname_lc}-config-settings"]
== Override configuration settings at the command line

++++
<titleabbrev>Override configuration settings</titleabbrev>
++++

//TODO: Convert this topic to use platform tabs.

// REVEWERS: This is a mix of new and old content. Please review.
@@ -21,7 +25,7 @@ changed.

[float]
[[example-override-config]]
=== Example: override configuration in +{beatname_lc}.yml+
=== Example: override configuration file settings

The following configuration sends logging output to files:

@@ -46,7 +50,7 @@ of a file, use the `-E` flag when you run {beatname_uc}:

[float]
[[example-override-module-setting]]
=== Example: override `var.paths` module setting
=== Example: override module settings

The following configuration sets the path to Nginx access logs:

6 changes: 0 additions & 6 deletions filebeat/docs/modules-overview.asciidoc
Original file line number Diff line number Diff line change
@@ -32,10 +32,4 @@ and loads them to the respective {stack} components.
To learn how to configure and run {beatname_uc} modules:

* Get started by reading <<{beatname_lc}-installation-configuration>>.
//* Learn about the different ways to enable modules in
//<<configuration-filebeat-modules>>.
* Dive into the documentation for each <<filebeat-modules,module>>.

// REVIEWERS: I'm commenting out the second item ^^ because I think we confuse
// users by describing all the ways to configure modules. At the very least, we
// shouldn't be pointing users to this confusing subject. WDYT?
2 changes: 1 addition & 1 deletion filebeat/docs/setting-up-running.asciidoc
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@
<titleabbrev>Set up and run</titleabbrev>
++++

Before reading this section, see the
Before reading this section, see
<<{beatname_lc}-installation-configuration>> for basic
installation instructions to get you started.

2 changes: 1 addition & 1 deletion filebeat/docs/upgrading.asciidoc
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@
<titleabbrev>Upgrade</titleabbrev>
++++

For information about upgrading to a new version, see the following topics:
For information about upgrading to a new version, see:

* {beats-ref}/breaking-changes.html[Breaking Changes]
* {beats-ref}/upgrading.html[Upgrade]
9 changes: 4 additions & 5 deletions heartbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -97,8 +97,8 @@ include::{libbeat-dir}/shared/config-check.asciidoc[]
{beatname_uc} comes with predefined assets for parsing, indexing, and
visualizing your data. To load these assets:

. Make sure the user specified in +{beatname_lc}.yml+ has the
<<privileges-to-setup-beats,privileges needed to set up {beatname_uc}>>.
. Make sure the user specified in +{beatname_lc}.yml+ is
<<privileges-to-setup-beats,authorized to set up {beatname_uc}>>.

. From the installation directory, run:
+
@@ -125,9 +125,8 @@ environment. If you're using a different output, such as {ls}, see
=== Step 5: Start Heartbeat

Before starting {beatname_uc}, modify the user credentials in
+{beatname_lc}.yml+ and specify a user who has restricted privileges,
especially if you're running {beatname_uc} in a production environment.
For more information, see <<privileges-to-publish-events>>.
+{beatname_lc}.yml+ and specify a user who is
<<privileges-to-publish-events,authorized to publish events>>.

To start {beatname_uc}, run:

2 changes: 1 addition & 1 deletion heartbeat/docs/setting-up-running.asciidoc
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@
<titleabbrev>Set up and run</titleabbrev>
++++

Before reading this section, see the
Before reading this section, see
<<{beatname_lc}-installation-configuration>> for basic
installation instructions to get you started.

11 changes: 5 additions & 6 deletions journalbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -55,7 +55,7 @@ Before running {beatname_uc}, specify the location of the systemd journal files
and configure how you want the files to be read. If you accept the default
configuration, {beatname_uc} reads from the local journal.

. In +beatname_lc.yml+, specify a list of paths to your systemd journal files.
. In +{beatname_lc}.yml+, specify a list of paths to your systemd journal files.
Each path can be a directory path (to collect events from all journals in a
directory), or a file path. For example:
+
@@ -101,8 +101,8 @@ include::{libbeat-dir}/shared/config-check.asciidoc[]
{beatname_uc} comes with predefined assets for parsing, indexing, and
visualizing your data. To load these assets:

. Make sure the user specified in +{beatname_lc}.yml+ has the
<<privileges-to-setup-beats,privileges needed to set up {beatname_uc}>>.
. Make sure the user specified in +{beatname_lc}.yml+ is
<<privileges-to-setup-beats,authorized to set up {beatname_uc}>>.

. From the installation directory, run:
+
@@ -126,9 +126,8 @@ environment. If you're using a different output, such as {ls}, see
=== Step 5: Start {beatname_uc}

Before starting {beatname_uc}, modify the user credentials in
+{beatname_lc}.yml+ and specify a user who has restricted privileges,
especially if you're running {beatname_uc} in a production environment.
For more information, see <<privileges-to-publish-events>>.
+{beatname_lc}.yml+ and specify a user who is
<<privileges-to-publish-events,authorized to publish events>>.

To start {beatname_uc}, run:

2 changes: 1 addition & 1 deletion journalbeat/docs/setting-up-running.asciidoc
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@
<titleabbrev>Set up and run</titleabbrev>
++++

Before reading this section, see the
Before reading this section, see
<<{beatname_lc}-installation-configuration>> for basic
installation instructions to get you started.

8 changes: 5 additions & 3 deletions libbeat/docs/howto/change-index-name.asciidoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[id="change-index-name"]
== Change the index name
ifndef::no_ilm[]

ifndef::no_ilm[]
TIP: If you're sending events to a cluster that supports index lifecycle
management, see <<ilm>> to learn how to change the index name.
endif::no_ilm[]

{beatname_uc} uses time series indices, by default, when index lifecycle
management is disabled or unsupported. The indices are named
+{beatname_lc}-{version}-yyyy.MM.dd+, where `yyyy.MM.dd` is the date when the
events were indexed. To use a different name, you set the
events were indexed. To use a different name, set the
<<index-option-es,`index`>> option in the {es} output. The value that
you specify should include the root name of the index plus version and date
information. You also need to configure the `setup.template.name` and
@@ -21,10 +21,12 @@ output.elasticsearch.index: "customname-%{[{beat_version_key}]}-%{+yyyy.MM.dd}"
setup.template.name: "customname"
setup.template.pattern: "customname-*"
-----

ifndef::no_ilm[]
WARNING: If <<ilm,index lifecycle management>> is enabled (which is typically the default), `setup.template.name` and `setup.template.pattern` are ignored.
endif::no_ilm[]

ifndef::no_dashboards[]

If you're using pre-built Kibana dashboards, also set the
`setup.dashboards.index` option. For example:

9 changes: 4 additions & 5 deletions libbeat/docs/howto/load-index-templates.asciidoc
Original file line number Diff line number Diff line change
@@ -20,8 +20,7 @@ the output is not {es} (or {ess}), you must
<<load-template-manually,load the template manually>>.
endif::[]

This page shows how to change the default template loading behavior in the
when you want to:
This page shows how to change the default template loading behavior to:

* <<load-custom-template>>
* <<overwrite-template>>
@@ -58,7 +57,7 @@ setup.template.overwrite: true

[float]
[[disable-template-loading]]
=== Disable automatic template loading
=== Disable automatic index template loading

You may want to disable automatic template loading if you're using an output
other than {es} and need to load the template manually. To disable automatic
@@ -69,8 +68,8 @@ template loading, set:
setup.template.enabled: false
-----

If you disable automatic template loading, you must
<<load-template-manually,load the template manually>>.
If you disable automatic template loading, you must load the index template
manually.

[float]
[[load-template-manually]]
2 changes: 1 addition & 1 deletion libbeat/docs/monitoring/monitoring-metricbeat.asciidoc
Original file line number Diff line number Diff line change
@@ -103,7 +103,7 @@ take the the steps required for your environment to run two instances of
{metricbeat} as a service. The steps for doing this vary by platform and are
beyond the scope of this documentation.
* If you're running the binary directly in the foreground and want to run a
separate monitoring instance, install {metricbeat}] to a different path. If
separate monitoring instance, install {metricbeat} to a different path. If
necessary, set `path.config`, `path.data`, and `path.log` to point to the
correct directories. See <<directory-layout>> for the default locations.
endif::[]
4 changes: 2 additions & 2 deletions libbeat/docs/shared/start-beat.asciidoc
Original file line number Diff line number Diff line change
@@ -6,8 +6,8 @@ Before starting {beatname_uc}:
* Follow the steps in <<{beatname_lc}-installation-configuration>> to install,
configure, and set up the {beatname_uc} environment.
* Make sure {kib} and {es} are running.
* Make sure the user specified in +{beatname_lc}.yml+ has the privileges
needed to publish events. See <<privileges-to-publish-events>>.
* Make sure the user specified in +{beatname_lc}.yml+ is
<<privileges-to-publish-events,authorized to publish events>>.

To start {beatname_uc}, run:

6 changes: 3 additions & 3 deletions libbeat/docs/tab-widgets/set-connection.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// tag::cloud[]

Specify the <<configure-cloud-id,`cloud.id`>> of your {ess}, and set
<<configure-cloud-id,`cloud.auth`>> to a user who has the credentials needed to
<<configure-cloud-id,`cloud.auth`>> to a user who is authorized to
set up {beatname_uc}. For example:

["source","yaml",subs="attributes"]
@@ -21,8 +21,8 @@ endif::[]

// tag::self-managed[]
. Set the host and port where {beatname_uc} can find the {es} installation, and
set the username and password of a user who has the credentials needed to set
up {beatname_uc}. For example:
set the username and password of a user who is authorized to set up
{beatname_uc}. For example:
+
["source","yaml",subs="attributes"]
----
Loading