Document jvm options for cli tools (#92510)

This commit adds documentation for the CLI_JAVA_OPTS environment
variable.

closes #92503
This commit is contained in:
Ryan Ernst 2022-12-22 15:32:07 -08:00 committed by GitHub
parent 4b18d3a15c
commit 3506d5e738
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 26 additions and 0 deletions

View file

@ -0,0 +1,13 @@
[[cli-tool-jvm-options-{tool-name}]]
[float]
==== JVM options
CLI tools run with 64MB of heap. For most tools, this value is fine. However, if needed
this can be overriden by setting the CLI_JAVA_OPTS environment variable. For example,
the following increases the heap size used by the `pass:a[{tool-name}]` tool to 1GB.
[source,shell,subs=attributes+]
--------------------------------------------------
export CLI_JAVA_OPTS="-Xmx1g"
bin/elasticsearch-{tool-name} ...
--------------------------------------------------

View file

@ -50,6 +50,10 @@ This tool has a number of modes:
{es}. This may sometimes allow you to downgrade to an earlier version of
{es}.
:tool-name: node
include::cli-jvm-options.asciidoc[]
:!tool-name:
[[node-tool-repurpose]]
[discrete]
==== Changing the role of a node

View file

@ -54,6 +54,11 @@ nodes in an existing, secured cluster.
`-v, --verbose`:: Shows verbose output.
:tool-name: reconfigure-node
include::cli-jvm-options.asciidoc[]
:!tool-name:
[discrete]
=== Examples

View file

@ -44,6 +44,10 @@ There are two ways to specify the path:
* Use the `--dir` option to specify the full path to the corrupted index or
translog files.
:tool-name: shard
include::cli-jvm-options.asciidoc[]
:!tool-name:
[discrete]
==== Removing corrupted data