Para obter mais informações sobre o Dispatcher na nuvem e como baixar as Ferramentas do Dispatcher, consulte o Dispatcher na nuvem página. Se a configuração do dispatcher estiver no modo herdado, consulte o documentação do modo herdado.
As seções a seguir descrevem a estrutura de arquivo do modo flexível, a validação local, a depuração e a migração do modo herdado para o modo flexível.
Este artigo pressupõe que a configuração do dispatcher do seu projeto inclua o arquivo opt-in/USE_SOURCES_DIRECTLY
, que faz com que o SDK e o tempo de execução validem e implantem a configuração de maneira aprimorada em comparação ao modo herdado, removendo limitações sobre o número e o tamanho dos arquivos.
Dessa forma, se a configuração do dispatcher não incluir o arquivo mencionado acima, será altamente recomendado que você migre do modo herdado para o modo flexível, conforme descrito na seção Migração do modo herdado para o modo flexível seção.
A estrutura da subpasta Dispatcher do projeto é a seguinte:
./
├── conf.d
│ ├── available_vhosts
│ │ ├── my_site.vhost # Created by customer
│ │ └── default.vhost
│ ├── dispatcher_vhost.conf
│ ├── enabled_vhosts
│ │ ├── README
│ │ └── my_site.vhost -> ../available_vhosts/my_site.vhost # Created by customer
│ └── rewrites
│ │ ├── default_rewrite.rules
│ │ └── rewrite.rules
│ └── variables
| ├── custom.vars
│ └── global.vars
│── opt-in
│ └── USE_SOURCES_DIRECTLY
└── conf.dispatcher.d
├── available_farms
│ ├── my_farm.farm # Created by customer
│ └── default.farm
├── cache
│ ├── default_invalidate.any
│ ├── default_rules.any
│ ├── marketing_query_parameters.any
│ └── rules.any
├── clientheaders
│ ├── clientheaders.any
│ └── default_clientheaders.any
├── dispatcher.any
├── enabled_farms
│ ├── README
│ └── my_farm.farm -> ../available_farms/my_farm.farm # Created by customer
├── filters
│ ├── default_filters.any
│ └── filters.any
├── renders
│ └── default_renders.any
└── virtualhosts
│ ├── default_virtualhosts.any
│ └── virtualhosts.any
Veja abaixo uma explicação dos arquivos notáveis que podem ser modificados:
Arquivos personalizáveis
Os seguintes arquivos são personalizáveis e serão transferidos para a sua instância da Cloud na implantação:
conf.d/available_vhosts/<CUSTOMER_CHOICE>.vhost
Você pode ter um ou mais desses arquivos. Eles contêm <VirtualHost>
entradas que correspondem a nomes de host e permitem que o Apache manipule cada tráfego de domínio com regras diferentes. Os arquivos são criados no available_vhosts
e habilitado com um link simbólico na variável enabled_vhosts
diretório. No .vhost
arquivos, outros arquivos como regravações e variáveis serão incluídos.
No modo flexível, você deve usar caminhos relativos em vez de caminhos absolutos.
Certifique-se de que pelo menos um host virtual esteja sempre disponível que corresponda a ServerAlias \*.local
, localhost
e 127.0.0.1
necessários para a invalidação do dispatcher. Os aliases do servidor *.adobeaemcloud.net
e *.adobeaemcloud.com
também são necessários em pelo menos uma configuração vhost e são necessários para processos de Adobe internos.
Se você deseja fazer a correspondência exata do host porque você tem vários arquivos vhost, você pode seguir o exemplo abaixo:
<VirtualHost *:80>
ServerName "example.com"
# Put names of which domains are used for your published site/content here
ServerAlias "*example.com" "\*.local" "localhost" "127.0.0.1" "*.adobeaemcloud.net" "*.adobeaemcloud.com"
# Use a document root that matches the one in conf.dispatcher.d/default.farm
DocumentRoot "${DOCROOT}"
# URI dereferencing algorithm is applied at Sling's level, do not decode parameters here
AllowEncodedSlashes NoDecode
# Add header breadcrumbs for help in troubleshooting which vhost file is chosen
<IfModule mod_headers.c>
Header add X-Vhost "publish-example-com"
</IfModule>
...
</VirtualHost>
conf.d/rewrites/rewrite.rules
Esse arquivo é incluído de dentro do seu .vhost
arquivos. Ele tem um conjunto de regras de regravação para mod_rewrite
.
conf.d/variables/custom.vars
Esse arquivo é incluído de dentro do seu .vhost
arquivos. Você pode adicionar definições para variáveis do Apache neste local.
conf.d/variables/global.vars
Esse arquivo está incluído de dentro do dispatcher_vhost.conf
arquivo. Você pode alterar o Dispatcher e regravar o nível de log nesse arquivo.
conf.dispatcher.d/available_farms/<CUSTOMER_CHOICE>.farm
Você pode ter um ou mais desses arquivos, que contêm farms para corresponder a nomes de host e permitem que o módulo Dispatcher manipule cada farm com regras diferentes. Os arquivos são criados no available_farms
e habilitado com um link simbólico na variável enabled_farms
diretório. No .farm
arquivos, outros arquivos como filtros, regras de cache e outros serão incluídos.
conf.dispatcher.d/cache/rules.any
Esse arquivo é incluído de dentro do seu .farm
arquivos. Especifica as preferências de armazenamento em cache.
conf.dispatcher.d/clientheaders/clientheaders.any
Esse arquivo é incluído de dentro do seu .farm
arquivos. Especifica quais cabeçalhos de solicitação devem ser encaminhados para o backend.
conf.dispatcher.d/filters/filters.any
Esse arquivo é incluído de dentro do seu .farm
arquivos. Ele tem um conjunto de regras que alteram qual tráfego deve ser filtrado e não chega ao back-end.
conf.dispatcher.d/virtualhosts/virtualhosts.any
Esse arquivo é incluído de dentro do seu .farm
arquivos. Ela tem uma lista de nomes de host ou caminhos URI a serem correspondidos pela correspondência glob. Isso determina qual back-end usar para atender a uma solicitação.
opt-in/USE_SOURCES_DIRECTLY
Esse arquivo permite uma configuração mais flexível do dispatcher e remove limitações anteriores relacionadas ao número e ao tamanho dos arquivos. Também faz com que o SDK e o tempo de execução validem e implantem a configuração de maneira aprimorada.
Os arquivos acima fazem referência aos arquivos de configuração imutáveis listados abaixo. As alterações nos arquivos imutáveis não serão processadas pelos Dispatchers em ambientes na Nuvem.
Arquivos de configuração imutáveis
Esses arquivos fazem parte da estrutura básica e aplicam padrões e práticas recomendadas. Os arquivos são considerados imutáveis porque modificá-los ou excluí-los localmente não terá impacto na implantação, pois não serão transferidos para a instância da Nuvem.
Recomenda-se que os arquivos acima façam referência aos arquivos imutáveis listados abaixo, seguidos de quaisquer instruções ou substituições adicionais. Quando a configuração do Dispatcher é implantada em um ambiente de nuvem, a versão mais recente dos arquivos imutáveis é usada, independentemente da versão usada no desenvolvimento local.
conf.d/available_vhosts/default.vhost
Contém uma amostra de host virtual. Para seu próprio host virtual, crie uma cópia deste arquivo, personalize-o, vá para conf.d/enabled_vhosts
e criar um link simbólico para sua cópia personalizada.
Não copie o arquivo default.vhost diretamente no conf.d/enabled_vhosts
.
Certifique-se de que um host virtual esteja sempre disponível que corresponda a ServerAlias \*.local
, localhost
e 127.0.0.1
necessários para a invalidação do dispatcher. Os aliases do servidor *.adobeaemcloud.net
e *.adobeaemcloud.com
são necessários para processos de Adobe internos.
conf.d/dispatcher_vhost.conf
Parte da estrutura básica, usada para ilustrar como os hosts virtuais e as variáveis globais são incluídos.
conf.d/rewrites/default_rewrite.rules
Regras de regravação padrão adequadas para um projeto padrão. Se precisar de personalização, modifique rewrite.rules
. Na personalização, você ainda pode incluir as regras padrão primeiro, se elas forem necessárias.
conf.dispatcher.d/available_farms/default.farm
Contém um exemplo de farm do Dispatcher. Para seu próprio farm, crie uma cópia deste arquivo, personalize-o, vá para conf.d/enabled_farms
e criar um link simbólico para sua cópia personalizada.
conf.dispatcher.d/cache/default_invalidate.any
Parte da estrutura base é gerada na inicialização. Você está obrigatório para incluir esse arquivo em cada farm definido, na variável cache/allowedClients
seção.
conf.dispatcher.d/cache/default_rules.any
Regras de cache padrão adequadas para um projeto padrão. Se precisar de personalização, modifique conf.dispatcher.d/cache/rules.any
. Na personalização, você ainda pode incluir as regras padrão primeiro, se elas forem necessárias.
conf.dispatcher.d/clientheaders/default_clientheaders.any
Cabeçalhos de solicitação padrão para encaminhar para o backend, adequado para um projeto padrão. Se precisar de personalização, modifique clientheaders.any
. Na personalização, você ainda pode incluir os cabeçalhos de solicitação padrão primeiro, se eles atenderem às suas necessidades.
conf.dispatcher.d/dispatcher.any
Parte da estrutura base, usada para ilustrar como seus farms do Dispatcher são incluídos.
conf.dispatcher.d/filters/default_filters.any
Filtros padrão adequados para um projeto padrão. Se precisar de personalização, modifique filters.any
. Na personalização, ainda é possível incluir os filtros padrão primeiro, se eles atenderem às suas necessidades.
conf.dispatcher.d/renders/default_renders.any
Parte da estrutura base, esse arquivo é gerado na inicialização. Você está obrigatório para incluir esse arquivo em cada farm definido, na variável renders
seção.
conf.dispatcher.d/virtualhosts/default_virtualhosts.any
O recurso de curinga de host padrão é adequado para um projeto padrão. Se precisar de personalização, modifique virtualhosts.any
. Na personalização, não inclua o recurso de curinga do host padrão, pois ele corresponde a cada solicitação de entrada.
Consulte Módulos compatíveis do Apache.
As seções abaixo incluem comandos que usam as versões Mac ou Linux do SDK, mas o SDK do Windows também pode ser usado de maneira semelhante.
Use o validate.sh
conforme mostrado abaixo:
$ validate.sh src/dispatcher
opt-in USE_SOURCES_DIRECTLY marker file detected
Phase 1: Dispatcher validator
Cloud manager validator 2.0.32
Phase 1 finished
Phase 2: httpd -t validation in docker image
values.csv not found in deployment folder: /Users/foo/src - using files in 'conf.d' and 'conf.dispatcher.d' subfolders directly
processing configuration subfolder: conf.d
processing configuration subfolder: conf.dispatcher.d
Running script /docker_entrypoint.d/10-check-environment.sh
Running script /docker_entrypoint.d/20-create-docroots.sh
Running script /docker_entrypoint.d/30-wait-for-backend.sh
Waiting until localhost is available
localhost resolves to ::1
Running script /docker_entrypoint.d/40-generate-allowed-clients.sh
Running script /docker_entrypoint.d/50-check-expiration.sh
Running script /docker_entrypoint.d/60-check-loglevel.sh
Running script /docker_entrypoint.d/70-check-forwarded-host-secret.sh
# Dispatcher configuration: (/etc/httpd/conf.dispatcher.d/dispatcher.any)
/farms {
...
}
Syntax OK
Phase 2 finished
Phase 3: Immutability check
reading immutable file list from /etc/httpd/immutable.files.txt
...
no immutable file has been changed - check is SUCCESSFUL
Phase 3 finished
O script tem as três fases a seguir:
httpd -t
para testar se a sintaxe está correta, de modo que o apache httpd possa ser iniciado. Se for bem-sucedida, a configuração deve estar pronta para implantação.Durante uma implantação do Cloud Manager, a variável httpd -t
a verificação de sintaxe também será executada e todos os erros serão incluídos no Cloud Manager Build Images step failure
registro.
Consulte a Recarga e validação automáticas para uma alternativa eficiente à execução validate.sh
após cada modificação de configuração.
Incluir na lista de permissões Se uma diretiva não for alterada, a ferramenta registrará um erro e retornará um código de saída diferente de zero. Além disso, ele verifica ainda mais todos os arquivos com padrão conf.dispatcher.d/enabled_farms/*.farm
e verifica se:
/glob
(consulte CVE-2016-0957 para obter mais detalhes./crx/de or /system/console
.Incluir na lista de permissões Observe que a ferramenta de validação relata apenas o uso proibido de diretivas Apache que não foram migradas. Ele não relata problemas sintáticos ou semânticos com a configuração do Apache, pois essas informações só estão disponíveis para módulos Apache em um ambiente de execução.
Abaixo estão apresentadas técnicas de solução de problemas para depurar erros comuns de validação gerados pela ferramenta:
não é possível localizar um conf.dispatcher.d
subpasta no arquivo
Seu arquivo deve conter as pastas conf.d
e conf.dispatcher.d
. Observe que você não deve
usar o prefixo etc/httpd
em seu arquivo.
não foi possível encontrar farm emconf.dispatcher.d/enabled_farms
Seus farms ativados devem estar localizados na subpasta mencionada.
arquivo incluído (…) deve ser nomeado: …
Há duas seções na configuração do farm que deve incluir um arquivo específico: /renders
e /allowedClients
no /cache
seção. Essas seções devem ter a seguinte aparência:
/renders {
$include "../renders/default_renders.any"
}
e:
/allowedClients {
$include "../cache/default_invalidate.any"
}
arquivo incluído em local desconhecido: …
Há quatro seções na configuração do farm, nas quais você pode incluir seus próprios arquivos: /clientheaders
, filters
, /rules
in /cache
seção e /virtualhosts
. Os arquivos incluídos precisam ser nomeados da seguinte maneira:
Seção | Incluir nome do arquivo |
---|---|
/clientheaders |
../clientheaders/clientheaders.any |
/filters |
../filters/filters.any |
/rules |
../cache/rules.any |
/virtualhosts |
../virtualhosts/virtualhosts.any |
Como alternativa, inclua a variável padrão versão desses arquivos, cujos nomes são anexados à palavra default_
, por exemplo, ../filters/default_filters.any
.
incluir instrução em (…), fora de qualquer local conhecido: …
Além das seis seções mencionadas nos parágrafos acima, você não está autorizado a usar o $include
Por exemplo, o seguinte geraria esse erro:
/invalidate {
$include "../cache/invalidate.any"
}
os clientes/renderizadores permitidos não estão incluídos de: …
Esse erro é gerado quando você não especifica uma inclusão para /renders
e /allowedClients
no /cache
seção. Consulte a
arquivo incluído (…) deve ser nomeado: … para obter mais informações.
o filtro não deve usar o padrão glob para permitir solicitações
Não é seguro permitir solicitações com um /glob
regra de estilo, que corresponde à linha de solicitação completa, por exemplo,
/0100 {
/type "allow" /glob "GET *.css *"
}
Esta declaração destina-se a permitir css
arquivos, mas também permite que solicitações para qualquer recurso seguido pela sequência de consulta ?a=.css
. Portanto, é proibido usar esses filtros (consulte também CVE-2016-0957).
arquivo incluído (…) não corresponde a nenhum arquivo conhecido
Por padrão, dois tipos de arquivos na configuração do host virtual Apache podem ser especificados como inclui: regravações e variáveis.
Tipo | Incluir nome do arquivo |
---|---|
Substitui | conf.d/rewrites/rewrite.rules |
Variáveis | conf.d/variables/custom.vars |
No modo flexível, outros arquivos também podem ser incluídos, desde que estejam localizados em subdiretórios (em qualquer nível) de conf.d
diretório prefixado da seguinte maneira.
Incluir prefixo de diretório superior do arquivo |
---|
conf.d/includes |
conf.d/modsec |
conf.d/rewrites |
Por exemplo, você pode incluir um arquivo em algum diretório recém-criado em conf.d/includes
diretório como a seguir:
Include conf.d/includes/mynewdirectory/myincludefile.conf
Como alternativa, inclua a variável padrão versão das regras de regravação, cujo nome é conf.d/rewrites/default_rewrite.rules
.
Observe que não há versão padrão dos arquivos de variáveis.
Layout de configuração obsoleto detectado, ativando o modo de compatibilidade
Esta mensagem indica que sua configuração tem o layout obsoleto versão 1, contendo uma configuração completa do Apache e arquivos com ams_
prefixos. Embora isso ainda seja suportado para compatibilidade com versões anteriores, você deve alternar para o novo layout.
Observe que a primeira fase também pode ser executar separadamente, em vez do invólucro validate.sh
script.
Quando executado contra seu artefato maven ou seu dispatcher/src
subdiretório, ele relatará falhas de validação:
$ validator full -relaxed dispatcher/src
Cloud manager validator 1.0.4
2019/06/19 15:41:37 Apache configuration uses non-allowlisted directives:
conf.d/enabled_vhosts/aem_publish.vhost:46: LogLevel
2019/06/19 15:41:37 Dispatcher configuration validation failed:
conf.dispatcher.d/enabled_farms/999_ams_publish_farm.any: filter allows access to CRXDE
No Windows, o validador do dispatcher diferencia maiúsculas de minúsculas. Dessa forma, poderá ocorrer uma falha ao validar a configuração se você não respeitar as letras maiúsculas do caminho no qual a configuração reside, por exemplo:
bin\validator.exe -relaxed full src
Cloud manager validator 2.0.xx
2021/03/15 18:15:40 Dispatcher configuration validation failed:
conf.dispatcher.d\available_farms\default.farm:15: parent directory outside server root: c:\k\a\aem-dispatcher-sdk-windows-symlinks-testing3\dispatcher\src
Evite este erro copiando e colando o caminho do Windows Explorer e, em seguida, no prompt de comando usando uma cd
nesse caminho.
Essa fase verifica a sintaxe do Apache, iniciando o Apache HTTPD em um contêiner de docker. O Docker deve ser instalado localmente, mas observe que não é necessário que o AEM esteja em execução.
Os usuários do Windows precisam usar o Windows 10 Professional ou outras distribuições que suportem o Docker. Esse é um pré-requisito para executar e depurar o Dispatcher em um computador local.
Para Windows e macOS, recomendamos o uso do Docker Desktop.
Essa fase também pode ser executada independentemente por meio de bin/docker_run.sh src/dispatcher host.docker.internal:4503 8080
.
Durante uma implantação do Cloud Manager, a variável httpd -t
a verificação de sintaxe também será executada e todos os erros serão incluídos no log de falha da etapa Imagens de compilação do Cloud Manager.
Se houver uma falha nessa fase, isso implica que o Adobe alterou um ou mais arquivos imutáveis e você deve substituir os arquivos imutáveis correspondentes pela nova versão entregue no src
do SDK. A amostra de log abaixo ilustra esse problema:
Phase 3: Immutability check
reading immutable file list from /etc/httpd/immutable.files.txt
(...)
checking existing 'conf.dispatcher.d/clientheaders/default_clientheaders.any' for changes
immutable file 'conf.dispatcher.d/clientheaders/default_clientheaders.any' has been changed:
--- /etc/httpd/conf.dispatcher.d/clientheaders/default_clientheaders.any
+++ /etc/httpd-actual/conf.dispatcher.d/clientheaders/default_clientheaders.any
@@ -40,4 +40,3 @@
"Sling-uploadmode"
"x-requested-with"
"If-Modified-Since"
-"Authorization"
** error: immutable file 'conf.dispatcher.d/clientheaders/default_clientheaders.any' has been changed!
Essa fase também pode ser executada independentemente por meio de bin/docker_immutability_check.sh src/dispatcher
.
Seus arquivos locais imutáveis podem ser atualizados executando o bin/update_maven.sh src/dispatcher
script na pasta do dispatcher, onde src/dispatcher
é o diretório de configuração do dispatcher. Isso também atualizará qualquer arquivo pom.xml no diretório pai para que as verificações de imutabilidade do Maven também sejam atualizadas.
Observe que é possível executar o Apache Dispatcher localmente usando ./bin/docker_run.sh src/dispatcher docker.for.mac.localhost:4503 8080
.
Conforme dito anteriormente, o Docker deve ser instalado localmente e não é necessário que o AEM esteja em execução. Os usuários do Windows precisam usar o Windows 10 Professional ou outras distribuições que suportem o Docker. Esse é um pré-requisito para executar e depurar o Dispatcher em um computador local.
A estratégia a seguir pode ser usada para aumentar a saída de log do módulo Dispatcher e ver os resultados do RewriteRule
avaliação em ambientes locais e de nuvem.
Os níveis de log desses módulos são definidos pelas variáveis DISP_LOG_LEVEL
e REWRITE_LOG_LEVEL
. Elas podem ser definidas no arquivo conf.d/variables/global.vars
. A sua parte relevante é a seguinte:
# Log level for the dispatcher
#
# Possible values are: error, warn, info, debug and trace1
# Default value: warn
#
# Define DISP_LOG_LEVEL warn
# Log level for mod_rewrite
#
# Possible values are: error, warn, info, debug and trace1 - trace8
# Default value: warn
#
# To debug your RewriteRules, it is recommended to raise your log
# level to trace2.
#
# More information can be found at:
# https://httpd.apache.org/docs/current/mod/mod_rewrite.html#logging
#
# Define REWRITE_LOG_LEVEL warn
Ao executar o Dispatcher localmente, os logs são impressos diretamente na saída do terminal. Na maioria das vezes, você deseja que esses registros estejam em DEBUG, o que pode ser feito passando o nível de Depuração como um parâmetro ao executar o Docker. Por exemplo: DISP_LOG_LEVEL=Debug ./bin/docker_run.sh src docker.for.mac.localhost:4503 8080
.
Os logs de ambientes da nuvem são expostos por meio do serviço de log disponível no Cloud Manager.
Para ambientes as a Cloud Service com AEM, depurar é o nível máximo de verbosidade. O nível de log de rastreamento não é compatível, portanto, evite configurá-lo ao trabalhar em ambientes de nuvem.
Devido a uma limitação do sistema operacional Windows, esse recurso está disponível somente para usuários macOS e Linux.
Em vez de executar a validação local (validate.sh
) e iniciando o contêiner do docker (docker_run.sh
) cada vez que a configuração for modificada, você poderá executar o docker_run_hot_reload.sh
script. O script observa qualquer alteração na configuração e a recarregará automaticamente e executará novamente a validação. Ao usar essa opção, você pode economizar uma quantidade significativa de tempo ao depurar.
Você pode executar o script usando o seguinte comando: ./bin/docker_run_hot_reload.sh src/dispatcher host.docker.internal:4503 8080
Observe que as primeiras linhas de saída serão semelhantes ao que seria executado para docker_run.sh
, por exemplo:
~ bin/docker_run_hot_reload.sh src host.docker.internal:8081 8082
opt-in USE_SOURCES_DIRECTLY marker file detected
Running script /docker_entrypoint.d/10-check-environment.sh
Running script /docker_entrypoint.d/15-check-pod-name.sh
Running script /docker_entrypoint.d/20-create-docroots.sh
Running script /docker_entrypoint.d/30-wait-for-backend.sh
Waiting until host.docker.internal is available
host.docker.internal resolves to 192.168.65.2
Running script /docker_entrypoint.d/40-generate-allowed-clients.sh
Running script /docker_entrypoint.d/50-check-expiration.sh
Running script /docker_entrypoint.d/60-check-loglevel.sh
Running script /docker_entrypoint.d/70-check-forwarded-host-secret.sh
Running script /docker_entrypoint.d/80-frontend-domain.sh
Running script /docker_entrypoint.d/zzz-import-sdk-config.sh
WARN Mon Jul 4 09:53:54 UTC 2022: Pseudo symlink conf.d seems to point to a non-existing file!
INFO Mon Jul 4 09:53:55 UTC 2022: Copied customer configuration to /etc/httpd.
INFO Mon Jul 4 09:53:55 UTC 2022: Start testing
Cloud manager validator 2.0.43
2022/07/04 09:53:55 No issues found
INFO Mon Jul 4 09:53:55 UTC 2022: Testing with fresh base configuration files.
INFO Mon Jul 4 09:53:55 UTC 2022: Apache httpd informationServer version: Apache/2.4.54 (Unix)
Atualmente, a mesma configuração do Dispatcher é aplicada a todos os ambientes as a Cloud Service AEM. O tempo de execução terá uma variável de ambiente ENVIRONMENT_TYPE
que contém o modo de execução atual (dev, stage ou prod), bem como uma definição. A definição pode ser ENVIRONMENT_DEV
, ENVIRONMENT_STAGE
ou ENVIRONMENT_PROD
. Na configuração do Apache, a variável pode ser usada diretamente em uma expressão. Como alternativa, a definição pode ser usada para criar lógica:
# Simple usage of the environment variable
ServerName ${ENVIRONMENT_TYPE}.company.com
# When more logic is required
<IfDefine ENVIRONMENT_STAGE>
# These statements are for stage
Define VIRTUALHOST stage.example.com
</IfDefine>
<IfDefine ENVIRONMENT_PROD>
# These statements are for production
Define VIRTUALHOST prod.example.com
</IfDefine>
Na configuração do Dispatcher, a mesma variável de ambiente está disponível. Se mais lógica for necessária, defina as variáveis conforme mostrado no exemplo acima e use-as na seção Configuração do Dispatcher:
/virtualhosts {
{ "${VIRTUALHOST}" }
}
Como alternativa, você pode usar as variáveis de ambiente do Cloud Manager na configuração httpd/dispatcher, embora não em segredos do ambiente. Esse método é especialmente importante se um programa tiver vários ambientes de desenvolvimento e alguns desses ambientes tiverem valores diferentes para a configuração httpd/dispatcher. A mesma sintaxe ${VIRTUALHOST} seria usada como no exemplo acima, no entanto, as declarações Define no arquivo de variáveis acima não seriam usadas. Leia o Documentação do Cloud Manager para obter instruções sobre como configurar as variáveis de ambiente do Cloud Manager.
Ao testar sua configuração localmente, você pode simular diferentes tipos de ambiente transmitindo a variável DISP_RUN_MODE
para o docker_run.sh
script diretamente:
$ DISP_RUN_MODE=stage docker_run.sh src docker.for.mac.localhost:4503 8080
O modo de execução padrão ao não transmitir um valor para DISP_RUN_MODE é "dev".
Para obter uma lista completa das opções e variáveis disponíveis, execute o script docker_run.sh
sem argumentos.
Com configurações específicas de ambiente, pode ser difícil determinar como é a configuração real do Dispatcher. Depois de iniciar o contêiner do docker com docker_run.sh
pode ser objeto de dumping do seguinte modo:
$ docker ps
CONTAINER ID IMAGE
d75fbd23b29 adobe/aem-ethos/dispatcher-publish:...
$ docker exec d75fbd23b29 httpd-test
# Dispatcher configuration: (/etc/httpd/conf.dispatcher.d/dispatcher.any)
/farms {
/publishfarm {
/clientheaders {
...
Com a versão 2021.7.0 do Cloud Manager, novos programas do Cloud Manager geram estruturas de projeto maven com Arquétipo AEM 28 ou superior, que inclui o arquivo opt-in/USE_SOURCES_DIRECTLY. Isso remove as limitações anteriores do modo herdado aproximadamente o número e o tamanho dos arquivos, fazendo com que o SDK e o tempo de execução validem e implantem a configuração de maneira aprimorada. Se a configuração do dispatcher não tiver esse arquivo, é altamente recomendável migrar. Use as seguintes etapas para garantir uma transição segura:
Teste local. Usando o SDK de ferramentas mais recentes do Dispatcher, adicione a pasta e o arquivo opt-in/USE_SOURCES_DIRECTLY
. Siga as instruções de "validação local" neste artigo para testar se o dispatcher funciona localmente.
Teste de desenvolvimento na nuvem:
opt-in/USE_SOURCES_DIRECTLY
para uma ramificação Git implantada pelo pipeline de não produção em um ambiente de desenvolvimento na nuvem.No modo flexível, você deve usar caminhos relativos em vez de caminhos absolutos.