Liferayサービス環境変数
Liferayサービスには 環境変数の範囲 があり、サービスや他のサービスへの接続、DXPのインストール自体を設定するために使用されます。 Liferay Cloud 固有の環境変数を使用することも、DXP ポータルプロパティをオーバーライドする変数を定義することもできます。
ポータルプロパティのオーバーライド
Liferayサービスで環境変数を使用すると、ポータルプロパティファイルで通常定義されている設定を上書きすることができます。
対応する各ポータル プロパティの環境変数名 ("Env") を見つけるには、 ポータル プロパティのドキュメント を確認してください。 例えば、ポータルプロパティ company.default.time.zone を環境変数 LIFERAY_COMPANY_PERIOD_DEFAULT_PERIOD_TIME_PERIOD_ZONEでオーバーライドすることができます。
Liferay サービスに環境変数を追加する方法の詳細については、 環境変数の定義 を参照してください。
ポータルプロパティ名を環境変数に変換する
ポータル プロパティのドキュメント にポータル プロパティの直接翻訳がない場合は、プロパティをオーバーライドする環境変数に自分で変換することもできます。
ポータルプロパティを上書きする環境変数
-
数字で始まってはいけません。
-
前方に
LIFERAY_という接頭語を付けなければなりません。 -
大文字、数字、アンダースコア(
_)のみで構成されていなければなりません。 この制約に適合しない文字は、対応するCharPoolまたは Unicode エンドポイント (10 進数に変換) に変換する必要があります。
これらの要件を満たすためには、すべてのポータルプロパティをこのフォーマットに変換する必要があります。 これにより、Liferay Cloudはフルネームを適切に認識し、対応するポータルプロパティと一致させることができます。
以下の手順で、ポータルプロパティ名を環境変数名に変換します。
-
名前に含まれる文字、数字、アンダースコア(ピリオドを含む)以外の文字を、対応する
CharPoolまたは Unicode エンドポイントに変換し、アンダースコアで囲みます。たとえば、ピリオド文字(
。) を_PERIOD_、または_46_(Unicode を使用している場合) に変更します。 -
変数名の先頭にプレフィックス
LIFERAY_を付けます。 -
任意の文字を大文字に変換します。
例えば、ポータルプロパティ名 setup.wizard.enabledを例にとると、 CharPool というエンドポイントを使って、環境変数の名前に変換することができます。 LIFERAY_SETUP_PERIOD_WIZARD_PERIOD_ENABLEDとなります。
環境変数リファレンス
以下の環境変数は、環境変数UIまたはLiferayサービスの LCP.json ファイルで設定できます。
| 名前 | デフォルト値 | 説明 |
|---|---|---|
LCP_LIFERAY_JDBC_CONNECTION_URL | データベースへの接続に使用されるURLです。 これは、データベース名とホストを直接設定するために使用することができます。 値は、 jdbc:mysql://で始まるものとします。 バージョン4.3.2以降では使用されません。 | |
LCP_LIFERAY_JDBC_CONNECTION_URL_QUERY_STRING | (MySQLについては以下の値を参照) | JDBC 接続クエリ文字列を構成します。 |
LCP_LIFERAY_JDBC_DRIVER | Liferayサービスが使用するMySQLドライバを指定することができます。 DXPバージョン7.0および7.1では、これはクラスター設定にも使用されます。 バージョン4.3.2以降では使用されません。 | |
LCP_PROJECT_LIFERAY_CLUSTER_ENABLED | true | クラスタリングやノード間の通信を有効にするかどうか。 |
LCP_PROJECT_MONITOR_DYNATRACE_TENANT | Dynatrace SaaSアカウントのURL(プレフィックス)の一部となる文字列です。 LCP_PROJECT_MONITOR_DYNATRACE_TOKEN のシークレットと一緒に使用します。 | |
LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_DRIVER_UPPERCASE_CLASS_UPPERCASE_NAME | データベース ドライバーを変更するには、 jdbc.default.driverClassName Liferay ポータル プロパティ を変更します。 これを変更すると、Liferay がデータベースに接続できなくなる可能性があります。 | |
LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_URL | (以下の値を参照) | jdbc.default.url Liferay ポータルプロパティ を変更して、JDBC URL を上書きします。 これを変更すると、Liferay がデータベースに接続できなくなる可能性があります。 |
LIFERAY_JVM_OPTS | -Xms4096m -Xmx12288m | JVM オプション を CATALINA_OPTS に追加して、デフォルトの推奨オプションを上書きします。 推奨事項は、 -Xms を Liferay サービスの使用可能なメモリの 25% に設定し、 -Xmx を 75% に設定し、最後に --add-opens=jdk.zipfs/jdk.nio.zipfs=ALL-UNNAMED を追加することです。 |
デフォルト LCP_LIFERAY_JDBC_CONNECTION_URL_QUERY_STRING 値 (MySQL のみ): characterEncoding=UTF-8&dontTrackOpenResources=true&holdResultsOpenOverStatementClose=true&permitMysqlScheme=true&serverTimezone=GMT&useFastDateParsing=false&useUnicode=true
デフォルト LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_URL 値:
- PostgreSQL の場合: jdbc:postgresql://database--route/lportal
- MySQL の場合: jdbc:mysql://database--route/lportal?characterEncoding=UTF-8&dontTrackOpenResources=true&holdResultsOpenOverStatementClose=true&permitMysqlScheme=true&serverTimezone=GMT&useFastDateParsing=false&useUnicode=true
シークレット
代わりに、これらの変数は Liferay サービスの Secrets として定義される必要があります 。
| 名前 | 説明 |
|---|---|
LCP_PROJECT_MONITOR_DYNATRACE_TOKEN | Dynatrace アカウントの Dynatrace のデプロイ → インストールの開始 → PaaS 監視のセットアップ → インストーラーのダウンロードで確認できる文字列。 |
LCP_SECRET_DATABASE_NAME | データベース接続(jdbc、jdbc ping、および読み取り専用のユーザー接続)に使用されるデータベース名です。 |
LCP_SECRET_DATABASE_PASSWORD | jdbc(およびjdbc ping)の設定にのみ使用されるデータベースのパスワードです。 |
LCP_SECRET_DATABASE_READONLY_USER | 読み取り専用ユーザーのユーザー名です。 |
LCP_SECRET_DATABASE_READONLY_USER_PASSWORD | 読み取り専用ユーザーのパスワードです。 |
LCP_SECRET_DATABASE_USER | プライマリデータベースユーザーのユーザー名です。 jdbcおよびjdbc pingの接続に使用されます。 |