Cloud Manager 环境变量 environment-variables

可以通过 Cloud Manager 配置和管理标准环境变量。这些变量提供给运行时环境,可以在 OSGi 配置中使用。根据所更改的内容,环境变量可以是特定于环境的值或环境密钥。

概述 overview

环境变量为 AEM as a Cloud Service 的用户提供了许多好处:

  • 这些变量允许代码和应用程序的行为根据上下文和环境而变化。例如,它们可以用于在开发环境中启用与生产或暂存环境不同的配置,以避免代价高昂的错误。
  • 它们只需要配置和设置一次,必要时可以更新和删除。
  • 它们的值可以在任何时间点更新并立即生效,而无需进行任何代码更改或部署。
  • 它们可以将代码与配置分离,并消除在版本控制中包含敏感信息的需要。
  • 因其位于代码之外,它们提高了 AEM as a Cloud Service 应用程序的安全性。

使用环境变量的典型用例包括:

  • 将 AEM 应用程序与不同的外部端点连接
  • 在存储密码时使用引用,而不是直接在代码库中引用
  • 当一个程序中存在多个开发环境且某个环境的某些配置不同时

添加环境变量 add-variables

NOTE
您必须是​部署管理员 ​角色成员,才能添加或修改环境变量。
  1. 登录 Adobe Cloud Manager,网址为 my.cloudmanager.adobe.com

  2. 我的项目群 屏幕中,选择要管理的项目。

  3. 为所选程序选择​ 环境 ​选项卡,然后在左侧导航面板中选择要为其创建环境变量的环境。

  4. 在环境的详细信息中,选择​ 配置 ​选项卡,然后选择​ 添加,打开​ 环境配置 ​对话框。

    • 如果您是首次添加环境变量,则可以看到 添加配置 按钮进行标记。 您可以使用此按钮或​ 添加 ​功能,打开​ 环境配置 ​对话框。

    配置选项卡

  5. 输入变量详细信息。

    • 名称
    • 应用的服务 – 定义变量适用于哪个服务(作者/发布/预览),或者是否适用于所有服务
    • 类型 – 定义变量是普通变量还是密钥

    添加变量

  6. 输入新变量后,必须在包含新变量的行的最后一列中选择​ 添加

    • 通过输入新行并选择​ 添加,可以一次输入多个变量。

    保存变量

  7. 选择​ 保存 ​来保存变量。

状态为​ 更新 ​的指标显示在表的顶部和新添加的变量旁边,表示正在使用配置更新环境。完成后,新的环境变量会显示在表中。

更新变量

TIP
如果要添加多个变量,建议添加第一个变量,然后使用 添加 中的按钮 环境配置 对话框以添加其他变量。 这样,您可以通过对环境的一次更新来添加变量。

更新环境变量 update-variables

创建环境变量后,您可以使用​ 添加/更新 ​按钮来更新这些变量,从而启动​ 环境配置 ​对话框。

  1. 登录 Adobe Cloud Manager,网址为 my.cloudmanager.adobe.com

  2. Cloud Manager 列出了可用的各种项目。选择要管理的项目。

  3. 为所选程序选择​ 环境 ​选项卡,然后在左侧导航面板中选择要为其创建环境变量的环境。

  4. 在环境的详细信息中,选择​ 配置 ​选项卡,然后在右上方选择​ 添加/更新,打开​ 环境配置 ​对话框。

    变量添加/更新按钮

  5. 使用要修改的变量行最后一列中的省略号按钮,选择 编辑删除.

    编辑或删除变量

  6. 根据需要编辑环境变量。

    • 编辑时,省略号按钮将更改为选项,恢复到原始值或确认更改。
    • 编辑密钥时,只能更新值,不能查看。

    编辑变量

  7. 进行所需的配置更改后,选择 保存.

当添加变量时,状态为​ 更新 ​的指标会显示在表的顶部和新更新的变量旁边,表示正在使用该配置更新环境。完成后,更新的环境变量会显示在表中。

TIP
如果要更新多个变量,建议使用 环境配置 对话框,以便在点击或单击之前立即更新所有必需的变量 保存. 这样,您可以通过对环境的一次更新来添加变量。

使用环境变量 using

环境变量可以使您的 pom.xml 配置更安全、更灵活。例如,密码不需要硬编码,您的配置可以根据环境变量中的值进行调整。

您可以通过 XML 访问环境变量和密钥,如下所示。

  • ${env.VARIABLE_NAME}

有关如何在 pom.xml 文件中同时使用这两种类型的变量的示例,请参阅文档设置项目

有关更多详细信息,请参阅Maven 官方文档

环境变量可用性 availability

可在多个位置使用环境变量。

“创作”、“预览”和“发布” author-preview-publish

常规环境变量和密钥均可用于创作、预览和发布环境。

Dispatcher dispatcher

只有常规环境变量可用于 Dispatcher。无法使用密钥。

但是,无法在 IfDefine 指令中使用环境变量。

TIP
应验证可将环境变量在本地用于 Dispatcher 后再部署。

OSGi 配置 osgi

可在 OSGi 配置中使用常规环境变量和密钥。

管道变量 pipeline

除了环境变量,还有在构建阶段公开的管道变量。可在此处详细了解管道变量。

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab