From 17d75acb7aec37498eb4d720ef436c17176b2d70 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 5 Jun 2017 13:02:12 -0700 Subject: [PATCH] [DOCS] Clarify ML node settings re transport requests (elastic/x-pack-elasticsearch#1641) * [DOCS] Clarify ML node settings re transport requests * [DOCS] Clarify xpack.ml.enabled based on feedback Original commit: elastic/x-pack-elasticsearch@3102d1e3f3527799f5b78fd2e0415030ba509e0d --- docs/en/settings/ml-settings.asciidoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/en/settings/ml-settings.asciidoc b/docs/en/settings/ml-settings.asciidoc index c57332d6e6d..74e9c71d58e 100644 --- a/docs/en/settings/ml-settings.asciidoc +++ b/docs/en/settings/ml-settings.asciidoc @@ -10,11 +10,13 @@ You do not need to configure any settings to use {ml}. It is enabled by default. Set to `true` (default) to enable {ml}. + + If set to `false` in `elasticsearch.yml`, the {ml} APIs are disabled. -You also cannot open jobs or start {dfeeds}. +You also cannot open jobs, start {dfeeds}, or receive transport (internal) +communication requests related to {ml} APIs. If set to `false` in `kibana.yml`, the {ml} icon is not visible in {kib}. + + -IMPORTANT: If you want to use {ml} features in your cluster, you must enable -{ml} on all master-eligible nodes. This is the default behavior. +IMPORTANT: If you want to use {ml} features in your cluster, you must have +`xpack.ml.enabled` set to `true` on all master-eligible nodes. This is the +default behavior. `node.ml`:: Set to `true` (default) to identify the node as a _machine learning node_. + @@ -26,5 +28,3 @@ least one machine learning node in your cluster. + + IMPORTANT: On dedicated coordinating nodes or dedicated master nodes, disable the `node.ml` role. - -//Eventually this node information should be added to https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-node.html