Skip to content

Expand ML Job/Rule documentation to include Related Integrations and Setup information #2974

Open
@spong

Description

@spong

Description

From an internal discussion, it was asked if there was any chance to document better what exact integrations or configurations need to be fulfilled so that the ML jobs will have data as this is not really obvious from the existing documentation alone.

The docs in question include the security prebuilt ml jobs (https://www.elastic.co/guide/en/security/8.6/prebuilt-ml-jobs.html), and potentially the ML docs as well for the OOTB ML Jobs (https://www.elastic.co/guide/en/machine-learning/8.6/ootb-ml-jobs-uptime.html).

Note: This documentation update can be done in parallel with exposing this information within the Rule Details by means of adding it directly to the rule. Detection-rules issue for track: elastic/detection-rules#2548

Acceptance Test Criteria

As a user, I should be able to see what integrations or prior setup instructions may be necessary to successfully use our prebuilt ML Jobs/Rules.

Notes

Please see the @elastic/security-ml folks for the actual Related Integration and Setup content to be added here.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions