Informational variables
Name |
Value |
Description |
HOME |
|
- |
JAVA_DATA_DIR |
|
^ 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 |
|
- |
JAVA_VENDOR |
|
- |
JAVA_VERSION |
|
- |
JBOSS_CONTAINER_JAVA_JVM_MODULE |
|
- |
JBOSS_CONTAINER_JAVA_PROXY_MODULE |
|
- |
JBOSS_CONTAINER_JAVA_RUN_MODULE |
|
- |
JBOSS_CONTAINER_JAVA_S2I_MODULE |
|
- |
JBOSS_CONTAINER_MAVEN_38_MODULE |
|
- |
JBOSS_CONTAINER_MAVEN_DEFAULT_MODULE |
|
- |
JBOSS_CONTAINER_MAVEN_S2I_MODULE |
|
- |
JBOSS_CONTAINER_OPENJDK_JDK_MODULE |
|
- |
JBOSS_CONTAINER_S2I_CORE_MODULE |
|
- |
JBOSS_CONTAINER_UTIL_LOGGING_MODULE |
|
- |
MAVEN_VERSION |
|
- |
S2I_SOURCE_DEPLOYMENTS_FILTER |
|
- |
Configuration variables
Name |
Example |
Description |
GC_ADAPTIVE_SIZE_POLICY_WEIGHT |
|
The weighting given to the current GC time versus previous GC times. |
GC_CONTAINER_OPTIONS |
|
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 |
GC_MAX_HEAP_FREE_RATIO |
|
Maximum percentage of heap free after GC to avoid shrinking. |
GC_MAX_METASPACE_SIZE |
|
The maximum metaspace size. |
GC_METASPACE_SIZE |
|
The initial metaspace size. |
GC_MIN_HEAP_FREE_RATIO |
|
Minimum percentage of heap free after GC to avoid expansion. |
GC_TIME_RATIO |
|
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. |
JAVA_APP_DIR |
|
^ 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_CLASSPATH |
|
^ The classpath to use. If not given, the startup script checks for a file |
JAVA_DEBUG |
|
If set remote debugging will be switched on. Disabled by default. |
JAVA_DEBUG_PORT |
|
Port used for remote debugging. Defaults to 5005. |
JAVA_DIAGNOSTICS |
|
Set this to get some diagnostics information to standard output when things are happening. Note: This option, if set to true, will set |
JAVA_LIB_DIR |
|
^ Directory holding the Java jar files as well an optional |
JAVA_MAIN_CLASS |
|
^ A main class to use as argument for |
JAVA_MAX_MEM_RATIO |
|
Specify the maximum heap memory. Corresponds to the JVM argument |
JAVA_OPTS |
|
If set, this prevents all default and generated options (such as JVM and GC tuning, proxy settings, etc.) from being applied. Instead the user should specify exactly the |
JAVA_OPTS_APPEND |
|
User specified Java options to be appended to the generated options. This variable has no effect if |
LOGGING_SCRIPT_DEBUG |
|
Set to true to enable script debugging. |
MAVEN_ARGS |
|
Arguments to use when calling Maven, replacing the default. To append additional arguments, see |
MAVEN_ARGS_APPEND |
|
Additional Maven arguments. |
MAVEN_CLEAR_REPO |
|
If set then the Maven repository is removed after the artifact is built. This is useful for keeping the created application image small, but prevents incremental builds. Will be overridden by S2I_ENABLE_INCREMENTAL_BUILDS. Defaults to false. |
MAVEN_LOCAL_REPO |
|
Directory to use as the local Maven repository. |
MAVEN_MIRRORS |
|
If set, multi-mirror support is enabled, and other MAVEN_MIRROR_* variables will be prefixed. For example: DEV_ONE_MAVEN_MIRROR_URL and QE_TWO_MAVEN_MIRROR_URL |
MAVEN_MIRROR_URL |
The base URL of a mirror used for retrieving artifacts. |
|
MAVEN_REPOS |
|
If set, multi-repo support is enabled, and other MAVEN_REPO_* variables will be prefixed. For example: DEV_ONE_MAVEN_REPO_URL and QE_TWO_MAVEN_REPO_URL |
MAVEN_S2I_ARTIFACT_DIRS |
|
Relative paths of source directories to scan for build output, which will be copied to $DEPLOY_DIR. Defaults to target |
MAVEN_S2I_GOALS |
|
Space separated list of goals to be executed with maven build, e.g. mvn $MAVEN_S2I_GOALS. Defaults to package |
MAVEN_SETTINGS_XML |
|
Location of custom Maven settings.xml file to use. |
S2I_ARTIFACTS_DIR |
|
^ Location mount for artifacts persisted with save-artifacts script, which are used with incremental builds. This should not be overridden by end users. |
S2I_DELETE_SOURCE |
|
^ Delete source files at the end of build. Defaults to true. |
S2I_DESTINATION_DIR |
|
^ Root directory for S2I mount, as specified by the io.openshift.s2i.destination label. This should not be overridden by end users. |
S2I_ENABLE_INCREMENTAL_BUILDS |
|
^ Do not remove intermediate build files so they can be saved for use with future builds. Defaults to true. |
S2I_IMAGE_SOURCE_MOUNTS |
|
^ Comma separated list of relative paths in source directory which should be included in the image. List may include wildcards, which are expanded using find. By default, the contents of mounted directories are processed similarly to source folders, where the contents of $S2I_SOURCE_CONFIGURATION_DIR, $S2I_SOURCE_DATA_DIR, and $S2I_SOURCE_DEPLOYMENTS_DIR are copied to their respective target directories. Alternatively, if an install.sh file is located in the root of the mount point, it is executed instead. |
S2I_SOURCE_CONFIGURATION_DIR |
|
^ Relative path to directory containing application configuration files to be copied over to the product configuration directory, see S2I_TARGET_CONFIGURATION_DIR. Defaults to configuration. |
S2I_SOURCE_DATA_DIR |
|
^ Relative path to directory containing application data files to be copied over to the product data directory, see S2I_TARGET_DATA_DIR. Defaults to data. |
S2I_SOURCE_DEPLOYMENTS_DIR |
|
^ Relative path to directory containing binary files to be copied over to the product deployment directory, see S2I_TARGET_DEPLOYMENTS_DIR. Defaults to deployments. |
S2I_SOURCE_DIR |
|
^ Location of mount for source code to be built. This should not be overridden by end users. |
S2I_TARGET_CONFIGURATION_DIR |
|
^ Absolute path to which files located in $S2I_SOURCE_DIR/$S2I_SOURCE_CONFIGURATION_DIR are copied. |
S2I_TARGET_DATA_DIR |
|
^ Absolute path to which files located in $S2I_SOURCE_DIR/$S2I_SOURCE_DATA_DIR are copied. |
S2I_TARGET_DEPLOYMENTS_DIR |
|
^ Absolute path to which files located in $S2I_SOURCE_DIR/$S2I_SOURCE_DEPLOYMENTS_DIR are copied. Additionally, this is the directory to which build output is copied |
http_proxy |
The location of the http proxy. This will be used for both Maven builds and Java runtime. |
|
https_proxy |
|
The location of the https proxy. This takes precedence over http_proxy and will be used for both Maven builds and Java runtime. |
no_proxy |
|
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. |
prefix_MAVEN_MIRROR_ID |
|
ID to be used for the specified mirror. If omitted, a unique ID will be generated. |
prefix_MAVEN_MIRROR_OF |
|
Repository IDs mirrored by this entry. Defaults to external:* |
prefix_MAVEN_MIRROR_URL |
The URL of the mirror. |
|
prefix_MAVEN_REPO_DIRECTORY_PERMISSIONS |
|
Maven repository directory permissions |
prefix_MAVEN_REPO_FILE_PERMISSIONS |
|
Maven repository file permissions |
prefix_MAVEN_REPO_HOST |
|
Maven repository host (if not using fully defined url; will fallback to service) |
prefix_MAVEN_REPO_ID |
|
Maven repository id |
prefix_MAVEN_REPO_LAYOUT |
|
Maven repository layout |
prefix_MAVEN_REPO_NAME |
|
Maven repository name |
prefix_MAVEN_REPO_PASSPHRASE |
|
Maven repository passphrase |
prefix_MAVEN_REPO_PASSWORD |
|
Maven repository password |
prefix_MAVEN_REPO_PATH |
|
Maven repository path (if not using fully defined url; will fallback to service) |
prefix_MAVEN_REPO_PORT |
|
Maven repository port (if not using fully defined url; will fallback to service) |
prefix_MAVEN_REPO_PRIVATE_KEY |
|
Maven repository private key |
prefix_MAVEN_REPO_PROTOCOL |
|
Maven repository protocol (if not using fully defined url; will fallback to service) |
prefix_MAVEN_REPO_RELEASES_CHECKSUM_POLICY |
|
Maven repository releases checksum policy |
prefix_MAVEN_REPO_RELEASES_ENABLED |
|
Maven repository releases enabled |
prefix_MAVEN_REPO_RELEASES_UPDATE_POLICY |
|
Maven repository releases update policy |
prefix_MAVEN_REPO_SERVICE |
|
Maven repository service to lookup if prefix_MAVEN_REPO_URL not specified |
prefix_MAVEN_REPO_SNAPSHOTS_CHECKSUM_POLICY |
|
Maven repository snapshots checksum policy |
prefix_MAVEN_REPO_SNAPSHOTS_ENABLED |
|
Maven repository snapshots enabled |
prefix_MAVEN_REPO_SNAPSHOTS_UPDATE_POLICY |
|
Maven repository snapshots update policy |
prefix_MAVEN_REPO_URL |
Maven repository url (fully defined) |
|
prefix_MAVEN_REPO_USERNAME |
|
Maven repository username |