为Adobe Experience Manager as a Cloud Service配置OSGi configuring-osgi-for-aem-as-a-cloud-service

OSGi是Adobe Experience Manager (AEM)技术栈栈中的基本元素。 它用于控制AEM的复合捆绑包及其配置。

OSGi提供了标准化的基元，允许从小型、可重用的协作组件构建应用程序。 这些组件可以组合为一个应用程序并进行部署。 这样可以轻松地管理OSGi包，因为它们可以单独停止、安装和启动。 系统会自动处理相互依赖关系。 每个OSGi组件都包含在各种捆绑包中。 有关详细信息，请参阅OSGi规范。

您可以通过属于AEM代码项目一部分的配置文件来管理OSGi组件的配置设置。

OSGi配置文件 osgi-configuration-files

配置更改在AEM项目的代码包(ui.config)中定义为运行模式特定的配置文件夹下的配置文件(.cfg.json)：

/apps/example/config.<runmode>

OSGi配置文件的格式基于JSON，使用Apache Sling项目定义的.cfg.json格式。

OSGi配置通过组件的永久标识(PID)来定位OSGi组件，该PID默认为OSGi组件的Java™类名称。 例如，为通过以下方式实施的OSGi服务提供OSGi配置：

com.example.workflow.impl.ApprovalWorkflow.java

在以下位置定义OSGi配置文件：

/apps/example/config/com.example.workflow.impl.ApprovalWorkflow.cfg.json

遵循cfg.json OSGi配置格式。

运行模式分辨率 runmode-resolution

可以使用运行模式将特定OSGi配置定位到特定AEM实例。 要使用runmode，请在/apps/example下创建配置文件夹（例如，您的项目名称），格式为：

/apps/example/config.<author|publish>.<dev|stage|prod>/

如果配置文件夹名称中定义的运行模式与AEM使用的运行模式匹配，则使用此类文件夹中的任何OSGi配置。

例如，如果AEM使用运行模式创作和开发，则应用/apps/example/config.author/和/apps/example/config.author.dev/中的配置节点，而不应用/apps/example/config.publish/和/apps/example/config.author.stage/中的配置节点。

如果同一PID有多个配置适用，则应用匹配运行模式数最多的配置。

此规则的粒度处于PID级别。 这意味着您不能在/apps/example/config.author/中为同一PID定义某些属性，也不能在/apps/example/config.author.dev/中为同一PID定义更具体的属性。 匹配运行模式数最高的配置对整个PID有效。

在进行本地开发时，运行架构启动参数 -r 用于指定运行架构 OSGI 配置。

$ java -jar aem-sdk-quickstart-xxxx.x.xxx.xxxx-xxxx.jar -r publish,dev

验证运行模式

AEM as a Cloud Service运行模式根据环境类型和服务进行良好的定义。 查看可用AEM as a Cloud Service运行模式的完整列表。

可以通过以下方式验证由运行模式指定的OSGi配置值：

结果视图将显示选定层的所有OSGi组件配置及其适用的OSGi配置值。 这些值可以与AEM项目源代码中/apps/example/osgiconfig/config.<runmode(s)>下的OSGi配置值交叉引用。

要验证是否应用了适当的OSGi配置值，请执行以下操作：

OSGi配置值的类型 types-of-osgi-configuration-values

有三种类型的OSGi配置值可以与Adobe Experience Manager as a Cloud Service一起使用。

如何选择适当的OSGi配置值类型 how-to-choose-the-appropriate-osgi-configuration-value-type

OSGi的常见用例使用内联OSGi配置值。 特定于环境的配置仅用于开发环境之间的值不同的特定用例。

特定环境的配置扩展了包含内联值的静态定义的传统OSGi配置，提供了通过Cloud Manager API从外部管理OSGi配置值的功能。 了解何时使用定义内联值并将其存储在Git中的常见传统方法以及何时将值抽象为特定于环境的配置非常重要。

以下指南介绍了何时使用特定于非机密和机密环境的配置：

何时使用内联配置值 when-to-use-inline-configuration-values

内联配置值被视为标准方法，应尽可能使用。 内联配置具有以下优势：

无论何时定义OSGi配置值，都从内联值开始，并且仅当用例需要时才选择机密或特定于环境的配置。

何时使用非机密环境特定的配置值 when-to-use-non-secret-environment-specific-configuration-values

当预览层的值不同或开发环境的值不同时，仅将特定于环境的配置($[env:ENV_VAR_NAME])用于非机密配置值。 这包括本地开发实例和任何Adobe Experience Manager as a Cloud Service开发环境。 除了为预览层设置唯一值之外，请避免为Adobe Experience Manager as a Cloud Service暂存或生产环境使用非机密环境特定的配置。

何时使用特定于机密环境的配置值 when-to-use-secret-environment-specific-configuration-values

Adobe Experience Manager as a Cloud Service要求对任何机密OSGi配置值（如密码、私有API密钥或出于安全原因不能存储在Git中的任何其他值）使用特定于环境的配置($[secret:SECRET_VAR_NAME])。

使用特定于密钥环境的配置来存储所有Adobe Experience Manager as a Cloud Service环境（包括暂存环境和生产环境）上的密钥值。

创建OSGi配置 creating-osgi-configurations

创建OSGi配置的方法有两种，如下所述。 前者通常用于配置自定义OSGi组件，这些组件具有开发人员已知的OSGi属性和值，而后者则用于AEM提供的OSGi组件。

编写OSGi配置 writing-osgi-configurations

JSON格式的OSGi配置文件可以直接在AEM项目中手动编写。 这通常是为已知的OSGi组件（尤其是由定义配置的同一开发人员设计和开发的自定义OSGi组件）创建OSGi配置的最快方法。 此方法还可用于在不同的运行模式文件夹中复制/粘贴和更新同一OSGi组件的配置。

使用AEM SDK快速入门生成OSGi配置 generating-osgi-configurations-using-the-aem-sdk-quickstart

AEM SDK快速入门Jar的AEM Web控制台可用于配置OSGi组件，并将OSGi配置导出为JSON。 这对于配置AEM提供的OSGi组件非常有用，在AEM项目中定义OSGi配置的开发人员可能无法很好地了解这些组件的OSGi属性及其值格式。

OSGi配置属性格式 osgi-configuration-property-formats

内联值 inline-values

内联值的格式为标准的名称 — 值对，遵循标准JSON语法。 例如：

{
   "my_var1": "val",
   "my_var2": [ "abc", "def" ],
   "my_var3": 500
}

特定于环境的配置值 environment-specific-configuration-values

OSGi配置应为打算按环境定义的变量分配占位符：

use $[env:ENV_VAR_NAME]

客户应仅将此技术用于与其自定义代码相关的OSGi配置属性；不得使用此技术覆盖Adobe定义的OSGi配置。

密码配置值 secret-configuration-values

OSGi配置应为要按环境定义的密钥分配一个占位符：

use $[secret:SECRET_VAR_NAME]

变量命名 variable-naming

以下内容适用于特定于环境的配置值和机密配置值。

变量名称必须遵循以下规则：

变量值不得超过2048个字符。

默认值 default-values

以下内容适用于特定于环境的配置值和机密配置值。

如果未设置每个环境的值，则运行时不会替换占位符，并且由于没有发生插值，占位符将保留在原位。 为了避免这种情况，可以使用以下语法将默认值作为占位符的一部分提供：

$[env:ENV_VAR_NAME;default=<value>]

在提供了默认值的情况下，占位符会被替换为每个环境的值（如果提供）或提供的默认值。

本地开发 local-development

以下内容适用于特定于环境的配置值和机密配置值。

变量可以在本地环境中定义，以便在运行时由本地AEM接收。 例如，在Linux®上：

export ENV_VAR_NAME=my_value

建议编写简单的bash脚本，以设置配置中使用的环境变量，并在启动AEM之前执行它。 诸如https://direnv.net/之类的工具有助于简化此方法。 根据值的类型，如果这些值可以在所有人之间共享，则它们可能会被签入源代码管理。

从文件中读取密钥的值。 因此，对于使用密码的每个占位符，必须创建包含密码值的文本文件。

例如，如果使用$[secret:server_password]，则必须创建名为​ server_password ​的文本文件。 所有这些机密文件必须存储在同一目录中，并且框架属性org.apache.felix.configadmin.plugin.interpolation.secretsdir必须使用该本地目录进行配置。

org.apache.felix.configadmin.plugin.interpolation.secretsdir是Sling框架属性；因此此属性不是在felix控制台(https://experienceleague.adobe.com/system/console?lang=zh-Hans)中设置的，而是在系统引导时使用的sling.properties文件中设置的。 此文件可在提取的Jar/install文件夹(crx-quickstart/conf)的/conf子目录中找到。

示例：将此行添加到“crx-quickstart/conf/sling.properties”文件的末尾以将“crx-quickstart/secretsdir”配置为机密文件夹：

org.apache.felix.configadmin.plugin.interpolation.secretsdir=${sling.home}/secretsdir

作者与Publish配置 author-vs-publish-configuration

如果OSGi属性对于创作与发布所需的值不同：

配置示例 configuration-examples

在下面的示例中，假设除了暂存环境和生产环境之外，还有三个开发环境。

示例 1

目的是使OSGi属性my_var1的值对于stage和prod是相同的，但三个开发环境的每个值都不同。

{
 "my_var1"： "val"，
 "my_var2"： "abc"，
 "my_var3"：500
}

{
 "my_var1" ： "$[env：my_var1]"
 "my_var2"： "abc"，
 "my_var3"：500
}

示例 2

目的是使OSGi属性my_var1的值在暂存、生产和三个开发环境的每个中有所不同。 因此，必须调用Cloud Manager API为每个开发环境设置my_var1的值。

{
 "my_var1"： "val1"，
 "my_var2"： "abc"，
 "my_var3"：500
}

{
 "my_var1"： "val2"，
 "my_var2"： "abc"，
 "my_var3"：500
}

{
 "my_var1" ： "$[env：my_var1]"
 "my_var2"： "abc"，
 "my_var3"：500
}

示例 3

目的是使OSGi属性my_var1的值对于暂存、生产和仅其中一个开发环境是相同的，但对于其他两个开发环境不同。 在这种情况下，必须调用Cloud Manager API为每个开发环境（包括应与暂存和生产环境具有相同值的开发环境）设置my_var1值。 它不会继承文件夹​ config ​中设置的值。

{
 "my_var1"： "val1"，
 "my_var2"： "abc"，
 "my_var3"：500
}

{
 "my_var1" ： "$[env：my_var1]"
 "my_var2"： "abc"，
 "my_var3"：500
}

完成此任务的另一种方法是为config.dev文件夹中的替换令牌设置默认值，使其与​ config ​文件夹中的值相同。

{
 "my_var1"： "val1"，
 "my_var2"： "abc"，
 "my_var3"：500
}

{
 "my_var1"： "$[env：my_var1；default=val1]"
 "my_var2"： "abc"，
 "my_var3"：500
}

用于设置属性的Cloud Manager API格式 cloud-manager-api-format-for-setting-properties

有关Cloud Manager API以及应如何配置的信息，请参阅在Adobe Developer网站上AdobeCloud Manager。

通过API设置值 setting-values-via-api

调用API会将新变量和值部署到云环境，类似于典型的客户代码部署管道。 创作和发布服务将重新启动并引用新值，通常需要几分钟的时间。

PATCH /program/{programId}/environment/{environmentId}/variables

[
        {
                "name" : "MY_VAR1",
                "value" : "plaintext value",
                "type" : "string"  <---default
        },
        {
                "name" : "MY_VAR2",
                "value" : "<secret value>",
                "type" : "secretString"
        }
]

通过API获取值 getting-values-via-api

GET /program/{programId}/environment/{environmentId}/variables

有关详细信息，请参阅Cloud Manager API。

通过API删除值 deleting-values-via-api

PATCH /program/{programId}/environment/{environmentId}/variables

要删除变量，请将其包含在空值中。

有关详细信息，请参阅Cloud Manager API。

通过命令行获取值 getting-values-via-cli

$ aio cloudmanager:list-environment-variables ENVIRONMENT_ID
Name     Type         Value
MY_VAR1  string       plaintext value
MY_VAR2  secretString ****

通过命令行设置值 setting-values-via-cli

$ aio cloudmanager:set-environment-variables ENVIRONMENT_ID --variable MY_VAR1 "plaintext value" --secret MY_VAR2 "some secret value"

通过命令行删除值 deleting-values-via-cli

$ aio cloudmanager:set-environment-variables ENVIRONMENT_ID --delete MY_VAR1 MY_VAR2

变量数 number-of-variables

每个环境最多可以声明200个变量。

针对密钥和特定于环境的配置值的部署注意事项 deployment-considerations-for-secret-and-environment-specific-configuration-values

由于机密和特定于环境的配置值位于Git之外，因此不属于正式的Adobe Experience Manager as a Cloud Service部署机制，因此客户应该管理、治理并集成到Adobe Experience Manager as a Cloud Service部署过程中。

如上所述，调用API会将新变量和值部署到云环境，类似于典型的客户代码部署管道。 创作和发布服务将重新启动并引用新值，通常需要几分钟的时间。 在此过程中，不会执行在常规代码部署期间由Cloud Manager运行的质量审核和测试。

通常，客户在部署在Cloud Manager中依赖于环境变量的代码之前，会调用API来设置这些变量。 在某些情况下，可能需要在部署代码后修改现有变量。

在某些情况下，计划客户代码部署依赖现有变量才能具有新值，而该值不适用于当前代码。 如果这是一个问题，建议以累加方式进行变量修改。 为此，请创建新的变量名称，而不是只更改旧变量的值，这样旧代码永远不会引用新值。 然后，当新客户版本看起来稳定时，您可以选择删除旧值。

同样，由于变量的值未进行版本控制，因此代码回滚可能会导致它引用导致问题的较新值。 前面提到的加性变量策略也会对此有所帮助。

此附加变量策略也可用于灾难恢复情况，在这些情况中，如果需要重新部署前几天生成的代码，则它引用的变量名称和值将保持不变。 这依赖于一种策略，即客户在删除这些旧变量之前等待几天，否则旧代码将没有合适的变量可引用。