-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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
[Ingest Manager] Document fleet configuration flags #66736
[Ingest Manager] Document fleet configuration flags #66736
Conversation
Pinging @elastic/ingest-management (Team:Ingest Management) |
Thanks for copying me. I'll be working with @skh on the doc plans for ingest management, but haven't gotten started yet. We need a cohesive story that describes how to use ingest manager. For now, I think you just need document the configuration flags in the Kibana settings reference. So, in the Kibana docs, create a topic under Set Up Kibana > Configuring Kibana called Ingest management settings (we might refine that name later). Use the same structure as the other topics in that section. I realize there won't be much content in the beginning, but that's OK because I'm sure we'll have to add other settings. We are going to create a step-by-step getting started guide for alpha1. Any how-to steps and guidance about configuration should go in that guide. We are also planning to create an architecture doc that describes all the moving parts in ingest management. cc @gchaps |
@dedemorton just created a settings page for Ingest Manager 👍 |
@dedemorton are any of these setting supported on Cloud. We use an icon to identify those. See #65610 |
The three generals settings |
@dedemorton @nchaulet What is the status of these changes? What needs to be done to get these merged? |
@nchaulet Could you also add documentation for |
@skh Thanks for the reminder on this PR, I think I need to the |
@nchaulet The cloud icon is already in the repo. You just have to code it like this:
See this example for how the published doc looks. |
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.
Looks good overall. Thanks for adding this!
@ph @ruflin are these flags going away in 7.9? My only concern is that we have one with epm included. However, we don't tell customers what epm is and it's not shown in the UI anywhere. Its a little confusing what that is referring to. If they are going to remain in the product, we might want to name it something more clear. |
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
…-document-config-flags
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've added suggestions for the shared attributes. I'm still unsure whether to use package-registry or package manager. Are these separate concepts, or the same?
The package registry is an internal of the package manager, it's the place where all the package are stocked |
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@dedemorton FYI my comments about the EPM naming being included should not block this release because we are already past code freeze. Its something we can consider improving on for 7.9 and I created a separate issue to track that #68658 |
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.
LGTM
I've approved so that we can get this content merged. The table formatting looks a little off, though. I can follow up with a fix if you are happy with the content itself. |
* master: [Ingest Manager] Document fleet configuration flags (elastic#66736) [Metrics UI] Fix fatal error when no data is available for Metric Threshold Alerts (elastic#68678) [SIEM][Detections Engine] - Exceptions viewer cleanup (elastic#68651) [SIEM] Fixes flyout flaky test (elastic#68683) [SIEM] Cypress renaming (elastic#68659)
Summary
Resolve #61699 and #62440
Add documentation on fleet settings, flags and TLS requirements.
@dedemorton It's my first time adding doc not sure about the process