Informational variables

Table 1. Table Informational variables

Name

Value

Description

HOME

/home/jboss

-

JAVA_DATA_DIR

/deployments/data

^ The location of the directory which should be used by the application for reading/writing application data. Users should override the default if their application should use a different directory, e.g. if a persistent volume is used to persist data across restarts.

JAVA_HOME

/usr/lib/jvm/jre

-

JAVA_VENDOR

openjdk

-

JAVA_VERSION

1.8.0

-

JBOSS_CONTAINER_JAVA_JVM_MODULE

/opt/jboss/container/java/jvm

-

JBOSS_CONTAINER_JAVA_PROXY_MODULE

/opt/jboss/container/java/proxy

-

JBOSS_CONTAINER_JAVA_RUN_MODULE

/opt/jboss/container/java/run

-

JBOSS_CONTAINER_OPENJDK_JRE_MODULE

/opt/jboss/container/openjdk/jre

-

JBOSS_CONTAINER_UTIL_LOGGING_MODULE

/opt/jboss/container/util/logging/

-

Configuration variables

Table 2. Table Configuration variables

Name

Example

Description

CONTAINER_MAX_MEMORY

1024

Memory limit given to the container.

GC_ADAPTIVE_SIZE_POLICY_WEIGHT

90

The weighting given to the current GC time versus previous GC times.

GC_CONTAINER_OPTIONS

-XX:+UseG1GC

specify Java GC to use. The value of this variable should contain the necessary JRE command-line options to specify the required GC, which will override the default of -XX:+UseParallelGC.

GC_MAX_HEAP_FREE_RATIO

40

Maximum percentage of heap free after GC to avoid shrinking.

GC_MAX_METASPACE_SIZE

100

The maximum metaspace size.

GC_METASPACE_SIZE

20

The initial metaspace size.

GC_MIN_HEAP_FREE_RATIO

20

Minimum percentage of heap free after GC to avoid expansion.

GC_TIME_RATIO

4

Specifies the ratio of the time spent outside the garbage collection (for example, the time spent for application execution) to the time spent in the garbage collection.

HTTPS_PROXY

myuser@127.0.0.1:8080

The location of the https proxy. This takes precedence over http_proxy and HTTP_PROXY, and will be used for both Maven builds and Java runtime.

HTTP_PROXY

127.0.0.1:8080

The location of the http proxy. This will be used for both Maven builds and Java runtime.

JAVA_APP_DIR

myapplication/

^ The directory where the application resides. All paths in your application are relative to this directory.

JAVA_APP_NAME

-

To set the process or application name by the user.

JAVA_ARGS

-

Arguments passed to the java application.

JAVA_CLASSPATH

-

^ The classpath to use. If not given, the startup script checks for a file JAVA_APP_DIR/classpath and use its content literally as classpath. If this file doesn’t exists all jars in the app dir are added (classes:JAVA_APP_DIR/*).

JAVA_DEBUG

true

If set remote debugging will be switched on. Disabled by default.

JAVA_DEBUG_PORT

8787

Port used for remote debugging. Defaults to 5005.

JAVA_DIAGNOSTICS

true

Set this to get some diagnostics information to standard output when things are happening. Note: This option, if set to true, will set -XX:+UnlockDiagnosticVMOptions. Disabled by default.

JAVA_INITIAL_MEM_RATIO

25

Is used when no -Xms option is given in JAVA_OPTS. This is used to calculate a default initial heap memory based on the maximum heap memory. If used in a container without any memory constraints for the container then this option has no effect. If there is a memory constraint then -Xms is set to a ratio of the -Xmx memory as set here. The default is 25 which means 25% of the -Xmx is used as the initial heap size. You can skip this mechanism by setting this value to 0 in which case no -Xms option is added.

JAVA_LIB_DIR

-

^ Directory holding the Java jar files as well an optional classpath file which holds the classpath. Either as a single line classpath (colon separated) or with jar files listed line-by-line. If not set JAVA_LIB_DIR is the same as JAVA_APP_DIR.

JAVA_MAIN_CLASS

com.example.MainClass

^ A main class to use as argument for java. When this environment variable is given, all jar files in JAVA_APP_DIR are added to the classpath as well as JAVA_LIB_DIR.

JAVA_MAX_INITIAL_MEM

4096

Is used when no -Xms option is given in JAVA_OPTS. This is used to calculate the maximum value of the initial heap memory. If used in a container without any memory constraints for the container then this option has no effect. If there is a memory constraint then -Xms is limited to the value set here. The default is 4096MB which means the calculated value of -Xms never will be greater than 4096MB. The value of this variable is expressed in MB.

JAVA_MAX_MEM_RATIO

-

Is used when no -Xmx option is given in JAVA_OPTS. This is used to calculate a default maximal heap memory based on a containers restriction. If used in a container without any memory constraints for the container then this option has no effect. If there is a memory constraint then -Xmx is set to a ratio of the container available memory as set here. The default is 50 which means 50% of the available memory is used as an upper boundary. You can skip this mechanism by setting this value to 0 in which case no -Xmx option is added.

JAVA_OPTIONS

-verbose:class

JVM options passed to the java command. Use JAVA_OPTS.

JAVA_OPTS

-verbose:class

JVM options passed to the java command.

JAVA_OPTS_APPEND

-Dsome.property=foo

User specified Java options to be appended to generated options in JAVA_OPTS.

LOGGING_SCRIPT_DEBUG

True

Set to true to enable script debugging. Deprecates SCRIPT_DEBUG.

NO_PROXY

foo.example.com,bar.example.com

A comma separated lists of hosts, IP addresses or domains that can be accessed directly. This will be used for both Maven builds and Java runtime.

http_proxy

http://127.0.0.1:8080

The location of the http proxy. This takes precedence over HTTP_PROXY and will be used for both Maven builds and Java runtime.

https_proxy

myuser:mypass@127.0.0.1:8080

The location of the https proxy. This takes precedence over HTTPS_PROXY, http_proxy, and HTTP_PROXY, and will be used for both Maven builds and Java runtime.

no_proxy

*.example.com

A comma separated lists of hosts, IP addresses or domains that can be accessed directly. This takes precedence over NO_PROXY and will be used for both Maven builds and Java runtime.