8.3. 設定環境変数

以下の環境変数を設定すると再ビルドせずにイメージを調整することができます。

注記

ここに記載されていない他の環境変数については、JBoss EAP のドキュメント を参照してください。

表8.2 設定環境変数

変数名説明

AB_JOLOKIA_AUTH_OPENSHIFT

OpenShift TLS 通信のクライアント認証を切り替えます。このパラメーターの値は truefalse または提供されるクライアントの証明書に含まれる必要がある相対識別名になります。デフォルトの CA 証明書は /var/run/secrets/kubernetes.io/serviceaccount/ca.crt に設定されます。

  • OpenShift TLS 通信のクライアント認証を無効にする場合は false に設定します。
  • デフォルトの CA 証明書とクライアントプリンシパルを使用して OpenShift TLS 通信のクライアント認証を有効にするには、true を設定します。
  • OpenShift TLS 通信のクライアント認証を有効にし、クライアントプリンシパルはオーバーライドするには、cn=someSystem などの相対識別名に設定します。提供されるクライアントの証明書にこの識別名が含まれている必要があります。

AB_JOLOKIA_CONFIG

設定した場合、Jolokia リファレンスドキュメント に説明があるように、この完全修飾ファイルパスを Jolokia JVM エージェントプロパティーに使用します。独自の Jolokia プロパティー設定ファイルを設定した場合、このドキュメントの残りの Jolokia 設定は無視されます。

設定しない場合、Jolokia リファレンスドキュメントに定義された設定を使用して、/opt/jolokia/etc/jolokia.properties が作成されます。

値の例: /opt/jolokia/custom.properties

AB_JOLOKIA_DISCOVERY_ENABLED

Jolokia の検索を有効にします。

デフォルトは false です。

AB_JOLOKIA_HOST

バインド先のホストアドレス。

デフォルトは 0.0.0.0 です。

値の例: 127.0.0.1

AB_JOLOKIA_HTTPS

HTTPS を使用したセキュアな通信を有効にします。

デフォルトでは、AB_JOLOKIA_OPTSserverCert 設定の指定がないと、自己証明サーバー証明書が生成されます。

値の例: true

AB_JOLOKIA_ID

使用するエージェント ID。

デフォルト値はコンテナー ID の $HOSTNAME です。

値の例: openjdk-app-1-xqlsj

AB_JOLOKIA_OFF

true に設定すると、Jolokia のアクティベートを無効にし、空の値がエコーされます。

Jolokia はデフォルトで有効になります。

AB_JOLOKIA_OPTS

エージェント設定に追加されるその他のオプション。key=value, key=value, …​ の形式で表示される必要があります。

値の例: backlog=20

AB_JOLOKIA_PASSWORD

Basic 認証のパスワード。

デフォルトでは認証は無効になっています。

値の例: mypassword

AB_JOLOKIA_PASSWORD_RANDOM

AB_JOLOKIA_PASSWORD が無作為に生成されるべきかどうかを決定します。

パスワードを無作為に生成する場合は true に設定します。生成された値は /opt/jolokia/etc/jolokia.pw ファイルに保存されます。

AB_JOLOKIA_PORT

リッスンするポート。

デフォルトは 8778 です。

値の例: 5432

AB_JOLOKIA_USER

Basic 認証に使用するユーザーの名前。

デフォルトは jolokia です。

値の例: myusername

AB_PROMETHEUS_ENABLE

true に設定すると、この値により、Prometheus 形式のメトリクスを公開する jmx-exporter java エージェントが有効になります。デフォルトは false に設定されます。

注記

MicroProfile Metrics サブシステムは、データを Prometheus 形式で公開するための推奨される方法です。MicroProfile Metrics サブシステムの詳細は、JBoss EAP設定ガイド Eclipse MicroProfile を参照してください。

AB_PROMETHEUS_JMX_EXPORTER_CONFIG

jmx-exporter エージェントがによりデフォルトの configuration.yaml ファイルの代わりに使用する、ユーザーが定義した configuration.yaml に対するコンテナー内のパス。追加の設定ファイルを取り入れる S2I メカニズムの詳細は、S2I アーティファクト を参照してください。

AB_PROMETHEUS_JMX_EXPORTER_PORT

jmx-exporter エージェントが Prometheus サーバーからスクレープをリッスンするポート。デフォルト値は 9799 です。エージェントは localhost をリッスンします。アプリケーションに、このエンドポイントを公開するサービスを含めるように DeploymentConfig ファイルを設定することで、メトリックをコンテナーの外部で使用できるようにできます。

CLI_GRACEFUL_SHUTDOWN

ゼロでない長さの値が設定された場合、イメージは TERM シグナルでシャットダウンしないようにし、JBoss EAP 管理 CLI を使用した shutdown コマンドの実行が必要になります。

値の例: true

CONTAINER_HEAP_PERCENT

最大 Java ヒープサイズを利用可能なコンテナーメモリーの割合 (パーセント) として設定します。

値の例: 0.5

CUSTOM_INSTALL_DIRECTORIES

S2I プロセス中にイメージのアーティファクトのインストールおよび設定に使用されるディレクトリーのコンマ区切りリスト。

値の例: custom,shared

DEFAULT_JMS_CONNECTION_FACTORY

この値は、JMS 接続ファクトリーのデフォルトの JNDI バインディングを指定するために使用されます (例: jms-connection-factory='java:jboss/DefaultJMSConnectionFactory')。

値の例: java:jboss/DefaultJMSConnectionFactory

DISABLE_EMBEDDED_JMS_BROKER

OpenShift コンテナーでの組み込みメッセージングブローカーの使用は非推奨となりました。組み込みブローカーのサポートは今後のリリースで削除されます。

以下の条件が true の場合は、警告がログに記録されます。

  • コンテナーは、埋め込みメッセージングブローカーを使用するよう設定されます。
  • リモートブローカーはコンテナー用に設定されていません。
  • この変数が設定されていないか、false の値で設定されます。

この変数が true に設定された値に含まれる場合は、埋め込みメッセージングブローカーは無効になり、警告はログに記録されません。

リモートメッセージング宛先で設定されていないコンテナーの場合は、この変数を true に追加します。

ENABLE_ACCESS_LOG

標準出力チャネルへのアクセスメッセージのロギングを有効にします。

アクセスメッセージのロギングは以下の方法を使用して実装されます。

  • JBoss EAP 6.4 OpenShift イメージはカスタムの JBoss Web Access Log Valve を使用します。
  • JBoss EAP for OpenShift イメージは Undertow AccessLogHandler を使用します。

デフォルトは false です。

INITIAL_HEAP_PERCENT

初期 Java ヒープサイズを最大ヒープサイズの割合 (パーセント) として設定します。

値の例: 0.5

JAVA_OPTS_APPEND

サーバー起動オプション。

値の例: -Dfoo=bar

JBOSS_MODULES_SYSTEM_PKGS_APPEND

JBOSS_MODULES_SYSTEM_PKGS 環境変数に追加されるパッケージ名のコンマ区切りリスト。

値の例: org.jboss.byteman

JGROUPS_CLUSTER_PASSWORD

JGroups クラスターへの参加を許可するため、ノードの認証に使用されるパスワード。ASYM_ENCRYPT JGroups クラスタートラフィック暗号化プロトコルを使用している場合は必須 になります。設定がないと、認証は無効になり、クラスターの通信は暗号化されず、警告が発生します。SYM_ENCRYPT JGroups クラスタートラフィック暗号化プロトコルを使用する場合は任意です。

値の例: mypassword

JGROUPS_ENCRYPT_KEYSTORE

SYM_ENCRYPT JGroups クラスタートラフィック暗号化プロトコルを使用している場合、JGROUPS_ENCRYPT_SECRET 変数経由で指定されるシークレット内のキーストアファイルの名前。設定しないと、クラスター通信は暗号化されず、警告が発生します。

値の例: jgroups.jceks

JGROUPS_ENCRYPT_KEYSTORE_DIR

SYM_ENCRYPT JGroups クラスタートラフィック暗号化プロトコルを使用している場合、JGROUPS_ENCRYPT_SECRET 変数経由で指定されるシークレット内のキーストアファイルのディレクトリーパス。設定しないと、クラスター通信は暗号化されず、警告が発生します。

値の例: /etc/jgroups-encrypt-secret-volume

JGROUPS_ENCRYPT_NAME

SYM_ENCRYPT JGroups クラスタートラフィック暗号化プロトコルを使用する場合のサーバー証明書に関連する名前。設定しないと、クラスター通信は暗号化されず、警告が発生します。

値の例: jgroups

JGROUPS_ENCRYPT_PASSWORD

SYM_ENCRYPT JGroups クラスタートラフィック暗号化プロトコルを使用する場合にキーストアおよび証明書へのアクセスに使用されるパスワード。設定しないと、クラスター通信は暗号化されず、警告が発生します。

値の例: mypassword

JGROUPS_ENCRYPT_PROTOCOL

クラスタートラフィックの暗号化に使用する JGroups プロトコル。SYM_ENCRYPT または ASYM_ENCRYPT のいずれかになります。

デフォルトは SYM_ENCRYPT です。

値の例: ASYM_ENCRYPT

JGROUPS_ENCRYPT_SECRET

SYM_ENCRYPT JGroups クラスタートラフィック暗号化プロトコルを使用する場合に、JGroups 通信のセキュア化に使用する JGroups キーストア ファイルが含まれるシークレットの名前。設定しないと、クラスター通信は暗号化されず、警告が発生します。

値の例: eap7-app-secret

JGROUPS_PING_PROTOCOL

ノードの検索に使用する JGroups プロトコル。dns.DNS_PING または kubernetes.KUBE_PING のいずれかを使用できます。

MQ_SIMPLE_DEFAULT_PHYSICAL_DESTINATION

後方互換性を維持するには、true を設定し、queue/MyQueue および topic/MyTopic の代わりに MyQueue および MyTopic を物理宛先名のデフォルトとして使用します。

OPENSHIFT_DNS_PING_SERVICE_NAME

DNS 検索メカニズムに対してサーバーで ping ポートを公開するサービスの名前。

値の例: eap-app-ping

OPENSHIFT_DNS_PING_SERVICE_PORT

DNS 検索メカニズムの ping ポートのポート番号。指定のない場合は、サービスの SRV レコードからポート番号を検出を試み、検出できない場合はデフォルトの 8888 が使用されます。

デフォルトは 8888 です。

OPENSHIFT_KUBE_PING_LABELS

Kubernetes 検索メカニズムのクラスターリングラベルセレクター。

値の例: app=eap-app

OPENSHIFT_KUBE_PING_NAMESPACE

Kubernetes 検索メカニズムのクラスターリングプロジェクト namespace。

値の例: myproject

SCRIPT_DEBUG

true に設定すると、Bash スクリプトが -x オプションで実行され、実行と同時にコマンドとその引数が出力されます。