Variáveis de ambiente do Cloud Manager environment-variables

As variáveis de ambiente padrão podem ser configuradas e gerenciadas pelo Cloud Manager. Elas são fornecidas para o ambiente de tempo de execução e podem ser usados nas configurações do OSGi. As variáveis de ambiente podem ser valores específicos ou segredos do ambiente, com base no que está sendo alterado.

Visão geral overview

As variáveis de ambiente oferecem vários benefícios aos usuários do AEM as a Cloud Service:

  • Elas permitem que o comportamento do código e do aplicativo varie com base no contexto e no ambiente. Por exemplo, elas podem ser usadas para permitir configurações diferentes no ambiente de desenvolvimento em relação aos ambientes de produção ou de preparo para evitar erros dispendiosos.
  • Elas somente precisam ser configuradas uma vez, e podem ser atualizadas e excluídas quando necessário.
  • Seus valores podem ser atualizados a qualquer momento e têm efeito imediatamente, sem a necessidade de alterações ou implantações de código.
  • Elas podem separar o código da configuração e eliminar a necessidade de incluir informações confidenciais no controle de versão.
  • Elas melhoram a segurança do aplicativo do AEM as a Cloud Service, pois residem fora do código.

Casos de uso típicos para as variáveis de ambiente incluem:

  • Conectar o aplicativo do AEM a diferentes endpoints externos
  • Usar uma referência ao armazenar senhas em vez de armazená-la diretamente na base do código
  • Quando existem vários ambientes de desenvolvimento em um programa e algumas configurações diferem de um ambiente para outro

Adição de variáveis de ambiente add-variables

NOTE
Você deve ser membro com a função de Gerenciador de implantaçãopara adicionar ou modificar variáveis de ambiente.
  1. Faça logon no Adobe Cloud Manager em my.cloudmanager.adobe.com.

  2. No Meus programas selecione aquele que deseja gerenciar.

  3. Na barra de navegação lateral, selecione o Ambientes para o programa escolhido, selecione o ambiente para o qual deseja criar uma variável de ambiente.

  4. Nos detalhes do ambiente, selecione a guia Configuração e clique em Adicionar para abrir a caixa de diálogo Configuração do ambiente.

    • Se estiver adicionando uma variável de ambiente pela primeira vez, você poderá ver uma Adicionar configuração no centro da página. Você pode usar esse botão ou Adicionar para abrir a caixa de diálogo Configuração do ambiente.

    Guia Configuração

  5. Insira os detalhes da variável.

    • Nome
    • Valor
    • Serviço aplicado - Define o serviço (Autor/Publicação/Visualização) ao qual a variável se aplica ou se aplica a todos os serviços
    • Tipo - Define se a variável é normal ou um segredo

    Adição de uma variável

  6. Depois de inserir a nova variável, é necessário selecionar Adicionar na última coluna da linha que contém a nova variável.

    • É possível inserir várias variáveis de uma só vez, inserindo uma nova linha e selecionando Adicionar.

    Salvar variáveis

  7. Selecione Salvar para manter suas variáveis.

Um indicador com o status Atualizando é mostrado na parte superior da tabela e ao lado da variável recém-adicionada para indicar que o ambiente está sendo atualizado com a configuração. Após a conclusão, a nova variável de ambiente estará visível na tabela.

Atualização de variáveis

TIP
Se quiser adicionar várias variáveis, é recomendável adicionar a primeira variável e usar o Adicionar botão na caixa Configuração do ambiente para adicionar as variáveis adicionais. Dessa forma, você pode adicioná-las com uma atualização ao ambiente.

Atualização de variáveis de ambiente update-variables

Depois de criar as variáveis de ambiente, você pode atualizá-las usando o botão Adicionar/atualizar para abrir a caixa de diálogo Configuração do ambiente.

  1. Faça logon no Adobe Cloud Manager em my.cloudmanager.adobe.com.

  2. O Cloud Manager lista os vários programas disponíveis. Selecione aquele que deseja gerenciar.

  3. No painel de navegação, selecione a variável Ambientes para o programa escolhido, selecione o ambiente para o qual deseja modificar uma variável de ambiente.

  4. Nos detalhes do ambiente, selecione a guia Configuração e clique em Adicionar/atualizar no canto superior direito para abrir a caixa de diálogo Configuração do ambiente.

  5. Usando o botão de reticências na última coluna da linha da variável que você deseja modificar, selecione Editar ou Excluir.

    Editar ou excluir variável

  6. Edite a variável de ambiente conforme necessário.

    • Ao editar, o botão de reticências será alterado para opções para reverter ao valor original ou confirmar a alteração.
    • Ao editar segredos, os valores somente podem ser atualizados, não visualizados.

    Editar variável

  7. Depois de fazer as alterações necessárias na configuração, selecione Salvar.

Como ocorre ao adicionar variáveis, um indicador com o status Atualizando é mostrado na parte superior da tabela e ao lado da variável recém-atualizada para indicar que o ambiente está sendo atualizado com a configuração. Após a conclusão, as variáveis de ambiente atualizadas estarão visíveis na tabela.

TIP
Se você quiser atualizar várias variáveis, é recomendável usar o Configuração do ambiente para atualizar todas as variáveis necessárias de uma só vez antes de tocar ou clicar Salvar. Dessa forma, você pode adicioná-las com uma atualização ao ambiente.

Uso de variáveis de ambiente using

As variáveis de ambiente podem tornar suas configurações pom.xml mais seguras e flexíveis. Por exemplo, senhas não precisam ser codificadas e sua configuração pode ser ajustada com base nos valores das variáveis de ambiente.

Você pode acessar segredos e variáveis de ambiente por meio do XML, como segue.

  • ${env.VARIABLE_NAME}

Consulte o documento Configuração do projeto para obter um exemplo de como usar os dois tipos de variáveis em um arquivo pom.xml.

Consulte a documentação oficial do Maven para obter mais detalhes.

Disponibilidade da variável de ambiente availability

As variáveis de ambiente podem ser usadas em vários lugares.

Autor, visualização e publicação author-preview-publish

As variáveis e os segredos comuns do ambiente podem ser usados nos ambientes de criação, visualização e publicação.

Dispatcher dispatcher

Somente variáveis de ambiente comuns podem ser usadas com o Dispatcher. Segredos não podem ser usados.

No entanto, as variáveis de ambiente não podem ser usadas no IfDefine diretivas.

TIP
Você deve validar o uso das variáveis de ambiente com o Dispatcher localmente antes da implantação.

Configurações do OSGi osgi

As variáveis e os segredos comuns do ambiente podem ser usados nas configurações do OSGi.

Variáveis de pipeline pipeline

Além das variáveis de ambiente, também há variáveis de pipeline, que são expostas durante a fase de criação. Saiba mais sobre variáveis de pipeline aqui.

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