-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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 configuration management topics to the Beats docs #9054
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 tasks
exekias
reviewed
Nov 13, 2018
|
||
// REVIEWERS: Thought it might be worth adding a container so users know that the | ||
// there is an API, but that it's not documented. I can comment this out if you | ||
// think it's a bad idea to show it here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would go for commenting it out until we actually have it
exekias
approved these changes
Nov 13, 2018
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a minor comment, OK to merge & backport as it is to get it before the release
exekias
approved these changes
Nov 13, 2018
dedemorton
added a commit
to dedemorton/beats
that referenced
this pull request
Nov 13, 2018
* Add initial skeleton for Beats Central Management docs * Add security warning * Add enrollment command details * Edits and additions * Add fixes from review plus xpack role tags
dedemorton
added a commit
that referenced
this pull request
Nov 13, 2018
dedemorton
added a commit
to dedemorton/beats
that referenced
this pull request
Nov 13, 2018
* Add initial skeleton for Beats Central Management docs * Add security warning * Add enrollment command details * Edits and additions * Add fixes from review plus xpack role tags
dedemorton
added a commit
that referenced
this pull request
Nov 13, 2018
leweafan
pushed a commit
to leweafan/beats
that referenced
this pull request
Apr 28, 2023
…lastic#9060) * Add initial skeleton for Beats Central Management docs * Add security warning * Add enrollment command details * Edits and additions * Add fixes from review plus xpack role tags
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Edits and adds content to the Beats to cover configuration management.
You can see the built docs on Firebase here: https://beatsmanagement-b2e5c.firebaseapp.com/configuration-central-management.html
A few notes:
Asciidoc can't seem to handle images added with includes, so I've had to copy the referenced images into the relevant image folders for each Beat. I'll investigate a better way of doing this, but I've gone down that rabbit hole before with no success.
I've used screen captures instead of conceptual diagrams, but I'd like to replace the screen captures at some point because they are likely to get out-of-date quickly, and I don't think screen captures are necessary to explain the concepts.
I've flagged the content with the x-pack badge, but I don't mention that a gold license is required because we've been told in the past to avoid mentioning specific licenses in the docs. Now that x-pack isn't being used, though, 🤷♀️ .
Our convention is to use uppercase instead of < > for variable values shown in syntax descriptions. we might change that, but for now, I've changed the command example to follow our contention.
Did a little restructuring, but we can change it later if it doens't work. I decided to pop the section up in the TOC because I felt that it was too hidden under the configuring topic. I will add links from those topics to point to the central management docs. I also broke the topic into several sections because I wanted to add a place where we can put the API docs later. Also, I wanted the topic about enrolling beats to have a higher SEO ranking.
I also plan to add a page to the Kibana docs to explain basic operations in the UI and point users to these docs.