Cloud Manager の環境変数 environment-variables

標準環境変数は、Cloud Manager を介して設定および管理できます。これらはランタイム環境に提供され、OSGi 設定で使用できます。

環境変数には、変更内容に応じて、環境固有の値または環境シークレットのいずれかを指定できます。

環境変数について overview

環境変数は、AEM as a Cloud Service のユーザーに次のような多くの利点を提供します。

  • コードやアプリケーションの動作を、コンテキストや環境に応じて変化させることができます。例えば、本番環境やステージング環境とは異なる設定を開発環境で有効にして、コストのかかるミスを避けることができます。
  • 設定とセットアップは 1 回だけで済み、必要に応じて更新や削除が可能です。
  • 値は任意の時点で更新でき、コードの変更やデプロイメントを行う必要なく、即座に有効になります。
  • 設定からコードを分離でき、バージョン管理に機密情報を含める必要がありません。
  • コードの外部に存在するので、AEM as a Cloud Service アプリケーションのセキュリティが向上します。

環境変数を使用した一般的なユースケースを次に示します。

  • 別の外部エンドポイントを使用した AEM アプリケーションの接続
  • パスワードをコードベースに直接格納する代わりに、参照を使用する場合
  • 1 つのプログラムに開発環境が複数あり、環境によって一部の設定が異なる場合

環境変数の追加 add-variables

複数の変数を追加する場合、アドビでは、最初の変数を追加してから、環境設定​ダイアログの 追加アイコン 追加」を使用してその他の変数を追加することをお勧めします。この方法により、1 回の更新で環境に追加できます。

環境変数を追加、更新、または削除するには、デプロイメントマネージャーの​役割のメンバーである必要があります。

環境変数を追加するには:

  1. my.cloudmanager.adobe.com で Cloud Manager にログインし、適切な組織を選択します。

  2. マイプログラム​コンソールで、管理する項目を選択します。

  3. サイドメニューで、「環境」をクリックします。

  4. 環境​ページで、環境変数を追加する環境が含まれるテーブルの行を選択します。

  5. 環境の詳細ページで、「設定」タブをクリックします。

  6. 追加/更新 - 追加の円アイコン 追加/更新」をクリックします。
    初めて環境変数を追加する場合は、ページの中央の「設定を追加」をクリックします。

    「設定」タブ

  7. 環境設定​ダイアログボックスで、テーブルの最初の行に詳細を入力します。

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
    フィールド 説明
    名前

    設定変数の一意の名前です。環境で使用される特定の変数を識別します。次の命名規則に従う必要があります。

    • 変数には、英数字とアンダースコア(_)のみ使用できます。
    • 変数の数は環境あたり最大 200 個までです。
    • 名前は 100 文字以下にする必要があります。
    変数が保持する値です。
    適用されたステップ

    変数を適用するサービスを選択します。すべてのサービスに変数を適用するには、「すべて」を選択します。

    • すべて
    • 作成者
    • 公開
    • プレビュー
    タイプ 変数が通常か秘密鍵かを選択します。

    変数の追加

  8. 追加アイコン 追加」をクリックします。

    必要に応じて、変数を追加します。

  9. 保存」をクリックします。

    ステータスが​ 更新中 ​のスピナーがテーブルの右上隅に表示されます。また、新しく追加した変数の左側にもスピナーが表示されます。これらのステータスは、環境が設定によって更新されていることを示します。完了すると、新しい環境変数が表に表示されます。

変数の更新

環境変数の更新 update-variables

環境変数を作成したら、 追加/更新 - 追加の円アイコン 追加/更新」を使用して​ 環境設定 ​ダイアログボックスを開き、環境変数を更新できます。

複数の変数を更新する場合、アドビでは、環境設定​ダイアログを使用して、必要なすべての変数を一度に更新してから、「保存」をクリックすることをお勧めします。これにより、1 回の更新で環境にそれらの変数を追加できます。

環境変数を更新するには:

  1. my.cloudmanager.adobe.com で Cloud Manager にログインし、適切な組織を選択します。

  2. マイプログラム​コンソールで、管理する項目を選択します。

  3. サイドメニューで、「環境」をクリックします。

  4. 環境​ページで、環境変数を更新する環境が含まれるテーブルの行を選択します。

  5. 環境の詳細ページで、「設定」タブをクリックします。

  6. 追加/更新 - 追加の円アイコン 追加/更新」をクリックします。

  7. 環境設定​ダイアログボックスで、変更する変数の行の最後の列にある 省略記号 - その他アイコン をクリックします。

  8. ドロップダウンメニューで、「編集」をクリックします。

    変数を編集または削除

  9. 必要に応じて、環境変数の値を更新します。
    秘密鍵を編集する場合、値は更新のみ可能で、表示はできません。

    変数の編集

  10. 次のいずれかの操作を行います。

    • 適用 - チェックマークアイコン をクリックして、変更を適用します。
    • 取り消しアイコン をクリックして、変更を取り消します。
  11. 保存」をクリックします。

    ステータスが​ 更新中 ​のスピナーがテーブルの右上隅に表示されます。また、更新した変数の左側にもスピナーが表示されます。これらのステータスは、環境が設定によって更新されていることを示します。完了すると、更新された環境変数がテーブルに表示されます。

環境変数の削除 delete-env-variable

  1. my.cloudmanager.adobe.com で Cloud Manager にログインし、適切な組織を選択します。
  2. マイプログラム​コンソールで、管理する項目を選択します。
  3. サイドメニューで、「環境」をクリックします。
  4. 環境​ページで、環境変数を更新する環境が含まれるテーブルの行を選択します。
  5. 環境の詳細ページで、「設定」タブをクリックします。
  6. 追加/更新 - 追加の円アイコン 追加/更新」をクリックします。
  7. 環境設定​ダイアログボックスで、変更する変数の行の最後の列にある 省略記号 - その他アイコン をクリックします。
  8. ドロップダウンメニューで、「削除」をクリックして変数をすぐに削除します。
  9. 保存」をクリックします。

環境変数の使用 using

環境変数を使用すると、pom.xml 設定の安全性と柔軟性を高めることができます。例えば、パスワードをハードコードする必要はなく、環境変数の値に基づいて設定を適応させることができます。

次のように、XML 経由で環境変数と秘密鍵にアクセスできます。

${env.VARIABLE_NAME}

pom.xml ファイルで両方のタイプの変数を使用する方法の例については、プロジェクトの設定を参照してください。

また、詳しくは、Maven の公式ドキュメントも参照してください。

環境変数の可用性 availability

環境変数は、次のように複数の場所で使用できます。

環境変数を使用できる場所
説明
オーサー、プレビュー、パブリッシュ
オーサー、プレビュー、パブリッシュの各環境では、通常の環境変数とシークレットの両方を使用できます。
Dispatcher

Dispatcher で使用できるのは、通常の環境変数のみです。

  • 秘密鍵は使用できません。
  • 環境変数は IfDefine ディレクティブでは使用できません。
  • デプロイする前に、Dispatcher をローカルで使用して、環境変数の使用を検証します。
OSGi 設定
OSGi 設定では、通常の環境変数と秘密鍵の両方を使用できます。
パイプライン変数
環境変数に加えて、ビルドフェーズで公開されるパイプライン変数もあります。パイプライン変数について詳しくは、ビルド環境を参照してください。
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab