Skip to content

Commit 37be0a1

Browse files
David Robertslcawl
authored andcommitted
[DOCS] Adding ML-specific prerequisites to setup docs (#42529)
1 parent 9b800a5 commit 37be0a1

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

docs/reference/settings/ml-settings.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@
88

99
You do not need to configure any settings to use {ml}. It is enabled by default.
1010

11+
IMPORTANT: {ml-cap} uses SSE4.2 instructions, so will only work on machines whose
12+
CPUs https://en.wikipedia.org/wiki/SSE4#Supporting_CPUs[support] SSE4.2. If you
13+
run {es} on older hardware you must disable {ml} (by setting `xpack.ml.enabled`
14+
to `false`).
15+
1116
All of these settings can be added to the `elasticsearch.yml` configuration file.
1217
The dynamic settings can also be updated across a cluster with the
1318
<<cluster-update-settings,cluster update settings API>>.

docs/reference/setup/install/windows.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ You can continue using the `.zip` approach if you prefer.
1212

1313
include::license.asciidoc[]
1414

15+
NOTE: On Windows the Elasticsearch {ml} feature requires the Microsoft Universal
16+
C Runtime library. This is built into Windows 10, Windows Server 2016 and more
17+
recent versions of Windows. For older versions of Windows it can be installed
18+
via Windows Update, or from a
19+
https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows[separate download].
20+
If you cannot install the Microsoft Universal C Runtime library you can still
21+
use the rest of Elasticsearch if you disable the {ml} feature.
22+
1523
The latest stable version of Elasticsearch can be found on the
1624
link:/downloads/elasticsearch[Download Elasticsearch] page.
1725
Other versions can be found on the

docs/reference/setup/install/zip-windows.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@ experience for Windows. You can continue using the `.zip` approach if you prefer
1111

1212
include::license.asciidoc[]
1313

14+
NOTE: On Windows the Elasticsearch {ml} feature requires the Microsoft Universal
15+
C Runtime library. This is built into Windows 10, Windows Server 2016 and more
16+
recent versions of Windows. For older versions of Windows it can be installed
17+
via Windows Update, or from a
18+
https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows[separate download].
19+
If you cannot install the Microsoft Universal C Runtime library you can still
20+
use the rest of Elasticsearch if you disable the {ml} feature.
21+
1422
The latest stable version of Elasticsearch can be found on the
1523
link:/downloads/elasticsearch[Download Elasticsearch] page.
1624
Other versions can be found on the

0 commit comments

Comments
 (0)