Browse Source

[DOCS] Document static dynamic transform settings (#61384)

Lisa Cawley 5 years ago
parent
commit
ec7939364b
1 changed files with 17 additions and 18 deletions
  1. 17 18
      docs/reference/settings/transform-settings.asciidoc

+ 17 - 18
docs/reference/settings/transform-settings.asciidoc

@@ -12,33 +12,32 @@ default.
 
 All of these settings can be added to the `elasticsearch.yml` configuration file.
 The dynamic settings can also be updated across a cluster with the
-<<cluster-update-settings,cluster update settings API>>.
-
-TIP: Dynamic settings take precedence over settings in the `elasticsearch.yml`
-file.
+<<cluster-update-settings,cluster update settings API>>. Dynamic settings take
+precedence over settings in the `elasticsearch.yml` file.
 
 [discrete]
 [[general-transform-settings]]
 ==== General {transforms} settings
 
 `node.roles: [ transform ]`::
-Set to `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.
+(<<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.
 +
 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, then all required roles must be explicitly  
-set. Consult <<modules-node>> to learn more.
+If you use the `node.roles` setting, all required roles must be explicitly set.
+Consult <<modules-node>> to learn more.
 
 `xpack.transform.enabled`::
-deprecated:[7.8.0,Basic License features should always be enabled] +
-This deprecated setting no longer has any effect.
-
-`xpack.transform.num_transform_failure_retries` (<<cluster-update-settings,Dynamic>>)::
-The number of times that a {transform} retries when it experiences a non-fatal 
-error. Once the number of retries is exhausted, the {transform} task is marked 
-as `failed`. The default value is `10` with a valid minimum of `0` and maximum 
-of `100`. If a {transform} is already running, it has to be restarted to use the 
-changed setting.
+deprecated:[7.8.0,Basic License features should always be enabled]
+(<<static-cluster-setting,Static>>) This deprecated setting no longer has any
+effect.
+
+`xpack.transform.num_transform_failure_retries`::
+(<<cluster-update-settings,Dynamic>>) The number of times that a {transform}
+retries when it experiences a non-fatal error. Once the number of retries is
+exhausted, the {transform} task is marked as `failed`. The default value is `10`
+with a valid minimum of `0` and maximum of `100`. If a {transform} is already
+running, it has to be restarted to use the changed setting.