Skip to content

Commit df2792a

Browse files
committed
Merge remote-tracking branch 'elastic/master' into retention-lease-expiration
* elastic/master: Removing unused methods in Numbers (elastic#37186) Fix setting by time unit (elastic#37192) [DOCS] Cleans up xpackml attributes ML: fix delayed data annotations on secured cluster (elastic#37193) Update version in SearchRequest and related test [DOCS] Adds overview and API ref for cluster voting configurations (elastic#36954) ML: changing JobResultsProvider.getForecastRequestStats to support > 1 index (elastic#37157) Separate out validation of groups of settings (elastic#34184)
2 parents ff54ce7 + 56e472b commit df2792a

File tree

47 files changed

+605
-497
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+605
-497
lines changed

docs/reference/cluster.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,3 +104,5 @@ include::cluster/tasks.asciidoc[]
104104
include::cluster/nodes-hot-threads.asciidoc[]
105105

106106
include::cluster/allocation-explain.asciidoc[]
107+
108+
include::cluster/voting-exclusions.asciidoc[]
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
[[voting-config-exclusions]]
2+
== Voting configuration exclusions API
3+
++++
4+
<titleabbrev>Voting Configuration Exclusions</titleabbrev>
5+
++++
6+
7+
Adds or removes master-eligible nodes from the
8+
<<modules-discovery-voting,voting configuration exclusion list>>.
9+
10+
[float]
11+
=== Request
12+
13+
`POST _cluster/voting_config_exclusions/<node_name>` +
14+
15+
`DELETE _cluster/voting_config_exclusions`
16+
17+
[float]
18+
=== Path parameters
19+
20+
`node_name`::
21+
A <<cluster-nodes,node filter>> that identifies {es} nodes.
22+
23+
[float]
24+
=== Description
25+
26+
By default, if there are more than three master-eligible nodes in the cluster
27+
and you remove fewer than half of the master-eligible nodes in the cluster at
28+
once, the <<modules-discovery-voting,voting configuration>> automatically
29+
shrinks.
30+
31+
If you want to shrink the voting configuration to contain fewer than three nodes
32+
or to remove half or more of the master-eligible nodes in the cluster at once,
33+
you must use this API to remove departed nodes from the voting configuration
34+
manually. It adds an entry for that node in the voting configuration exclusions
35+
list. The cluster then tries to reconfigure the voting configuration to remove
36+
that node and to prevent it from returning.
37+
38+
If the API fails, you can safely retry it. Only a successful response
39+
guarantees that the node has been removed from the voting configuration and will
40+
not be reinstated.
41+
42+
NOTE: Voting exclusions are required only when you remove at least half of the
43+
master-eligible nodes from a cluster in a short time period. They are not
44+
required when removing master-ineligible nodes or fewer than half of the
45+
master-eligible nodes.
46+
47+
The <<modules-discovery-settings,`cluster.max_voting_config_exclusions`
48+
setting>> limits the size of the voting configuration exclusion list. The
49+
default value is `10`. Since voting configuration exclusions are persistent and
50+
limited in number, you must clear the voting config exclusions list once the
51+
exclusions are no longer required.
52+
53+
There is also a
54+
<<modules-discovery-settings,`cluster.auto_shrink_voting_configuration` setting>>,
55+
which is set to true by default. If it is set to false, you must use this API to
56+
maintain the voting configuration.
57+
58+
For more information, see <<modules-discovery-removing-nodes>>.
59+
60+
[float]
61+
=== Examples
62+
63+
Add `nodeId1` to the voting configuration exclusions list:
64+
[source,js]
65+
--------------------------------------------------
66+
POST /_cluster/voting_config_exclusions/nodeId1
67+
--------------------------------------------------
68+
// CONSOLE
69+
// TEST[catch:bad_request]
70+
71+
Remove all exclusions from the list:
72+
[source,js]
73+
--------------------------------------------------
74+
DELETE /_cluster/voting_config_exclusions
75+
--------------------------------------------------
76+
// CONSOLE

docs/reference/ml/aggregations.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ and to configure your jobs to analyze aggregated data.
88

99
One of the benefits of aggregating data this way is that {es} automatically
1010
distributes these calculations across your cluster. You can then feed this
11-
aggregated data into {xpackml} instead of raw results, which
11+
aggregated data into the {ml-features} instead of raw results, which
1212
reduces the volume of data that must be considered while detecting anomalies.
1313

1414
There are some limitations to using aggregations in {dfeeds}, however.

docs/reference/ml/apis/resultsresource.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ probability of this occurrence.
269269

270270
There can be many anomaly records depending on the characteristics and size of
271271
the input data. In practice, there are often too many to be able to manually
272-
process them. The {xpackml} features therefore perform a sophisticated
272+
process them. The {ml-features} therefore perform a sophisticated
273273
aggregation of the anomaly records into buckets.
274274

275275
The number of record results depends on the number of anomalies found in each

docs/reference/ml/configuring.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
[[ml-configuring]]
33
== Configuring machine learning
44

5-
If you want to use {xpackml} features, there must be at least one {ml} node in
5+
If you want to use {ml-features}, there must be at least one {ml} node in
66
your cluster and all master-eligible nodes must have {ml} enabled. By default,
77
all nodes are {ml} nodes. For more information about these settings, see
88
{ref}/modules-node.html#modules-node-xpack[{ml} nodes].
99

10-
To use the {xpackml} features to analyze your data, you must create a job and
10+
To use the {ml-features} to analyze your data, you must create a job and
1111
send your data to that job.
1212

1313
* If your data is stored in {es}:

docs/reference/ml/functions.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[[ml-functions]]
33
== Function reference
44

5-
The {xpackml} features include analysis functions that provide a wide variety of
5+
The {ml-features} include analysis functions that provide a wide variety of
66
flexible ways to analyze data for anomalies.
77

88
When you create jobs, you specify one or more detectors, which define the type of

docs/reference/ml/functions/count.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ in one field is unusual, as opposed to the total count.
1414
Use high-sided functions if you want to monitor unusually high event rates.
1515
Use low-sided functions if you want to look at drops in event rate.
1616

17-
The {xpackml} features include the following count functions:
17+
The {ml-features} include the following count functions:
1818

1919
* xref:ml-count[`count`, `high_count`, `low_count`]
2020
* xref:ml-nonzero-count[`non_zero_count`, `high_non_zero_count`, `low_non_zero_count`]

docs/reference/ml/functions/geo.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The geographic functions detect anomalies in the geographic location of the
66
input data.
77

8-
The {xpackml} features include the following geographic function: `lat_long`.
8+
The {ml-features} include the following geographic function: `lat_long`.
99

1010
NOTE: You cannot create forecasts for jobs that contain geographic functions.
1111
You also cannot add rules with conditions to detectors that use geographic
@@ -72,7 +72,7 @@ For example, JSON data might contain the following transaction coordinates:
7272

7373
In {es}, location data is likely to be stored in `geo_point` fields. For more
7474
information, see {ref}/geo-point.html[Geo-point datatype]. This data type is not
75-
supported natively in {xpackml} features. You can, however, use Painless scripts
75+
supported natively in {ml-features}. You can, however, use Painless scripts
7676
in `script_fields` in your {dfeed} to transform the data into an appropriate
7777
format. For example, the following Painless script transforms
7878
`"coords": {"lat" : 41.44, "lon":90.5}` into `"lat-lon": "41.44,90.5"`:

docs/reference/ml/functions/info.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ that is contained in strings within a bucket. These functions can be used as
66
a more sophisticated method to identify incidences of data exfiltration or
77
C2C activity, when analyzing the size in bytes of the data might not be sufficient.
88

9-
The {xpackml} features include the following information content functions:
9+
The {ml-features} include the following information content functions:
1010

1111
* `info_content`, `high_info_content`, `low_info_content`
1212

docs/reference/ml/functions/metric.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The metric functions include functions such as mean, min and max. These values
66
are calculated for each bucket. Field values that cannot be converted to
77
double precision floating point numbers are ignored.
88

9-
The {xpackml} features include the following metric functions:
9+
The {ml-features} include the following metric functions:
1010

1111
* <<ml-metric-min,`min`>>
1212
* <<ml-metric-max,`max`>>

0 commit comments

Comments
 (0)