Skip to content

Commit 2e469e4

Browse files
authored
[DOCS] Clean up xpack.ml.enabled details (#74573) (#74777)
1 parent 903a21c commit 2e469e4

File tree

2 files changed

+22
-37
lines changed

2 files changed

+22
-37
lines changed

docs/reference/modules/node.asciidoc

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,9 @@ as a remote client.
7575

7676
<<ml-node,Machine learning node>>::
7777

78-
A node that has `xpack.ml.enabled` and the `ml` role. If you want to use
79-
{ml-features}, there must be at least one {ml} node in your cluster. For more
80-
information about {ml-features}, see {ml-docs}/index.html[Machine learning in
81-
the {stack}].
78+
A node that has the `ml` role. If you want to use {ml-features}, there must be
79+
at least one {ml} node in your cluster. For more information, see
80+
<<ml-settings>> and {ml-docs}/index.html[Machine learning in the {stack}].
8281

8382
<<transform-node,{transform-cap} node>>::
8483

@@ -343,31 +342,20 @@ node.roles: [ remote_cluster_client ]
343342
[[ml-node]]
344343
==== [xpack]#Machine learning node#
345344

346-
The {ml-features} provide {ml} nodes, which run jobs and handle {ml} API
347-
requests. If `xpack.ml.enabled` is set to `true` and the node does not have the
348-
`ml` role, the node can service API requests but it cannot run jobs.
349-
350-
If you want to use {ml-features} in your cluster, you must enable {ml}
351-
(set `xpack.ml.enabled` to `true`) on all master-eligible nodes. If you want to
352-
use {ml-features} in clients (including {kib}), it must also be enabled on all
353-
coordinating nodes.
354-
355-
For more information about these settings, see <<ml-settings>>.
345+
{ml-cap} nodes run jobs and handle {ml} API requests. For more information, see
346+
<<ml-settings>>.
356347

357348
To create a dedicated {ml} node, set:
358349

359350
[source,yaml]
360351
----
361-
node.roles: [ ml, remote_cluster_client] <1>
362-
xpack.ml.enabled: true <2>
352+
node.roles: [ ml, remote_cluster_client]
363353
----
364-
<1> The `remote_cluster_client` role is optional but strongly recommended.
365-
Otherwise, {ccs} fails when used in {ml} jobs or {dfeeds}. See <<remote-node>>.
366-
<2> The `xpack.ml.enabled` setting is enabled by default.
367354

368-
NOTE: If you use {ccs} in your {anomaly-jobs}, the `remote_cluster_client` role
369-
is also required on all master-eligible nodes. Otherwise, the {dfeed} cannot
370-
start.
355+
The `remote_cluster_client` role is optional but strongly recommended.
356+
Otherwise, {ccs} fails when used in {ml} jobs or {dfeeds}. If you use {ccs} in
357+
your {anomaly-jobs}, the `remote_cluster_client` role is also required on all
358+
master-eligible nodes. Otherwise, the {dfeed} cannot start. See <<remote-node>>.
371359

372360
[[transform-node]]
373361
==== [xpack]#{transform-cap} node#
@@ -379,9 +367,10 @@ To create a dedicated {transform} node, set:
379367

380368
[source,yaml]
381369
----
382-
node.roles: [ transform, remote_cluster_client ] <1>
370+
node.roles: [ transform, remote_cluster_client ]
383371
----
384-
<1> The `remote_cluster_client` role is optional but strongly recommended.
372+
373+
The `remote_cluster_client` role is optional but strongly recommended.
385374
Otherwise, {ccs} fails when used in {transforms}. See <<remote-node>>.
386375

387376
[[change-node-role]]

docs/reference/settings/ml-settings.asciidoc

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,21 @@ the node. To learn more, refer to <<modules-node>>.
3232
====
3333
* On dedicated coordinating nodes or dedicated master nodes, do not set
3434
the `ml` role.
35-
* It is strongly recommended that dedicated {ml} nodes also have the `remote_cluster_client` role; otherwise, {ccs} fails when used in {ml} jobs or {dfeeds}. See <<remote-node>>.
35+
* It is strongly recommended that dedicated {ml} nodes also have the
36+
`remote_cluster_client` role; otherwise, {ccs} fails when used in {ml} jobs or
37+
{dfeeds}. See <<remote-node>>.
3638
====
3739

3840
`xpack.ml.enabled`::
39-
(<<static-cluster-setting,Static>>) Set to `true` (default) to enable {ml} APIs
41+
(<<static-cluster-setting,Static>>) The default value (`true`) enables {ml} APIs
4042
on the node.
4143
+
42-
If set to `false`, the {ml} APIs are disabled on the node. Therefore the node
43-
cannot open jobs, start {dfeeds}, or receive transport (internal) communication
44-
requests related to {ml} APIs. If the node is a coordinating node, {ml} requests
45-
from clients (including {kib}) also fail. For more information about disabling
46-
{ml} in specific {kib} instances, see
47-
{kibana-ref}/ml-settings-kb.html[{kib} {ml} settings].
48-
+
4944
IMPORTANT: If you want to use {ml-features} in your cluster, it is recommended
50-
that you set `xpack.ml.enabled` to `true` on all nodes. This is the default
51-
behavior. At a minimum, it must be enabled on all master-eligible nodes. If you
52-
want to use {ml-features} in clients or {kib}, it must also be enabled on all
53-
coordinating nodes.
45+
that you use the default value for this setting on all nodes.
46+
+
47+
If set to `false`, the {ml} APIs are disabled on the node. For example, the node
48+
cannot open jobs, start {dfeeds}, receive transport (internal) communication
49+
requests, or requests from clients (including {kib}) related to {ml} APIs.
5450

5551
`xpack.ml.inference_model.cache_size`::
5652
(<<static-cluster-setting,Static>>) The maximum inference cache size allowed.

0 commit comments

Comments
 (0)