Browse Source

[DOCS] Add ML node to node.asciidoc (#24495)

* [DOCS] Add ML node to node.asciidoc

* [DOCS] Clarify ML node in node.asciidoc

* [DOCS] Add X-Pack icon for admonition blocks

* [DOCS] Formatting X-Pack blocks in node.asciidoc

* [DOCS] Add xpack icon images to node.asciidoc

* [DOCS] Add final xpack role attributes

* [DOCS] Remove unnecssary xpackicon image

* [DOCS] Add link to X-Pack node settings

* [DOCS] Fix path to X-Pack repository

* [DOCS] Add links to X-Pack node settings

* [DOCS] Fixed text for links to X-Pack node settings

* [DOCS] Change standalone node to dedicated node
Lisa Cawley 8 years ago
parent
commit
d181761aeb
2 changed files with 28 additions and 3 deletions
  1. 1 1
      docs/Versions.asciidoc
  2. 27 2
      docs/reference/modules/node.asciidoc

+ 1 - 1
docs/Versions.asciidoc

@@ -31,7 +31,7 @@ release-state can be: released | prerelease | unreleased
 :es:              Elasticsearch
 :kib:             Kibana
 
-:xes-repo-dir:    {docdir}/../../elasticsearch-extra/x-pack-elasticsearch/docs/en
+:xes-repo-dir:    {docdir}/../../../elasticsearch-extra/x-pack-elasticsearch/docs/en
 
 ///////
 Javadoc roots used to generate links from Painless's API reference

+ 27 - 2
docs/reference/modules/node.asciidoc

@@ -82,7 +82,7 @@ cluster health to have a stable master node.
 Any master-eligible node (all nodes by default) may be elected to become the
 master node by the <<modules-discovery-zen,master election process>>.
 
-IMPORTANT: Master nodes must have access to the `data/` directory (just like 
+IMPORTANT: Master nodes must have access to the `data/` directory (just like
 `data` nodes) as this is where the cluster state is persisted between node restarts.
 
 Indexing and searching your data is CPU-, memory-, and I/O-intensive work
@@ -97,7 +97,7 @@ better _not_ to use dedicated master nodes for this purpose. It is important
 for the stability of the cluster that master-eligible nodes do as little work
 as possible.
 
-To create a standalone master-eligible node, set:
+To create a dedicated master-eligible node, set:
 
 [source,yaml]
 -------------------
@@ -109,6 +109,12 @@ node.ingest: false <3>
 <2> Disable the `node.data` role (enabled by default).
 <3> Disable the `node.ingest` role (enabled by default).
 
+ifdef::include-xpack[]
+NOTE: These settings apply only when {xpack} is not installed. To create a
+dedicated master-eligible node when {xpack} is installed, see <<modules-node-xpack,{xpack} node settings>>.
+endif::include-xpack[]
+
+
 [float]
 [[split-brain]]
 ==== Avoiding split brain with `minimum_master_nodes`
@@ -193,6 +199,11 @@ node.ingest: false <3>
 <2> The `node.data` role is enabled by default.
 <3> Disable the `node.ingest` role (enabled by default).
 
+ifdef::include-xpack[]
+NOTE: These settings apply only when {xpack} is not installed. To create a
+dedicated data node when {xpack} is installed, see <<modules-node-xpack,{xpack} node settings>>.
+endif::include-xpack[]
+
 [float]
 [[node-ingest-node]]
 === Ingest Node
@@ -216,6 +227,11 @@ search.remote.connect: false <4>
 <3> The `node.ingest` role is enabled by default.
 <4> Disable cross-cluster search (enabled by default).
 
+ifdef::include-xpack[]
+NOTE: These settings apply only when {xpack} is not installed. To create a
+dedicated ingest node when {xpack} is installed, see <<modules-node-xpack,{xpack} node settings>>.
+endif::include-xpack[]
+
 [float]
 [[coordinating-only-node]]
 === Coordinating only node
@@ -251,6 +267,11 @@ search.remote.connect: false <4>
 <3> Disable the `node.ingest` role (enabled by default).
 <4> Disable cross-cluster search (enabled by default).
 
+ifdef::include-xpack[]
+NOTE: These settings apply only when {xpack} is not installed. To create a
+dedicated coordinating node when {xpack} is installed, see <<modules-node-xpack,{xpack} node settings>>.
+endif::include-xpack[]
+
 [float]
 == Node data path settings
 
@@ -302,3 +323,7 @@ lead to unexpected data loss.
 More node settings can be found in <<modules,Modules>>.  Of particular note are
 the <<cluster.name,`cluster.name`>>, the <<node.name,`node.name`>> and the
 <<modules-network,network settings>>.
+
+ifdef::include-xpack[]
+include::{xes-repo-dir}/node.asciidoc[]
+endif::include-xpack[]