fabric8/java-ubi-openjdk11-jdk

Fabric8 Java基础镜像 OpenJDK 11 (JDK)

该镜像基于UBI，提供OpenJDK 11 (JDK)环境。包含以下组件：

• https://github.com/fabric8io/agent-bond代理，集成http://www.jolokia.org和Prometheus的https://github.com/prometheus/jmx_exporter。代理安装路径为`/opt/agent-bond/agent-bond.jar`。配置选项见下文。

• 用于启动Java应用的启动脚本/deployments/run-java.sh。

Agent Bond

要为应用启用Jolokia，需将此镜像作为基础镜像（通过FROM），并在启动脚本中使用agent-bond-opts的输出，将其包含在Java启动选项中。

例如，可在启动Java应用的脚本中添加以下片段：

# ...
export JAVA_OPTIONS="$JAVA_OPTIONS $(agent-bond-opts)"
# .... 启动应用时使用JAVA_OPTIONS，如Tomcat的做法

使用以下版本和默认值：

• http://www.jolokia.org：版本**1.6.2**，端口**8778**
• https://github.com/prometheus/jmx_exporter：版本**0.3.1**，端口**9779**

可通过设置各种环境变量影响agent-bond-opts的行为：

Agent-Bond选项

Agent Bond本身可通过以下环境变量配置：

• AB_OFF：若设置，禁用agent-bond（即输出空值）。默认启用agent-bond。
• AB_ENABLED：启用的子代理逗号分隔列表。当前允许值为jolokia和jmx_exporter。默认两者均启用。

Jolokia配置

• AB_JOLOKIA_CONFIG：若设置，使用此文件（含路径）作为Jolokia JVM代理属性（如Jolokiahttp://www.jolokia.org/reference/html/agents.html#agents-jvm所述）。默认值为/opt/jolokia/jolokia.properties。
• AB_JOLOKIA_HOST：绑定的主机地址（默认：0.0.0.0）
• AB_JOLOKIA_PORT：使用的端口（默认：8778）
• AB_JOLOKIA_USER：认证用户。默认关闭认证。
• AB_JOLOKIA_HTTPS：启用https安全通信。若AB_JOLOKIA_OPTS中未指定serverCert配置，默认生成自签名服务器证书。
• AB_JOLOKIA_PASSWORD：认证密码。默认关闭认证。
• AB_JOLOKIA_ID：使用的代理ID（默认$HOSTNAME，即容器ID）
• AB_JOLOKIA_OPTS：附加到代理选项的额外选项。格式为"key=value,key=value,..."

各种环境集成的选项：

• AB_JOLOKIA_AUTH_OPENSHIFT：为OpenShift TLS通信启用客户端认证。此参数值可为相对专有名称，必须包含在提供的客户端证书中。启用此参数将自动将Jolokia切换到https通信模式。默认CA证书设置为/var/run/secrets/kubernetes.io/serviceaccount/ca.crt

jmx_exporter配置

• AB_JMX_EXPORTER_OPTS：jmx_exporter使用的配置（格式<port>:<配置路径>）
• AB_JMX_EXPORTER_PORT：JMX Exporter使用的端口。默认：9779
• AB_JMX_EXPORTER_CONFIG：jmx_exporter使用的配置路径。默认：/opt/agent-bond/jmx_exporter_config.json

启动脚本 run-java.sh

此镜像的默认命令为https://github.com/fabric8io/run-java-sh。其用途是启动Java应用，这些应用可以是包含所有依赖的fat-jars，或更传统的基于主类的应用（类路径由目录中的所有jar构建）。

对于这些镜像，变量JAVA_APP_DIR的默认值为/deployments

run-java.sh

此通用启动脚本针对在容器中运行Java应用进行了优化。调用方式如下：

./run-java.sh <子命令> <选项>

run-java.sh支持两个子命令：

• options：打印可用于Java应用（如Maven或Tomcat）自行调用的JVM选项。它考虑容器约束，并包含此脚本使用的所有优化。
• run：按以下说明执行Java应用。这也是默认命令，可省略。

运行Java应用

当未指定子命令（或提供默认子命令run）时，脚本默认启动Java应用。

启动过程主要通过环境变量配置：

• JAVA_APP_DIR：应用所在目录。应用中的所有路径均相对于此目录。默认为此启动脚本所在目录。
• JAVA_LIB_DIR：存放Java jar文件的目录，以及可选的classpath文件（包含类路径，可为单行冒号分隔或每行一个jar文件）。若未设置，JAVA_LIB_DIR与JAVA_APP_DIR相同。
• JAVA_OPTIONS：调用java时添加的选项
• JAVA_MAJOR_VERSION：>=7的数字。若设置，仅使用适合此版本的选项。设为7时，将移除仅Java>8支持的选项。版本>=10时，不计算显式内存限制，因为Java>=10支持容器限制。若省略，通过JAVA_VERSION变量、release文件或解析java -version输出来猜测。
• JAVA_MAX_MEM_RATIO：当JAVA_OPTIONS中未指定-Xmx时使用。用于基于容器限制计算默认最大堆内存。若在无内存限制的Docker容器中使用，此选项无效。若有内存限制，-Xmx设为容器可用内存的此比例值。默认情况下，若容器可用内存低于300M，比例为25，否则为50（即使用50%可用内存作为上限）。设为0可跳过此机制，不添加-Xmx选项。
• JAVA_INIT_MEM_RATIO：当JAVA_OPTIONS中未指定-Xms时使用。用于基于容器限制计算默认初始堆内存。若在无内存限制的Docker容器中使用，此选项无效。若有内存限制，-Xms设为容器可用内存的此比例值。默认未设置。
• JAVA_MAX_CORE：手动限制用于计算某些默认值（如垃圾收集器线程数）的核心数。设为0时，不基于核心数进行JVM调优。
• JAVA_DIAGNOSTICS：设置后，发生事件时将诊断信息输出到标准输出。
• JAVA_MAIN_CLASS：作为java参数的主类。设置此环境变量时，$JAVA_APP_DIR中的所有jar文件以及$JAVA_LIB_DIR均添加到类路径。
• JAVA_APP_JAR：具有适当清单的jar文件，若未设置$JAVA_MAIN_CLASS，可通过java -jar启动。无论如何，此jar文件均添加到类路径。
• JAVA_APP_NAME：进程名称
• JAVA_CLASSPATH：使用的类路径。若未设置，启动脚本检查${JAVA_APP_DIR}/classpath文件，将其内容作为类路径。若该文件不存在，添加classes:${JAVA_APP_DIR}/*（即应用目录中的所有jar）。
• JAVA_DEBUG：若设置，启用远程调试
• JAVA_DEBUG_SUSPEND：若设置，启用远程调试的挂起模式
• JAVA_DEBUG_PORT：远程调试使用的端口。默认：5005
• HTTP_PROXY：代理服务器URL，转换为http.proxyHost和http.proxyPort系统属性。
• HTTPS_PROXY：代理服务器URL，转换为https.proxyHost和https.proxyPort系统属性。
• no_proxy、NO_PROXY：应直接访问的主机列表，绕过代理，转换为http.nonProxyHosts系统属性。

若既未设置$JAVA_APP_JAR也未设置$JAVA_MAIN_CLASS，脚本检查$JAVA_APP_DIR中的单个JAR文件，将其作为$JAVA_APP_JAR。若未找到或找到多个jar文件，抛出错误。

类路径由以下部分构建：

• 若设置$JAVA_CLASSPATH，使用此 classpath。
• 首先添加当前目录（"."）。
• 若当前目录与$JAVA_APP_DIR不同，添加$JAVA_APP_DIR。
• 若设置$JAVA_MAIN_CLASS，则：
  • 若设置$JAVA_APP_JAR，添加该JAR
  • 若$JAVA_APP_DIR/classpath文件存在，将其内容追加到类路径。该文件可为单行冒号分隔的jar文件，或多行文件（每行是相对于$JAVA_LIB_DIR的jar路径，$JAVA_LIB_DIR默认与$JAVA_APP_DIR相同）
  • 若该文件不存在，添加${JAVA_APP_DIR}/*，即按字母顺序添加该目录中的所有jar。

这些变量也可在shell配置文件run-env.sh中设置，启动脚本将 sourcing 该文件。此文件可位于启动脚本所在目录或${JAVA_APP_DIR}，后者中的环境变量覆盖脚本目录中run-env.sh的变量。

启动脚本还检查run-java-options命令。若存在，调用该命令并将输出添加到$JAVA_OPTIONS环境变量。

启动脚本还公开描述容器限制的环境变量，供应用使用：

• CONTAINER_CORE_LIMIT：计算的核心限制，如https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt所述
• CONTAINER_MAX_MEMORY：容器的内存限制

传递给脚本的任何参数均直接作为Java应用的参数。

示例：

# 直接设置应用目录
export JAVA_APP_DIR=/deployments
# 基于容器约束设置-Xmx
export JAVA_MAX_MEM_RATIO=40
# 启动JAVA_APP_DIR中的jar并传递参数
./run-java.sh --user maxmorlock --password secret

Options

此脚本还可用于计算在容器中启动Java应用的合理最佳实践选项。例如，在容器中运行Maven时，应考虑容器内存约束。

子命令options可用于将选项输出到标准输出，以便轻松提供给其他Java应用。

若未提供额外参数，将使用所有默认值，可通过上述环境变量影响。

可通过提供额外参数选择特定选项集：

• --debug：若JAVA_DEBUG设置，输出Java调试选项
• --memory：基于给定环境变量的内存设置
• --proxy：评估代理环境变量
• --cpu：核心数受限时的调优
• --gc：GC调优参数
• --jit：JIT选项
• --diagnostics：若JAVA_DIAGNOSTICS设置，输出诊断选项
• --java-default：等同于--memory --jit --diagnostic --cpu --gc

示例：

# 在容器中运行Maven时，使用适当的内存设置
export MAVEN_OPTS="$(run-java.sh options --memory)"
mvn clean install

版本信息：

• 基础镜像：UBI 8.1
• Java：OpenJDK 11（Java开发工具包（JDK））
• Agent-Bond：1.2.0（Jolokia 1.6.2，jmx_exporter 0.3.1）