[lmd] update documentation for prerequisite data steps#17642
[lmd] update documentation for prerequisite data steps#17642
Conversation
mmahacek
added
documentation
Vale Linting ResultsSummary: 1 warning found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/lmd/docs/README.md | 29 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
andrewkroh
added
the
Team:Security-Applied ML
|
Pinging @elastic/sec-applied-ml (Team:Security-Applied ML) |
packages/lmd/docs/README.md
Outdated
|
|
||
| Before installing this integration, make sure you have deployed the Elastic Defend integration. This integration uses a transform based on data collected by Elastic Defend. | ||
|
|
||
| If you are running Elasticsearch 8.18+, the Defend integration only collects a [subset of host information by default](https://www.elastic.co/docs/solutions/security/configure-elastic-defend/configure-data-volume-for-elastic-endpoint#host-fields). To ensure the transform runs properly, the `[linux|mac|windows].advanced.set_extended_host_information` settings need to be set to `true. |
There was a problem hiding this comment.
This is a great detail, thanks for adding. Do you think the Installation or transforms section could fit this?
There was a problem hiding this comment.
I contemplated putting it as step 1 in the Installation section. Though I ended up creating Prerequisites to (a) include a reminder that this relies of data from Defend and (b) to possibly also include a note indicating requirements for ML nodes. Out of the box, running all the Anomaly Detection jobs needs just over 8.2GB of ML memory. I was going to raise a separate issue (unless it's okay to discuss here) about providing some documentation on minimum memory requirements for ML.
There was a problem hiding this comment.
I made some updates to consolidate some of the intro paragraph into the Prereqs section, as well as updated some install steps to reflect UI changes in Kibana v9.
Updated README to clarify prerequisites and integration steps.
💚 Build Succeeded
History
cc @mmahacek |
4 participants
Proposed commit message
LMD: Update documentation for prerequisite steps
Checklist
changelog.ymlfile.I have verified that any added dashboard complies with Kibana's Dashboard good practicesAuthor's Checklist
How to test this PR locally
Docs-only change
Related issues
Screenshots
Docs-only change