Configuração do OSGi para o Adobe Experience Manager as a Cloud Service

OSGi é um elemento fundamental na pilha de tecnologia do Adobe Experience Manager (AEM). É usado para controlar os pacotes compostos de AEM e suas configurações.

O OSGi fornece as primitivas padronizadas que permitem que os aplicativos sejam construídos a partir de componentes pequenos, reutilizáveis e colaborativos. Esses componentes podem ser compostos em um aplicativo e implantados. Isso permite o gerenciamento fácil de pacotes OSGi, pois eles podem ser interrompidos, instalados e iniciados individualmente. As interdependências são tratadas automaticamente. Cada componente OSGi está contido em um dos vários pacotes. Para obter mais informações, consulte Especificação OSGi.

Você pode gerenciar as definições de configuração dos componentes OSGi por meio de arquivos de configuração que fazem parte de um projeto de código AEM.

Arquivos de configuração do OSGi

As alterações de configuração são definidas nos pacotes de código do projeto AEM (ui.apps) como arquivos de configuração (.cfg.json) em pastas de configuração específicas do modo de execução:

/apps/example/config.<runmode>

O formato dos arquivos de configuração do OSGi é baseado em JSON usando o .cfg.json formato definido pelo projeto Apache Sling.

As configurações do OSGi direcionam os componentes OSGi por meio de sua Identidade persistente (PID), que assume como padrão o nome de classe Java™ do componente OSGi. Por exemplo, para fornecer a configuração do OSGi para um serviço OSGi implementado por:

com.example.workflow.impl.ApprovalWorkflow.java

um arquivo de configuração OSGi é definido em:

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

após o cfg.json Formato de configuração do OSGi.

Resolução do modo de execução

Configurações OSGi específicas podem ser direcionadas a instâncias AEM específicas usando modos de execução. Para usar o modo de execução, crie pastas de configuração em /apps/example (onde exemplo é o nome do projeto), no formato:

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

Todas as configurações de OSGi nessas pastas serão usadas se os modos de execução definidos no nome da pasta de configuração corresponderem aos modos de execução usados pelo AEM.

Por exemplo, se o AEM estiver usando o autor de modos de execução e o desenvolvimento, os nós de configuração no /apps/example/config.author/ e /apps/example/config.author.dev/ são aplicados, enquanto os nós de configuração em /apps/example/config.publish/ e /apps/example/config.author.stage/ não são aplicadas.

Se várias configurações para o mesmo PID forem aplicáveis, a configuração com o maior número de modos de execução correspondentes será aplicada.

A granularidade dessa regra está em um nível PID. Isso significa que não é possível definir algumas propriedades para o mesmo PID no /apps/example/config.author/ e mais específicas em /apps/example/config.author.dev/ para o mesmo PID. A configuração com o maior número de modos de execução correspondentes é eficaz para todo o PID.

Ao desenvolver localmente, um parâmetro de inicialização do modo de execução, -r, é usado para especificar a configuração OSGI do modo de execução.

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

Verificando modos de execução

Os modos de execução as a Cloud Service do AEM são bem definidos com base no tipo de ambiente e no serviço. Revise o lista completa de modos de execução AEM as a Cloud Service disponíveis.

Os valores de configuração OSGi especificados pelo modo de execução podem ser verificados por:

1. Abrir o AEM como um ambiente Cloud Service Console do desenvolvedor
2. Selecionar a(s) camada(s) de serviço a serem inspecionadas, usando o Pod lista suspensa
3. Selecionar o Status guia
4. Selecionar Configurações do Status do despejo lista suspensa
5. Selecionar o Obter Status botão

A visualização resultante exibe todas as configurações do componente OSGi para as camadas selecionadas com seus valores de configuração OSGi aplicáveis. Esses valores podem ser referenciados juntamente com os valores de configuração do OSGi no código-fonte do projeto AEM em /apps/example/osgiconfig/config.<runmode(s)>.

Para verificar se os valores de configuração OSGi apropriados foram aplicados:

1. Na saída da Configuração do Console do desenvolvedor
2. Localize o pid representando a configuração do OSGi a ser verificada; esse é o nome do arquivo de configuração do OSGi no código-fonte do projeto AEM.
3. INSPECT o properties lista para o pid e verifique se a chave e os valores correspondem ao arquivo de configuração OSGi no código-fonte do projeto AEM para o modo de execução que está sendo verificado.=

Tipos de valores de configuração OSGi

Há três variedades de valores de configuração OSGi que podem ser usadas com o Adobe Experience Manager as a Cloud Service.

1. Valores em linha, que são valores codificados na configuração do OSGi e armazenados no Git. Por exemplo:

   {
      "connection.timeout": 1000
   }
   

2. Valores secretos, que são valores que não devem ser armazenados no Git por motivos de segurança. Por exemplo:

   {
   "api-key": "$[secret:server-api-key]"
   }
   

3. Valores específicos do ambiente, que são valores que variam entre ambientes de desenvolvimento e, portanto, não podem ser direcionados com precisão pelo modo de execução (já que há uma única dev modo de execução no Adobe Experience Manager as a Cloud Service). Por exemplo:

   {
    "url": "$[env:server-url]"
   }
   

   Um único arquivo de configuração OSGi pode usar qualquer combinação desses tipos de valor de configuração em conjunto. Por exemplo:

   {
   "connection.timeout": 1000,
   "api-key": "$[secret:server-api-key]",
   "url": "$[env:server-url]"
   }
   

Como escolher o tipo de valor de configuração OSGi apropriado

O caso comum de OSGi usa valores de configuração OSGi em linha. As configurações específicas do ambiente são usadas somente para casos de uso específicos em que um valor difere entre ambientes de desenvolvimento.

As configurações específicas do ambiente estendem as configurações OSGi tradicionais definidas estaticamente que contêm valores em linha, fornecendo a capacidade de gerenciar os valores de configuração do OSGi externamente por meio da API do Cloud Manager. É importante entender quando a abordagem comum e tradicional de definir valores em linha e armazená-los no Git deve ser usada, em vez de abstrair os valores em configurações específicas do ambiente.

As orientações a seguir abordam quando usar configurações específicas de ambiente não secreto e secreto:

Quando usar valores de configuração em linha

Os valores de configurações em linha são considerados a abordagem padrão e devem ser usados quando possível. As configurações em linha oferecem os benefícios de:

• Eles são mantidos, com governança e histórico de versões no Git
• Os valores estão implicitamente vinculados às implantações de código
• Eles não exigem considerações ou coordenação adicionais sobre implantação

Sempre que definir um valor de configuração OSGi, comece com valores em linha e selecione somente configurações secretas ou específicas do ambiente, se necessário, para o caso de uso.

Quando usar valores de configuração específicos do ambiente não secreto

Usar somente configurações específicas do ambiente ($[env:ENV_VAR_NAME]) para valores de configuração não secretos quando os valores variam para o nível de visualização ou entre ambientes de desenvolvimento. Isso inclui instâncias de desenvolvimento locais e quaisquer ambientes de desenvolvimento do Adobe Experience Manager as a Cloud Service. Exceto para definir valores exclusivos para o nível de visualização, evite usar configurações específicas de ambiente não secreto para ambientes de Preparo ou Produção do Adobe Experience Manager as a Cloud Service.

• Use apenas configurações específicas do ambiente não secreto para valores de configuração que diferem entre o nível de publicação e visualização, ou para valores que diferem entre ambientes de desenvolvimento, incluindo instâncias de desenvolvimento locais.
• Além do cenário em que o nível de visualização deve variar do nível de publicação, use os valores embutidos padrão nas configurações de OSGi para valores não secretos de Preparo e Produção. Em relação a isso, não é recomendável usar configurações específicas do ambiente para facilitar a realização de alterações de configuração no tempo de execução em ambientes de Preparo e Produção; essas alterações devem ser introduzidas por meio do gerenciamento do código-fonte.

Quando usar valores de configuração específicos do ambiente secreto

O Adobe Experience Manager as a Cloud Service requer o uso de configurações específicas do ambiente ($[secret:SECRET_VAR_NAME]) para quaisquer valores de configuração OSGi secretos, como senhas, chaves de API privadas ou quaisquer outros valores que não possam ser armazenados no Git por motivos de segurança.

Use configurações específicas do ambiente secreto para armazenar o valor de segredos em todos os ambientes do Adobe Experience Manager as a Cloud Service, incluindo Preparo e Produção.

Criação de configurações de OSGi

Há duas maneiras de criar configurações OSGi, conforme descrito abaixo. A primeira abordagem é normalmente usada para configurar componentes OSGi personalizados que têm propriedades e valores OSGi bem conhecidos pelo desenvolvedor e a última para componentes OSGi fornecidos pelo AEM.

Gravação de configurações OSGi

Os arquivos de configuração OSGi formatados em JSON podem ser gravados manualmente diretamente no projeto AEM. Essa é geralmente a maneira mais rápida de criar configurações OSGi para componentes OSGi bem conhecidos e, especialmente, componentes OSGi personalizados que foram projetados e desenvolvidos pelo mesmo desenvolvedor que define as configurações. Essa abordagem também pode ser usada para copiar/colar e atualizar configurações para o mesmo componente OSGi em várias pastas de modo de execução.

1. No IDE, abra o ui.apps projetar, localizar ou criar a pasta de configuração (/apps/.../config.<runmode>) que direciona os modos de execução que a nova configuração do OSGi precisa ter em vigor
2. Nesta pasta de configuração, crie um <PID>.cfg.json arquivo. O PID é a identidade persistente do componente OSGi. Normalmente, é o nome de classe completo da implementação do componente OSGi. Por exemplo:
   /apps/.../config/com.example.workflow.impl.ApprovalWorkflow.cfg.json
   Observe que os nomes de arquivo do fatory de configuração do OSGi usam o <factoryPID>-<name>.cfg.json convenção de nomenclatura
3. Abra o novo .cfg.json e defina as combinações chave/valor para a propriedade OSGi e os pares de valores, seguindo o Formato de configuração OSGi JSON.
4. Salve as alterações no novo .cfg.json arquivo
5. Adicione e confirme o novo arquivo de configuração OSGi no Git

Gerar configurações OSGi usando o Quickstart do SDK do AEM

O console da Web AEM do AEM SDK Quickstart Jar pode ser usado para configurar componentes OSGi e exportar configurações OSGi como JSON. Isso é útil para configurar componentes OSGi fornecidos pelo AEM cujas propriedades OSGi e seus formatos de valor podem não ser bem compreendidos pelo desenvolvedor que define as configurações OSGi no projeto AEM.

1. Faça logon no console da Web AEM do AEM do SDK do em https://<host>:<port>/system/console como usuário administrador
2. Navegue até OSGi > Configuração
3. Para configurar, localize o componente OSGi e toque no título para editá-lo
   
4. Edite os valores da propriedade de configuração OSGi por meio da interface do usuário da Web, conforme necessário
5. Registre a Identidade persistente (PID) no local seguro. Isso é usado posteriormente para gerar o JSON de configuração do OSGi
6. Toque em Salvar
7. Navegue até OSGi > Impressora de configuração do instalador OSGi
8. Cole no PID copiado na Etapa 5, verifique se o Formato de serialização está definido como "OSGi Configurator JSON"
9. Toque em Imprimir
10. A configuração do OSGi no formato JSON será exibida na seção Propriedades da configuração serializada
    
11. No IDE, abra o ui.apps projetar, localizar ou criar a pasta de configuração (/apps/.../config.<runmode>) que direciona os modos de execução que a nova configuração do OSGi precisa ter em vigor.
12. Nesta pasta de configuração, crie um <PID>.cfg.json arquivo. O PID é o mesmo valor da Etapa 5.
13. Cole as Propriedades da configuração serializada da Etapa 10 na .cfg.json arquivo.
14. Salve as alterações no novo .cfg.json arquivo.
15. Adicione e confirme o novo arquivo de configuração OSGi no Git.

Formatos de propriedade da configuração OSGi

Valores em linha

Os valores em linha são formatados como pares de nome-valor padrão, seguindo a sintaxe JSON padrão. Por exemplo:

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

Valores de configuração específicos do ambiente

A configuração do OSGi deve atribuir um espaço reservado para a variável que deve ser definida por ambiente:

use $[env:ENV_VAR_NAME]

Os clientes devem usar essa técnica apenas para propriedades de configuração do OSGi relacionadas a seu código personalizado; ela não deve ser usada para substituir a configuração do OSGi definida por Adobe.

Valores de configuração do segredo

A configuração do OSGi deve atribuir um espaço reservado para o segredo que deve ser definido por ambiente:

use $[secret:SECRET_VAR_NAME]

Nomeação da variável

O seguinte se aplica aos valores de configuração específicos e secretos do ambiente.

Os nomes das variáveis devem seguir as seguintes regras:

• Comprimento mínimo: 2
• Tamanho máximo: 100
• Deve corresponder ao regex: [a-zA-Z_][a-zA-Z_0-9]*

Os valores das variáveis não devem exceder 2048 caracteres.

Valores padrão

O seguinte se aplica aos valores de configuração específicos e secretos do ambiente.

Se nenhum valor por ambiente for definido, no tempo de execução o espaço reservado não será substituído e permanecerá no lugar, pois nenhuma interpolação aconteceu. Para evitar isso, um valor padrão pode ser fornecido como parte do espaço reservado com a seguinte sintaxe:

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

Com um valor padrão fornecido, o espaço reservado é substituído pelo valor por ambiente, se fornecido, ou pelo valor padrão fornecido.

Desenvolvimento local

O seguinte se aplica aos valores de configuração específicos e secretos do ambiente.

As variáveis podem ser definidas no ambiente local para que sejam coletadas pelo AEM local no tempo de execução. Por exemplo, no Linux®:

export ENV_VAR_NAME=my_value

Recomenda-se que um script bash simples seja escrito, definindo as variáveis de ambiente usadas nas configurações e para executá-lo antes de iniciar o AEM. Ferramentas como https://direnv.net/ ajudar a simplificar esta abordagem. Dependendo do tipo dos valores, eles podem ser verificados no gerenciamento de código-fonte, se puderem ser compartilhados entre todos.

Os valores de segredos são lidos dos arquivos. Portanto, para cada espaço reservado que usa um segredo, um arquivo de texto contendo o valor secreto deve ser criado.

Por exemplo, se $[secret:server_password] for usado, um arquivo de texto chamado server_password deve ser criado. Todos esses arquivos secretos devem ser armazenados no mesmo diretório e na propriedade da estrutura org.apache.felix.configadmin.plugin.interpolation.secretsdir deve ser configurado com esse diretório local.

A variável org.apache.felix.configadmin.plugin.interpolation.secretsdir é uma propriedade da estrutura Sling; portanto, essa propriedade não é definida no console felix (/system/console?lang=pt-BR), mas é definida no arquivo sling.properties usado quando o sistema é inicializado. Esse arquivo pode ser encontrado no subdiretório /conf da pasta Jar/install extraída (crx-quickstart/conf).

exemplo: adicione esta linha ao final do arquivo 'crx-quickstart/conf/sling.properties'-file para configurar 'crx-quickstart/secretsdir' como uma pasta secreta:

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

Configuração de autor versus publicação

Se uma propriedade OSGi exigir valores diferentes para autor e publicação:

• Separado config.author e config.publish As pastas OSGi devem ser usadas, conforme descrito na seção Seção Resolução do modo de execução.
• Há duas opções para criar os nomes de variáveis independentes que devem ser usadas:

  • a primeira opção, que é recomendada: em todas as pastas OSGi (como config.author e config.publish) declarado para definir valores diferentes, use o mesmo nome de variável. Por exemplo

    $[env:ENV_VAR_NAME;default=<value>], em que o padrão corresponde ao valor padrão desse nível (autor ou publicação). Ao definir a variável de ambiente via API do Cloud Manager ou por meio de um cliente, diferencie os níveis usando o parâmetro "serviço", conforme descrito neste Documentação de referência da API. O parâmetro "service" vinculará o valor da variável ao nível OSGi apropriado. Pode ser "autor" ou "publicar" ou "pré-visualização".

  • a segunda opção, que é declarar variáveis distintas usando um prefixo, como author_<samevariablename> e publish_<samevariablename>

Exemplos de configuração

Nos exemplos abaixo, suponha que haja três ambientes de desenvolvimento, além dos ambientes de preparo e produção.

Exemplo 1

A intenção é para o valor da propriedade OSGi my_var1 ser o mesmo para estágio e produção, mas diferentes para cada um dos três ambientes de desenvolvimento.

{ "my_var1": "val", "my_var2": "abc", "my_var3": 500 }

{ "my_var1" : "$[env:my_var1]" "my_var2": "abc", "my_var3": 500 }

Exemplo 2

A intenção é para o valor da propriedade OSGi my_var1 para diferir para estágio, produção e para cada um dos três ambientes de desenvolvimento. Portanto, a API do Cloud Manager deve ser chamada para definir o valor de my_var1 para cada ambiente dev.

{ "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 }

Exemplo 3

A intenção é para o valor da propriedade OSGi my_var1 ser o mesmo para ambientes de preparo, produção e apenas um dos ambientes dev, mas para diferir para os outros dois ambientes dev. Nesse caso, a API do Cloud Manager deve ser chamada para definir o valor de my_var1 para cada um dos ambientes dev, incluindo para o ambiente dev, que deve ter o mesmo valor do estágio e da produção. Ele não herdará o valor definido na pasta config.

{ "my_var1": "val1", "my_var2": "abc", "my_var3": 500 }

{ "my_var1" : "$[env:my_var1]" "my_var2": "abc", "my_var3": 500 }

Outra maneira de fazer isso seria definir um valor padrão para o token de substituição na pasta config.dev de modo que seja o mesmo valor que no config pasta.

{ "my_var1": "val1", "my_var2": "abc", "my_var3": 500 }

{ "my_var1": "$[env:my_var1;default=val1]" "my_var2": "abc", "my_var3": 500 }

Formato de API do Cloud Manager para propriedades de configuração

Consulte esta página sobre como a API deve ser configurada.

Configuração de valores por meio da API

Chamar a API implanta as novas variáveis e valores em um ambiente na nuvem, de modo semelhante a um pipeline típico de implantação de código do cliente. Os serviços de criação e publicação são reiniciados e fazem referência aos novos valores, normalmente levando alguns minutos.

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

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

Obtenção de valores por meio da API

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

Consulte esta página para obter mais informações.

Exclusão de valores por meio da API

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

Para excluir uma variável, inclua-a com um valor vazio.

Consulte esta página para obter mais informações.

Obtendo valores por meio da linha de comando

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

Configuração de valores por meio da Linha de comando

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

Exclusão de valores por meio da linha de comando

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

Número de variáveis

É possível declarar até 200 variáveis por ambiente.

Considerações sobre implantação para valores de configuração secretos e específicos do ambiente

Como os valores de configuração secretos e específicos do ambiente residem fora do Git e, portanto, não fazem parte dos mecanismos formais de implantação do Adobe Experience Manager as a Cloud Service, o cliente deve gerenciar, administrar e integrar ao processo de implantação do Adobe Experience Manager as a Cloud Service.

Como mencionado acima, chamar a API implanta as novas variáveis e valores em ambientes de nuvem, de modo semelhante a um pipeline típico de implantação de código do cliente. Os serviços de criação e publicação são reiniciados e fazem referência aos novos valores, normalmente levando alguns minutos. Os quality gates (portais de qualidade) e os testes que são executados pelo Cloud Manager durante uma implantação de código regular não são executados durante esse processo.

Normalmente, os clientes chamariam a API para definir variáveis de ambiente antes de implantar o código que depende delas no Cloud Manager. Em algumas situações, pode ser necessário modificar uma variável existente depois que o código já tiver sido implantado.

Pode haver cenários em que uma implantação programada de código do cliente dependa de variáveis existentes para ter novos valores, o que não seria apropriado com o código atual. Se isso for um problema, é recomendável fazer modificações variáveis de maneira aditiva. Para fazer isso, crie novos nomes de variáveis em vez de apenas alterar o valor de variáveis antigas para que o código antigo nunca faça referência ao novo valor. Em seguida, quando a nova versão do cliente parecer estável, é possível optar por remover os valores mais antigos.

Da mesma forma, como os valores de uma variável não têm controle de versão, uma reversão de código pode fazer com que ela faça referência a valores mais recentes que causam problemas. A estratégia de variável aditiva mencionada anteriormente também ajudaria aqui.

Essa estratégia aditiva de variáveis também é útil para cenários de recuperação de desastres em que, se o código de vários dias antes precisasse ser reimplantado, os nomes e os valores das variáveis aos quais ele faz referência ainda estariam intactos. Isso depende de uma estratégia em que um cliente aguarda alguns dias antes de remover essas variáveis mais antigas. Caso contrário, o código mais antigo não teria variáveis apropriadas para referência.