Skip to content

[DOCS] Clarifies default ML and transform node settings #67671

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 19, 2021
Merged

[DOCS] Clarifies default ML and transform node settings #67671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions docs/reference/modules/node.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,6 @@ A node that has `xpack.ml.enabled` and the `ml` role, which is the default
behavior in the {es} {default-dist}. If you want to use {ml-features}, there
must be at least one {ml} node in your cluster. For more information about
{ml-features}, see {ml-docs}/index.html[Machine learning in the {stack}].
+
IMPORTANT: If you use the {oss-dist}, do not add the `ml` role. Otherwise, the
node fails to start.

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

Expand Down Expand Up @@ -325,7 +322,7 @@ requests. If `xpack.ml.enabled` is set to `true` and the node does not have the
If you want to use {ml-features} in your cluster, you must enable {ml}
(set `xpack.ml.enabled` to `true`) on all master-eligible nodes. If you want to
use {ml-features} in clients (including {kib}), it must also be enabled on all
coordinating nodes. If you have the {oss-dist}, do not use these settings.
coordinating nodes.

For more information about these settings, see <<ml-settings>>.

Expand All @@ -343,9 +340,8 @@ Otherwise, {ccs} fails when used in {ml} jobs or {dfeeds}. See <<remote-node>>.
[[transform-node]]
==== [xpack]#{transform-cap} node#

{transform-cap} nodes run {transforms} and handle {transform} API requests. If
you have the {oss-dist}, do not use these settings. For more information, see
<<transform-settings>>.
{transform-cap} nodes run {transforms} and handle {transform} API requests. For
more information, see <<transform-settings>>.

To create a dedicated {transform} node in the {default-dist}, set:

Expand Down
5 changes: 2 additions & 3 deletions docs/reference/settings/ml-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ hardware, you must disable {ml} (by setting `xpack.ml.enabled` to `false`).
the node as a _{ml} node_. If you want to run {ml} jobs, there must be at least
one {ml} node in your cluster.
+
By default, every node is a {ml} node. If you set `node.roles`, however,
you must explicitly specify all the required roles for the node. To learn more,
refer to <<modules-node>>.
If you set `node.roles`, you must explicitly specify all the required roles for
the node. To learn more, refer to <<modules-node>>.
+
[IMPORTANT]
====
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/settings/transform-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,8 @@ default.
identify the node as a _transform node_. If you want to run {transforms}, there
must be at least one {transform} node in your cluster.
+
By default, every node is a {transform} node. If you set `node.roles`, however,
you must explicitly specify all the required roles for the node. To learn more,
refer to <<modules-node>>.
If you set `node.roles`, you must explicitly specify all the required roles for
the node. To learn more, refer to <<modules-node>>.
+
IMPORTANT: It is strongly recommended that dedicated {transform} nodes also have
the `remote_cluster_client` role; otherwise, {ccs} fails when used in
Expand Down