Skip to content

Commit 869843b

Browse files
author
David Roberts
authored
[DOCS] Add warning about bypassing ML PUT APIs (#38607)
Now that ML configurations are stored in the .ml-config index rather than in cluster state there is a possibility that some users may try to add configurations directly to the index. Allowing this creates a variety of problems including possible data exflitration attacks (depending on how security is set up), so this commit adds warnings against allowing writes to the .ml-config index other than via the ML APIs. Backport of #38509
1 parent 7966dc1 commit 869843b

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

docs/reference/ml/apis/put-datafeed.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ Instantiates a {dfeed}.
1919
You must create a job before you create a {dfeed}. You can associate only one
2020
{dfeed} to each job.
2121

22+
IMPORTANT: You must use {kib} or this API to create a {dfeed}. Do not put a {dfeed}
23+
directly to the `.ml-config` index using the Elasticsearch index API.
24+
If {es} {security-features} are enabled, do not give users `write`
25+
privileges on the `.ml-config` index.
26+
2227

2328
==== Path Parameters
2429

docs/reference/ml/apis/put-job.asciidoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,13 @@ Instantiates a job.
1212

1313
`PUT _xpack/ml/anomaly_detectors/<job_id>`
1414

15-
//===== Description
15+
===== Description
16+
17+
IMPORTANT: You must use {kib} or this API to create a {ml} job. Do not put a job
18+
directly to the `.ml-config` index using the Elasticsearch index API.
19+
If {es} {security-features} are enabled, do not give users `write`
20+
privileges on the `.ml-config` index.
21+
1622

1723
==== Path Parameters
1824

0 commit comments

Comments
 (0)