Documentation

環境変数の定義

環境変数は動的なプレースホルダーのセットであり、環境内でのサービスの動作に影響を与える可能性があります。

環境変数の定義は、DXP Cloudのコンソールから行うか、各サービスの LCP.jsonファイルを設定することでできます。

注釈

DXP Cloudは常に最新の変更を設定に適用します。 LCP.jsonファイルで最新の変更が行われた場合、再起動時に、環境変数がWebコンソールに反映されます。 ただし、Webコンソールで環境変数が変更された場合、コンテナはそれらの新しい構成で再起動されます。

DXP Cloudコンソールを介した環境変数の定義

DXP Cloudのコンソールから、サービスの環境変数を追加、変更、または削除することができます。 この方法でサービスを設定すると、すべての変数は、定義されたプロジェクト環境にスコープされます。

警告

サービスの環境変数を更新すると、その変更を適用するためにサービスが再起動します。 再起動中、サービスは数分間リクエストの受信を停止し、変数の値によっては異なる動作をすることがあります。

DXP Cloudのコンソールからサービスに環境変数を追加するには、以下の手順に従ってください:

  1. プロジェクト環境に移動します。

  2. 環境メニューの サービス をクリックします。

  3. 設定したいサービスをクリックします。

  4. 環境変数] タブをクリックします。

    図1:サービスの [環境変数]タブに移動します。

  5. 新しい環境変数をキーと値のペアで入力します。 次の例では、LiferayDXPサービスのクラスタリングを無効にします:

    *キーLCP_PROJECT_LIFERAY_CLUSTER_ENABLED *false

  6. Save Changes をクリックすると、新しい環境変数でサービスが再起動します。

環境変数をサービスに追加した後は、サービスの [環境変数] タブからいつでもその環境変数を削除したり値を変更したりできます。

変数を削除するには、 [削除] ボタン(⨉)をクリックします。

変数の値を変更するには、 [Show] のアイコンをクリックして、新しい値を入力します。

変数の削除や変更が完了したら、 [Save Changes] をクリックして、環境変数が更新された状態でサービスを再起動します。

図2: [アイコンを表示]をクリックして、変数の値を表示および編集します。

LCP.jsonによる環境変数の定義

サービスの環境変数は、 LCP.json ファイルの env プロパティを使って定義できます。 この方法でサービスを設定すると、すべての環境または選択した環境のサービスの動作を定義できます。

次の例では、 LCP_PROJECT_LIFERAY_CLUSTER_ENABLED 変数に trueという値を定義しています。 この変数は、特に指定がない限り、すべての環境にデフォルトで適用されるトップレベルの属性として設定されます。

{
  "id": "liferay",
  "image": "liferaycloud/liferay-dxp:7.2-4.0.0",
  "env": {
    "LCP_PROJECT_LIFERAY_CLUSTER_ENABLED": "true"
  }
}

次の例では、トップレベル属性の例外を作成し、 dev 環境のLCP_PROJECT_LIFERAY_CLUSTER_ENABLED 変数に falseの値を定義しています。

{
  "environments": {
    "dev": {
      "env": {
        "LCP_PROJECT_LIFERAY_CLUSTER_ENABLED": "false"
      }
    }
  }
}

サービスの LCP.json ファイルの編集が完了したら、環境変数を更新するために変更内容を保存してデプロイします。 詳細は、 DXP Cloudのデプロイメントワークフローの概要 を参照してください。

秘密の環境変数

通常の環境変数には、特別なセキュリティ対策はありません。 DXP Cloudプロジェクトにアクセスできるすべてのユーザーは、サービスの変数値も見ることができます。

機密性の高い変数値(ログイン認証情報など)を保存するには、シークレットを使用することができます。 シークレットはバックエンドで暗号化され、 管理者 役割がないユーザーから非表示にすることができます。 また、通常の環境変数は値を確保するために シークレットを参照 することができます。 詳しくは、 シークレットで安全な環境変数を管理 をご覧ください。