Skip to content

Commit 5134537

Browse files
committed
Fix ordering of bootstrap checks in docs (#32417)
In the section of the bootstrap checks docs for the maximum map count check, we refer to max size virtual memory check and explicitly call out the maximum size virtual memory check as being the previous point. However, this is not correct as the previous point is currently the max file size check. It does make sense for these two checks to be proximate to each other in the docs so this commit reorders the checks so that the maximum size virtual memory check indeed comes before the maximum map count check. This makes the sense in the maximum map count check correct.
1 parent b90d4bd commit 5134537

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/reference/setup/bootstrap-checks.asciidoc

+13-13
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,19 @@ least 2048 threads. This can be done via `/etc/security/limits.conf`
119119
using the `nproc` setting (note that you might have to increase the
120120
limits for the `root` user too).
121121

122+
=== Max file size check
123+
124+
The segment files that are the components of individual shards and the translog
125+
generations that are components of the translog can get large (exceeding
126+
multiple gigabytes). On systems where the max size of files that can be created
127+
by the Elasticsearch process is limited, this can lead to failed
128+
writes. Therefore, the safest option here is that the max file size is unlimited
129+
and that is what the max file size bootstrap check enforces. To pass the max
130+
file check, you must configure your system to allow the Elasticsearch process
131+
the ability to write files of unlimited size. This can be done via
132+
`/etc/security/limits.conf` using the `fsize` setting to `unlimited` (note that
133+
you might have to increase the limits for the `root` user too).
134+
122135
[[max-size-virtual-memory-check]]
123136
=== Maximum size virtual memory check
124137

@@ -134,19 +147,6 @@ address space. This can be done via `/etc/security/limits.conf` using
134147
the `as` setting to `unlimited` (note that you might have to increase
135148
the limits for the `root` user too).
136149

137-
=== Max file size check
138-
139-
The segment files that are the components of individual shards and the translog
140-
generations that are components of the translog can get large (exceeding
141-
multiple gigabytes). On systems where the max size of files that can be created
142-
by the Elasticsearch process is limited, this can lead to failed
143-
writes. Therefore, the safest option here is that the max file size is unlimited
144-
and that is what the max file size bootstrap check enforces. To pass the max
145-
file check, you must configure your system to allow the Elasticsearch process
146-
the ability to write files of unlimited size. This can be done via
147-
`/etc/security/limits.conf` using the `fsize` setting to `unlimited` (note that
148-
you might have to increase the limits for the `root` user too).
149-
150150
=== Maximum map count check
151151

152152
Continuing from the previous <<max-size-virtual-memory-check,point>>, to

0 commit comments

Comments
 (0)