* [DOCS] Add ML settings page

* [DOCS] Add ML node to introductory concepts

* [DOCS] ML node clarifications for elastic/x-pack-elasticsearch#1069

Original commit: elastic/x-pack-elasticsearch@ebbd3b31c7
This commit is contained in:
Lisa Cawley 2017-04-17 11:53:31 -07:00 committed by GitHub
parent b59b6bbdd4
commit e3ee3fb581
3 changed files with 38 additions and 3 deletions

View File

@ -38,7 +38,7 @@ Jobs::
Data feeds::
Jobs can analyze either a batch of data from a data store or a stream of data
in real-time. The latter involves data that is retrieved from {es} and is
referred to as a _data feed_.
referred to as a data feed.
Detectors::
Part of the configuration information associated with a job, detectors define
@ -54,7 +54,12 @@ Buckets::
bucket span, take into account the granularity at which you want to analyze,
the frequency of the input data, and the frequency at which alerting is required.
Machine learning nodes::
A {ml} node is a node that has `xpack.ml.enabled` and `node.ml` set to `true`,
which is the default behavior. If you set `node.ml` to `false`, the node can
service API requests but it cannot run jobs. If you want to use {xpack} {ml}
features, there must be at least one {ml} node in your cluster.
For more information about this setting, see <<ml-settings>>.

View File

@ -10,6 +10,7 @@ configuration files.
* <<monitoring-settings, Monitoring Settings>>
* <<notification-settings, Watcher Settings>>
* <<reporting-settings, Reporting Settings>>
* <<ml-settings, Machine Learning Settings>>
--
include::security-settings.asciidoc[]
@ -17,4 +18,4 @@ include::monitoring-settings.asciidoc[]
include::graph-settings.asciidoc[]
include::notification-settings.asciidoc[]
include::reporting-settings.asciidoc[]
include::ml-settings.asciidoc[]

View File

@ -0,0 +1,29 @@
[[ml-settings]]
== Machine Learning Settings
You do not need to configure any settings to use {ml}.
[float]
[[general-ml-settings]]
=== General Machine Learning Settings
`xpack.ml.enabled`::
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 data feeds.
If set to `false` in `kibana.yml`, the {ml} icon is not visible in Kibana. +
+
TIP: If you want to use {ml} features in your cluster, you must enable {ml} 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_. +
+
If set to `false` in `elasticsearch.yml`, the node cannot run jobs.
If you want to run jobs, there must be at least one machine learning node
in your cluster. +
+
TIP: 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