瀏覽代碼

[DOCS] Clarify use of CCS on ML nodes (#66616)

Co-authored-by: David Roberts <dave.roberts@elastic.co>
Lisa Cawley 4 年之前
父節點
當前提交
6b463a7b7a

+ 14 - 12
docs/reference/modules/node.asciidoc

@@ -13,20 +13,13 @@ clients.
 // tag::modules-node-description-tag[]
 All nodes know about all the other nodes in the cluster and can forward client
 requests to the appropriate node.
-
-By default, a node is all of the following types: master-eligible, data, ingest,
-and (if available) machine learning. All data nodes are also transform nodes.
 // end::modules-node-description-tag[]
 
-TIP: As the cluster grows and in particular if you have large {ml} jobs or
-{ctransforms}, consider separating dedicated master-eligible nodes from
-dedicated data nodes, {ml} nodes, and {transform} nodes.
-
 [[node-roles]]
 ==== Node roles
 
 You can define the roles of a node by setting `node.roles`. If you don't
-configure this setting, then the node has the following roles by default:
+configure this setting, the node has the following roles by default:
 
 * `master`
 * `data`
@@ -37,9 +30,14 @@ configure this setting, then the node has the following roles by default:
 * `ingest`
 * `ml`
 * `remote_cluster_client`
+* `transform`
 
 NOTE: If you set `node.roles`, the node is assigned only the roles you specify.
 
+As the cluster grows and in particular if you have large {ml} jobs or
+{ctransforms}, consider separating dedicated master-eligible nodes from
+dedicated data nodes, {ml} nodes, and {transform} nodes.
+
 <<master-node,Master-eligible node>>::
 
 A node that has the `master` role (default), which makes it eligible to be
@@ -335,10 +333,12 @@ To create a dedicated {ml} node in the {default-dist}, set:
 
 [source,yaml]
 ----
-node.roles: [ ml ]
-xpack.ml.enabled: true <1>
+node.roles: [ ml, remote_cluster_client] <1>
+xpack.ml.enabled: true <2>
 ----
-<1> The `xpack.ml.enabled` setting is enabled by default.
+<1> The `remote_cluster_client` role is optional but strongly recommended.
+Otherwise, {ccs} fails when used in {ml} jobs or {dfeeds}. See <<remote-node>>.
+<2> The `xpack.ml.enabled` setting is enabled by default.
 
 [[transform-node]]
 ==== [xpack]#{transform-cap} node#
@@ -351,8 +351,10 @@ To create a dedicated {transform} node in the {default-dist}, set:
 
 [source,yaml]
 ----
-node.roles: [ transform ]
+node.roles: [ transform, remote_cluster_client ] <1>
 ----
+<1> The `remote_cluster_client` role is optional but strongly recommended.
+Otherwise, {ccs} fails when used in {transforms}. See <<remote-node>>.
 
 [[change-node-role]]
 ==== Changing the role of a node

+ 10 - 6
docs/reference/settings/ml-settings.asciidoc

@@ -22,15 +22,19 @@ hardware, you must disable {ml} (by setting `xpack.ml.enabled` to `false`).
 
 `node.roles: [ ml ]`::
 (<<static-cluster-setting,Static>>) Set `node.roles` to contain `ml` to identify
-the node as a _{ml} node_ that is capable of running jobs. Every node is a {ml}
-node by default.
+the node as a _{ml} node_. If you want to run {ml} jobs, there must be at least
+one {ml} node in your cluster. 
 +
-If you use the `node.roles` setting, then all required roles must be explicitly
-set. Consult <<modules-node>> to learn more.
+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>>.
 +
-IMPORTANT: On dedicated coordinating nodes or dedicated master nodes, do not set
+[IMPORTANT]
+====
+* On dedicated coordinating nodes or dedicated master nodes, do not set
 the `ml` role.
-
+* 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>>.
+====
 
 `xpack.ml.enabled`::
 (<<static-cluster-setting,Static>>) Set to `true` (default) to enable {ml} APIs

+ 9 - 7
docs/reference/settings/transform-settings.asciidoc

@@ -16,14 +16,16 @@ default.
 
 `node.roles: [ transform ]`::
 (<<static-cluster-setting,Static>>) Set `node.roles` to contain `transform` to
-identify the node as a _transform node_. If you use the default settings for a
-node, it does not have the `transform` role.
+identify the node as a _transform node_. If you want to run {transforms}, there 
+must be at least one {transform} node in your cluster.
 +
-If a node doesn't have this role, the node cannot run transforms. If you want to 
-run transforms, there must be at least one transform node in your cluster.
-+
-If you use the `node.roles` setting, all required roles must be explicitly set.
-Consult <<modules-node>> to learn more.
+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>>.
++ 
+IMPORTANT: It is strongly recommended that dedicated {transform} nodes also have 
+the `remote_cluster_client` role; otherwise, {ccs} fails when used in 
+{transforms}. See <<remote-node>>.
 
 `xpack.transform.enabled`::
 deprecated:[7.8.0,Basic License features should always be enabled]