20. マイクロサービスプロファイル

マイクロサービスプロファイルに関する設定について説明します。

20.1. WebOTX Uber JAR 起動オプション

WebOTX Uber JAR で指定できる起動オプションの一覧を以下の表に示します。

起動オプション設定項目一覧
設定項目名 説明 設定値の範囲 既定値
--basedir WebOTX Uber JAR を展開する先のディレクトリを指定します。
このオプションを指定しない場合は、一時ディレクトリにディレクトリが一意の名前で作成され、WebOTX Uber JAR が展開されます。
もし、このオプションで指定したディレクトリに対して WebOTX Uber JAR の展開が失敗した場合は、WebOTX Uber JAR の起動に失敗します。
既に --basedir で指定された先のディレクトリ配下に WebOTX ディレクトリが存在する場合は、WebOTX Uber JAR の再展開はせず、そのディレクトリをそのまま使用します。

Caution
展開先ディレクトリにマルチバイト文字を含むパスを使用することはできません。
[ 注意制限事項 > 機能ごとの注意制限事項 > マイクロサービス > マイクロサービスプロファイル(Uber JAR) > 注意事項 > マイクロサービスプロファイル(Uber JAR)の展開先ディレクトリにマルチバイト文字を含むパスを使用することはできない ]

展開先のディレクトリパス 一時ディレクトリ
--delete-on-exit このオプションを指定した場合、ドメイン停止時に WebOTX Uber JAR を展開したディレクトリを削除します。
--basedir を指定した場合は、既定値は false が設定されます。 --baseidir を指定していない場合、既定値は true が設定されます。
true, false --basedir を指定した場合: false
--basedir を指定していない場合: true
--embedded-iiop-service-enabled 組み込みIIOPサービス(組込みIIOPリスナ)の有効化/無効化を指定します。
有効化すると JNDI管理ツールから WebOTX Uber JAR 内のJNDIの情報を参照することができます。
true, false domain.xml の設定値
(初期状態はfalse)
--embedded-iiop-service-port 組み込みIIOPサービスが使用するポート番号を指定します。このオプションにて複数のポート番号を指定することはできません。 1-65535 domain.xml の設定値
--http-enabled HTTP リスナの有効化/無効化を指定します。 true, false domain.xml の設定値
--http-port HTTPポート番号を指定します。
このオプションにて複数のポート番号を指定することはできません。
複数のポート番号を指定したい場合は、Uber JAR に含まれる domain.xml でリスナを複数定義してポート番号を指定してください。
1-65535 domain.xml の設定値
--https-enabled HTTPS リスナの有効化/無効化を指定します。 true, false domain.xml の設定値
--https-port HTTPSポート番号を指定します。
このオプションにて複数のポート番号を指定することはできません。
複数のポート番号を指定したい場合は、Uber JAR に含まれる domain.xml でリスナを複数定義してポート番号を指定してください。
1-65535 domain.xml の設定値
--log-to-stdio 全てのログを標準出力に出力します。
このオプションは --logconfig と同時に指定することはできません。
--logconfig と同時に指定した場合は、エラーメッセージを出力し起動に失敗します。
- -
--logconfig ログの設定ファイルを指定します。
このオプションを指定した場合、WebOTX Uber JAR 内に含まれる ${INSTANCE_ROOT}/config/log4j2-as.xml を使用せず、指定した設定ファイルを使用します。
- ${INSTANCE_ROOT}/config/log4j2-as.xml
--pre-start-commands ドメイン起動前に実行するコマンドのリストを記述したファイルを指定します。
既定値では、autoconfig 配下に置かれた pre-start-commands.conf ファイルを実行します。
もし、ファイルが存在しない場合は、何も行いません。
このオプションを指定する場合は、必ず指定したファイルのコマンドリストが実行されます。
このオプションを指定しない場合は、初回だけコマンドリストが実行されます。
コマンドリストの記述方法については、[コマンドリストの記述方法] を参照してください。
- pre-start-commands.conf
--post-start-commands ドメイン起動後に実行するコマンドのリストを記述したファイルを指定します。
既定値では、autoconfig 配下に置かれた post-start-commands.conf を実行します。
もし、ファイルが存在しない場合は、何も行いません。
このオプションを指定する場合は、必ず指定したファイルのコマンドリストが実行されます。
このオプションを指定しない場合は、初回だけコマンドリストが実行されます。
コマンドリストの記述方法については、[コマンドリストの記述方法] を参照してください。
- post-start-commands.conf
--post-deploy-commands ユーザーアプリケーション配備後に実行するコマンドのリストを記述したファイルを指定します。
既定値では、autoconfig 配下に置かれた post-deploy-commands.conf を実行します。
ファイルが存在しない場合は、何も行いません。
このオプションを指定する場合は、必ず指定したファイルのコマンドリストが実行されます。
このオプションを指定しない場合は、初回だけコマンドリストが実行されます。
コマンドリストの記述方法については、[コマンドリストの記述方法] を参照してください。
- post-deploy-commands.conf
--secretsdir ユーザー独自の証明書(keystore.jks, cacerts.jks)を格納するする場所をディレクトリのパスで指定します。
指定しない場合は、WebOTX Uber JAR に含まれる ${INSTANCE_ROOT}/config 配下の証明書を使用します。
ディレクトリのパス -
--unpack-only このオプションを指定した場合、WebOTX Uber JAR を起動せずにファイルの展開だけ行います。
このオプションを指定する場合は、必ず --basedir を指定する必要があります。
--basedir を指定しなかった場合は、起動に失敗します。
- -

20.1.1. コマンドリストの記述方法

Uber JAR では、以下のタイミングで任意の otxadmin コマンドを実行することができます。 ただし、ドメイン起動前では set コマンドのみ使用可能です。

設定の反映に再起動が必要な項目の場合、pre-start-commands で指定したファイル内にコマンドを記載します。

例えば、Microprofile のメトリクス値を HTTP で参照したい場合、pre-start-commands に server.microprofile-metrics.secure=false を設定します。

set server.microprofile.microprofile-metrics.secure=false

20.2. WebOTX Uber JAR 環境変数

WebOTX Uber JAR で使用できる環境変数の一覧について、以下の表に示します。

環境変数設定項目一覧
設定項目名 説明 設定値の範囲 既定値
OTX_BASEDIR WebOTX Uber JAR を展開する先のディレクトリを指定します。
起動オプション --basedir と同じ。
- -
OTX_DELETE_ON_EXIT ドメイン停止時に WebOTX Uber JAR を展開したディレクトリを削除するかどうかを指定します。
起動オプション --delete-on-exit と同じ。
true, false
OTX_LICENSE WebOTX のライセンスキーを指定します。複数指定する場合は、カンマ区切りで指定します。
この環境変数を指定しない場合は、お試し版ライセンスで WebOTX Uber JAR を起動します。
- -
OTX_EMBEDDED_IIOP_SERVICE_ENABLED 組み込みIIOPサービス(組込みIIOPリスナ)の有効化/無効化を指定します。
起動オプション --embedded-iiop-service-enabled と同じ。
true, false domain.xml の設定値
(初期状態はfalse)
OTX_EMBEDDED_IIOP_SERVICE_PORT 組み込みIIOPサービスが使用するポート番号を指定します。
起動オプション --embedded-iiop-service-port と同じ。
1-65535 domain.xml の設定値
OTX_HTTP_ENABLED HTTP リスナの有効化/無効化を指定します
起動オプション --http-enabled と同じ。
true, false domain.xml の設定値
OTX_HTTP_PORT HTTP ポート番号を指定します。
起動オプション --http-port と同じ。
1-65535 domain.xml の設定値
OTX_HTTPS_ENABLED HTTPS リスナの有効化/無効化を指定します。
起動オプション --https-enabled と同じ。
true, false domain.xml の設定値
OTX_HTTPS_PORT HTTPS ポート番号を指定します。
起動オプション --https-port と同じ。
1-65535 domain.xml の設定値
OTX_JVM_OPTIONS JVM オプションを指定します。
複数指定する場合はカンマ区切りで指定します。
- -
OTX_LOG_TO_STDIO 全てのログを標準出力に出力します。
起動オプション --log-to-stdio と同じ。
- -
OTX_LOGCONFIG ログの設定ファイルを指定します。
起動オプション --logconfig と同じ。
- -
OTX_PRE_START_COMMANDS ドメイン起動前に実行するコマンドのリストを記述したファイルを指定します。
起動オプション --pre-start-commands と同じ。
- pre-start-commands.conf
OTX_POST_START_COMMANDS ドメイン起動後に実行するコマンドのリストを記述したファイルを指定します。
起動オプション --post-start-commands と同じ。
- post-start-commands.conf
OTX_POST_DEPLOY_COMMANDS ユーザーアプリケーション配備後に実行するコマンドのリストを記述したファイルを指定します。
起動オプション --post-deploy-commands と同じ。
- post-deploy-commands.conf
OTX_SECRETS_DIR ユーザー独自の証明書(keystore.jks, cacerts.jks)を格納するする場所をディレクトリのパスで指定します。
起動オプション --secretsdir と同じ。
ディレクトリのパス -
OTX_UNPACK_ONLY このオプションを指定した場合、WebOTX Uber JAR を起動せずにファイルの展開だけ行います。
起動オプション --unpack-only と同じ。
- -

Caution
起動オプションと環境変数の両方で同じ項目の設定を行った場合は、環境変数が優先されます。