Cloud Managerの環境変数 environment-variables
標準環境変数は、Cloud Manager を介して設定および管理できます。これらは実行時環境に提供され、OSGi 設定で使用できます。
環境変数には、環境固有の値または環境シークレットを変更内容に応じて指定できます。
環境変数について overview
環境変数は、AEM as a Cloud Serviceのユーザーに次のような多くの利点を提供します。
- コードやアプリケーションの動作を、コンテキストや環境に応じて変化させることができます。例えば、実稼動環境やステージング環境と比較して開発環境で異なる設定を有効にして、コストのかかるミスを避けることができます。
- 設定とセットアップは 1 回だけで済み、必要に応じて更新や削除が可能です。
- 値は任意の時点で更新でき、コードの変更やデプロイメントを行う必要なく、即座に有効になります。
- 設定からコードを分離でき、バージョン管理に機密情報を含める必要がありません。
- コードの外部に存在するので、AEM as a Cloud Service アプリケーションのセキュリティが向上します。
環境変数を使用した一般的なユースケースを次に示します。
- 別の外部エンドポイントを使用した AEM アプリケーションの接続
- パスワードをコードベースに直接格納する代わりに、参照を使用する場合
- 1 つのプログラムに開発環境が複数あり、環境によって一部の設定が異なる場合
環境変数の追加 add-variables
Adobe複数の変数を追加する場合は、最初の変数を追加してから、「 」ダイアログの「Add icon Add」を使用してその他の変数を追加することをお勧めします。 つまり、1 回の更新で環境に追加できます。
環境変数を追加、更新、削除するには、デプロイメントマネージャー 役割のメンバーである必要があります。
環境変数を追加するには:
-
my.cloudmanager.adobe.com で Cloud Manager にログインし、適切な組織を選択します。
-
マイプログラム コンソールで、管理する項目を選択します。
-
サイドメニューで、「環境」をクリックします。
-
環境 ページで、環境変数を追加する環境があるテーブルの行を選択します。
-
環境の詳細ページで、「設定」タブをクリックします。
-
追加/更新 をクリックします。
初めて環境変数を追加する場合は、ページの中央にある 設定を追加 をクリックします。 -
環境設定 ダイアログボックスで、テーブルの最初の行に詳細を入力します。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 フィールド 説明 名前 設定変数の一意の名前。 環境で使用される特定の変数を識別します。 次の命名規則に従う必要があります。
- 変数には、英数字とアンダースコア(
_
)のみを含めることができます。 - 変数の数は環境ごとに最大 200 個までです。
- 名前は 100 文字以下にする必要があります。
値 変数が保持する値。 適用されたステップ 変数を適用するサービスを選択します。 「すべて」を選択すると、変数がすべてのサービスに適用されます。
- すべて
- 作成者
- 公開
- プレビュー
タイプ 変数が標準かシークレットかを選択します。 - 変数には、英数字とアンダースコア(
-
追加 をクリックします。
必要に応じて、変数を追加します。
-
「保存」をクリックします。
ステータスが 更新中 のスピナーがテーブルの右上隅に表示されます。 新しく追加した変数の左側には、編集ボックスも表示されます。 これらのステータスは、設定で環境が更新されていることを示します。 完了すると、新しい環境変数が表に表示されます。
環境変数の更新 update-variables
環境変数を作成したら、 追加/更新 を使用して環境変数を更新し、環境設定 ダイアログボックスを開くことができます。
複数の変数を更新する場合は、「Adobe設定」ダイアログボックスを使用して、必要なすべての変数を一度に更新してから、「保存」をクリックすることをお勧めします。 これにより、1 回の更新で環境に追加できます。
環境変数を更新するには:
-
my.cloudmanager.adobe.com で Cloud Manager にログインし、適切な組織を選択します。
-
マイプログラム コンソールで、管理する項目を選択します。
-
サイドメニューで、「環境」をクリックします。
-
環境 ページで、変数を更新する環境があるテーブルの行を選択します。
-
環境の詳細ページで、「設定」タブをクリックします。
-
追加/更新 をクリックします。
-
環境設定 ダイアログボックスで、変更する変数の行の最後の列にある をクリックします。
-
ドロップダウンメニューで、「編集」をクリックします。
-
必要に応じて、環境変数の値を更新します。
秘密鍵を編集する場合、値は更新のみ可能で、表示はできません。 -
次のいずれかの操作を行います。
- をクリックして、変更を適用します。
- をクリックして、変更を取り消します。
-
「保存」をクリックします。
ステータスが 更新中 のスピナーがテーブルの右上隅に表示されます。 更新された変数の左側には、編集ボックスも表示されます。 これらのステータスは、設定で環境が更新されていることを示します。 完了後、更新された環境変数がテーブルに表示されます。
環境変数の削除 delete-env-variable
- my.cloudmanager.adobe.com で Cloud Manager にログインし、適切な組織を選択します。
- マイプログラム コンソールで、管理する項目を選択します。
- サイドメニューで、「環境」をクリックします。
- 環境 ページで、変数を更新する環境があるテーブルの行を選択します。
- 環境の詳細ページで、「設定」タブをクリックします。
- 追加/更新 をクリックします。
- 環境設定 ダイアログボックスで、変更する変数の行の最後の列にある をクリックします。
- ドロップダウンメニューで 削除 をクリックして、変数をすぐに削除します。
- 「保存」をクリックします。
環境変数の使用 using
環境変数を使用すると、pom.xml
設定の安全性と柔軟性を高めることができます。例えば、パスワードをハードコードする必要はなく、環境変数の値に基づいて設定を適応させることができます。
次のように、XML を使用して環境変数とシークレットにアクセスできます。
${env.VARIABLE_NAME}
pom.xml
ファイルで両方のタイプの変数を使用する方法の例については、 プロジェクトの設定を参照してください。
詳しくは、Maven の公式ドキュメントも参照してください。
環境変数の可用性 availability
環境変数は、次の複数の場所で使用できます。
Dispatcher で使用できるのは、通常の環境変数のみです。
- 秘密鍵は使用できません。
- 環境変数は、
IfDefine
ディレクティブでは使用できません。 - デプロイする前に、Dispatcher をローカルで使用して、環境変数の使用を検証します。