[Docs] Adds Beats central management docs (#26061) (#26502)

This commit is contained in:
DeDe Morton 2018-12-06 12:45:03 -08:00 committed by GitHub
parent 40f0a846f7
commit 8939f68b97
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 82 additions and 0 deletions

View file

@ -28,3 +28,5 @@ include::management/managing-indices.asciidoc[]
include::management/advanced-options.asciidoc[]
include::management/managing-saved-objects.asciidoc[]
include::management/managing-beats.asciidoc[]

View file

@ -0,0 +1,80 @@
[[managing-beats]]
== Managing {beats}
Use the Central Management UI under *Management > {beats}* to define and
manage configurations in a central location in {kib} and quickly deploy
configuration changes to all {beats} running across your enterprise. For more
about central management, see the related {beats} documentation:
* {filebeat-ref}/configuration-central-management.html[{filebeat} documentation]
* {metricbeat-ref}/configuration-central-management.html[{metricbeat} documentation]
[NOTE]
====
This feature requires an Elastic license that includes {beats} central
management.
Don't have a license? You can start a 30-day trial. In {kib}, go to
*Management > License Management*. At the end of the trial
period, you can purchase a subscription to keep using central management. For
more information, see https://www.elastic.co/subscriptions and
{stack-ov}/license-management.html[License Management].
====
{kib} makes it easy for you to use central management by walking you through the
enrollment and configuration process step by step the first time you use the
Central Management UI.
[float]
=== Enroll {beats}
You need to enroll {beats} to register them in central management and establish
trust. Enrolled {beats} will have the credentials needed to retrieve
configurations from {kib}.
[float]
=== Create configuration tags
A _configuration tag_ is a group of configuration blocks that you can apply to
one or more {beats}. For example, you can create a tag called `development` to
group configurations for {beats} running in your development environment.
The first time you walk through the enrollment process, you'll create a
configuration tag that's applied to the {beats} instance you're enrolling.
After that, under *Configuration tags*, you can create additional tags and
apply them to any enrolled {beats}, and the {beats} will use the configurations
defined in the tag.
[float]
=== Add configuration blocks
Add one or more configuration blocks to the tag. A tag can have configuration
blocks for different types of {beats}. When the enrolled {beats} run, they will
use the configuration blocks that are valid for their type.
[float]
=== Manage enrolled {beats}
Under *Enrolled {beats}*, you can view the list of enrolled {beats} to see
details, including the type, applied tags, configuration status, and the last
configuration update. Click the *Beat name* or *Type* column heading to sort the
list. To filter the list, enter a search string. If there are errors in a
configuration, youll see an Error status in the Central Management UI and need
to look at {beats} logs to troubleshoot the problem.
You can add or remove tags, and the configuration changes are automatically
deployed to all {beats} that have the tag. Avoid applying tags with conflicting
configurations. Because the configurations for all assigned tags are merged,
conflicting configurations result in errors.
You can unenroll {beats} to remove them from central management.
[float]
=== Manage tags
Under *Configuration tags*, you can select tags and delete them, or you can
drill down into a tag to add, modify, or remove configuration blocks from the
tag. When you change the configuration blocks or remove tags, the configuration
changes are automatically deployed to all {beats} that have the tag.