Skip to content

Commit fcaf082

Browse files
authored
Document jvm options for cli tools (#92510) (#92536)
This commit adds documentation for the CLI_JAVA_OPTS environment variable. closes #92503
1 parent d6fc39c commit fcaf082

File tree

4 files changed

+26
-0
lines changed

4 files changed

+26
-0
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[[cli-tool-jvm-options-{tool-name}]]
2+
[float]
3+
==== JVM options
4+
5+
CLI tools run with 64MB of heap. For most tools, this value is fine. However, if needed
6+
this can be overriden by setting the CLI_JAVA_OPTS environment variable. For example,
7+
the following increases the heap size used by the `pass:a[{tool-name}]` tool to 1GB.
8+
9+
[source,shell,subs=attributes+]
10+
--------------------------------------------------
11+
export CLI_JAVA_OPTS="-Xmx1g"
12+
bin/elasticsearch-{tool-name} ...
13+
--------------------------------------------------

docs/reference/commands/node-tool.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ This tool has a number of modes:
5050
{es}. This may sometimes allow you to downgrade to an earlier version of
5151
{es}.
5252

53+
:tool-name: node
54+
include::cli-jvm-options.asciidoc[]
55+
:!tool-name:
56+
5357
[[node-tool-repurpose]]
5458
[discrete]
5559
==== Changing the role of a node

docs/reference/commands/reconfigure-node.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ nodes in an existing, secured cluster.
5454

5555
`-v, --verbose`:: Shows verbose output.
5656

57+
58+
:tool-name: reconfigure-node
59+
include::cli-jvm-options.asciidoc[]
60+
:!tool-name:
61+
5762
[discrete]
5863
=== Examples
5964

docs/reference/commands/shard-tool.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ There are two ways to specify the path:
4444
* Use the `--dir` option to specify the full path to the corrupted index or
4545
translog files.
4646

47+
:tool-name: shard
48+
include::cli-jvm-options.asciidoc[]
49+
:!tool-name:
50+
4751
[discrete]
4852
==== Removing corrupted data
4953

0 commit comments

Comments
 (0)