Skip to content

Commit 6230a99

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 d4970e8 commit 6230a99

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
@@ -118,6 +118,19 @@ least 4096 threads. This can be done via `/etc/security/limits.conf`
118118
using the `nproc` setting (note that you might have to increase the
119119
limits for the `root` user too).
120120

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

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

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

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

0 commit comments

Comments
 (0)