Arquivos somente leitura ou imutáveis no AEM

Descrição

Ambiente
Experience Manager

Problema/Sintomas
Este documento descreverá quais arquivos estão bloqueados e não devem ser alterados, e como fazer as configurações desejadas corretamente.

Quando o Adobe Managed Services (AMS) fornece um sistema, ele executa uma configuração de linha de base que torna tudo funcional e seguro.  Essas são coisas que o AMS deseja garantir que permaneçam como uma linha de base de funcionalidade e segurança. Para conseguir isso, alguns arquivos são marcados como somente leitura e imutáveis para evitar que você os altere.

O layout não impede que você altere seu comportamento e substitua as alterações necessárias. Em vez de alterar esses arquivos, você sobreporá seu próprio arquivo que substitui o original.

Isso também permite garantir que, quando o AMS corrigir os dispatchers com as correções e aprimoramentos de segurança mais recentes, eles não alterarão seus arquivos.  Em seguida, você pode continuar a se beneficiar das melhorias e adotar apenas as alterações desejadas.
Mostra uma faixa de boliche com uma bola rolando pela pista. A bola tem uma seta com a palavra mostrando 'você'. Os para-choques são levantados e eles têm a palavra 'arquivos imutáveis' acima deles.
Como ilustrado na figura acima, arquivos imutáveis não impedem que você jogue o jogo.  Eles só te impedem de prejudicar sua performance e te manter na pista.  Este método permite usar os poucos recursos mais importantes:

  • As personalizações são manipuladas em seus próprios espaços de segurança
  • A sobreposição de alterações personalizadas espelha a dos métodos de sobreposição no AEM
  • A correção de configurações do AMS pode ser feita sem alterar as personalizações
  • Testar a instalação básica vs. configurações personalizadas pode ser feito simultaneamente para ajudar a discernir se os problemas são causados por personalizações ou por algo mais que quais arquivos?

Esta é uma lista típica de arquivos implantados com um dispatcher:

/etc/httpd/
├── conf
│   └── httpd.conf
├── conf.d
│   ├── available_vhosts
│   │   ├── 000_unhealthy_author.vhost
│   │   ├── 000_unhealthy_publish.vhost
│   │   ├── aem_author.vhost
│   │   ├── aem_flush.vhost
│   │   ├── aem_health.vhost
│   │   ├── aem_lc.vhost
│   │   └── aem_publish.vhost
│   ├── dispatcher_vhost.conf
│   ├── enabled_vhosts
│   │   ├── aem_author.vhost -`>`  /etc/httpd/conf.d/available_vhosts/aem_author.vhost
│   │   ├── aem_flush.vhost -`>`  /etc/httpd/conf.d/available_vhosts/aem_flush.vhost
│   │   ├── aem_health.vhost -`>`  /etc/httpd/conf.d/available_vhosts/aem_health.vhost
│   │   └── aem_publish.vhost -`>`  /etc/httpd/conf.d/available_vhosts/aem_publish.vhost
│   ├── logformat.conf
│   ├── remoteip.conf
│   ├── rewrites
│   │   ├── base_rewrite.rules
│   │   └── xforwarded_forcessl_rewrite.rules
│   ├── security.conf
│   ├── variables
│   │   └── ams_default.vars
│   └── whitelists
│       └── 000_base_whitelist.rules
├── conf.dispatcher.d
│   ├── available_farms
│   │   ├── 000_ams_author_farm.any
│   │   ├── 001_ams_lc_farm.any
│   │   └── 999_ams_publish_farm.any
│   ├── cache
│   │   ├── ams_author_cache.any
│   │   ├── ams_author_invalidate_allowed.any
│   │   ├── ams_publish_cache.any
│   │   └── ams_publish_invalidate_allowed.any
│   ├── clientheaders
│   │   ├── ams_author_clientheaders.any
│   │   ├── ams_common_clientheaders.any
│   │   ├── ams_lc_clientheaders.any
│   │   └── ams_publish_clientheaders.any
│   ├── dispatcher.any
│   ├── enabled_farms
│   │   ├── 000_ams_author_farm.any -`>`  /etc/httpd/conf.dispatcher.d/available_farms/000_ams_author_farm.any

│   │   └── 999_ams_publish_farm.any -`>`  /etc/httpd/conf.dispatcher.d/available_farms/999_ams_publish_farm.any
│   ├── filters
│   │   ├── ams_author_filters.any
│   │   ├── ams_lc_filters.any
│   │   └── ams_publish_filters.any
│   ├── renders
│   │   ├── ams_author_renders.any
│   │   ├── ams_lc_renders.any
│   │   └── ams_publish_renders.any
│   └── vhosts
│       ├── ams_author_vhosts.any
│       ├── ams_lc_vhosts.any
│       └── ams_publish_vhosts.any
├── conf.modules.d
│   ├── 01-cgi.conf
│   └── 02-dispatcher.conf
└── modules -`>`  ../../usr/lib64/httpd/modules
    └── mod_dispatcher.so

Para determinar quais arquivos são imutáveis, você pode executar o seguinte comando em um dispatcher para ver:

$ lsattr -Rl /etc/httpd 2 > /dev/null | grep Immutable

Esta é uma amostra de resposta de quais arquivos são imutáveis:

/etc/httpd/conf/httpd.conf   Immutable
/etc/httpd/conf.d/available_vhosts/aem_author.vhost Immutable
/etc/httpd/conf.d/available_vhosts/aem_publish.vhost Immutable
/etc/httpd/conf.d/available_vhosts/aem_lc.vhost Immutable
/etc/httpd/conf.d/available_vhosts/aem_flush.vhost Immutable
/etc/httpd/conf.d/available_vhosts/aem_health.vhost Immutable
/etc/httpd/conf.d/available_vhosts/000_unhealthy_author.vhost Immutable
/etc/httpd/conf.d/available_vhosts/000_unhealthy_publish.vhost Immutable
/etc/httpd/conf.d/rewrites/base_rewrite.rules Immutable
/etc/httpd/conf.d/rewrites/xforwarded_forcessl_rewrite.rules Immutable
/etc/httpd/conf.d/whitelists/000_base_whitelist.rules Immutable
/etc/httpd/conf.d/dispatcher_vhost.conf Immutable
/etc/httpd/conf.d/logformat.conf Immutable
/etc/httpd/conf.d/security.conf Immutable
/etc/httpd/conf.modules.d/02-dispatcher.conf Immutable
/etc/httpd/conf.dispatcher.d/available_farms/000_ams_author_farm.any Immutable
/etc/httpd/conf.dispatcher.d/available_farms/999_ams_publish_farm.any Immutable
/etc/httpd/conf.dispatcher.d/available_farms/001_ams_lc_farm.any Immutable
/etc/httpd/conf.dispatcher.d/cache/ams_author_cache.any Immutable
/etc/httpd/conf.dispatcher.d/cache/ams_author_invalidate_allowed.any Immutable
/etc/httpd/conf.dispatcher.d/cache/ams_publish_cache.any Immutable
/etc/httpd/conf.dispatcher.d/cache/ams_publish_invalidate_allowed.any Immutable
/etc/httpd/conf.dispatcher.d/clientheaders/ams_author_clientheaders.any Immutable
/etc/httpd/conf.dispatcher.d/clientheaders/ams_publish_clientheaders.any Immutable
/etc/httpd/conf.dispatcher.d/clientheaders/ams_common_clientheaders.any Immutable
/etc/httpd/conf.dispatcher.d/clientheaders/ams_lc_clientheaders.any Immutable
/etc/httpd/conf.dispatcher.d/filters/ams_author_filters.any Immutable
/etc/httpd/conf.dispatcher.d/filters/ams_publish_filters.any Immutable
/etc/httpd/conf.dispatcher.d/filters/ams_lc_filters.any Immutable
/etc/httpd/conf.dispatcher.d/renders/ams_author_renders.any Immutable
/etc/httpd/conf.dispatcher.d/renders/ams_publish_renders.any Immutable
/etc/httpd/conf.dispatcher.d/renders/ams_lc_renders.any Immutable
/etc/httpd/conf.dispatcher.d/vhosts/ams_author_vhosts.any Immutable
/etc/httpd/conf.dispatcher.d/vhosts/ams_publish_vhosts.any Immutable
/etc/httpd/conf.dispatcher.d/vhosts/ams_lc_vhosts.any Immutable
/etc/httpd/conf.dispatcher.d/dispatcher.any Immutable

Resolução

Como fazer alterações?
Variáveis
As variáveis permitem fazer alterações funcionais sem alterar os próprios arquivos de configuração. Determinados elementos da configuração podem ser ajustados com o ajuste dos valores das variáveis.  Um exemplo que podemos destacar do arquivo /etc/httpd/conf.d/dispatcher_vhost.conf é mostrado aqui:

Include /etc/httpd/conf.d/variables/ams_default.vars
`<` IfModule disp_apache2.c`>`
    DispatcherConfig conf.dispatcher.d/dispatcher.any
    DispatcherLog    logs/dispatcher.log
    DispatcherLogLevel ${DISP_LOG_LEVEL}
    DispatcherDeclineRoot 0
    DispatcherUseProcessedURL 1
`<` /IfModule`>`

Veja como a diretiva DispatcherLogLevel tem uma variável de DISP_LOG_LEVEL em vez do valor normal que você veria lá.  Acima dessa seção do código, você também verá uma instrução include em um arquivo de variáveis.  O arquivo de variável /etc/httpd/conf.d/variables/ams_default.vars é o próximo ponto que queremos observar.  Aqui está o conteúdo desse arquivo de variáveis:

Define DISP_LOG_LEVEL info
Define AUTHOR_WHITELIST_ENABLED 0
Define PUBLISH_WHITELIST_ENABLED 0
Define LIVECYCLE_WHITELIST_ENABLED 0
Define AUTHOR_FORCE_SSL 1
Define PUBLISH_FORCE_SSL 0
Define LIVECYCLE_FORCE_SSL 1

Você vê acima que o valor atual da variável DISP_LOG_LEVEL é 'info'.  Podemos ajustar para rastrear ou depurar, ou o valor/nível do número de sua escolha.  Agora, em todos os lugares que controlam o nível de log, ele se ajustará automaticamente.
Método de sobreposição
Entenda os arquivos de inclusão de nível superior, pois eles serão o local inicial para fazer personalizações. Para começar com um exemplo simples, temos um cenário em que queremos adicionar um novo nome de domínio que pretendemos apontar para este dispatcher. O exemplo de domínio que usaremos é we-retail.adobe.com.  Começaremos copiando um arquivo de configuração existente em um novo, onde podemos adicionar as alterações:

$ cp /etc/httpd/conf.d/available_vhosts/aem_publish.vhost /etc/httpd/conf.d/available_vhosts/weretail_publish.vhost

Copiamos o arquivo aem_publish.vhost existente porque ele já tem o que precisamos para que as coisas funcionem e não queremos reinventar um início já forte.  Agora editamos o novo arquivo weretail.vhost e fazemos as alterações necessárias.

Antes:

`<` VirtualHost *:80`>`
    ServerName    publish
    ServerAlias    ${PUBLISH_DEFAULT_HOSTNAME}
    DocumentRoot    ${PUBLISH_DOCROOT}
    `<` IfModule mod_headers.c`>`
            Header always add X-Dispatcher ${DISP_ID}
            Header always add X-Vhost "publish"
            Header merge X-Frame-Options SAMEORIGIN "expr=%{resp:X-Frame-Options}!='SAMEORIGIN'"
            Header merge X-Content-Type-Options nosniff "expr=%{resp:X-Content-Type-Options}!='nosniff'"
        Header append Vary User-Agent env=!dont-vary
    `<` /IfModule`>`
....... SNIP.......
`<` /VirtualHost`>`

Depois:

`<` VirtualHost *:80`>`
    ServerName    weretail-publish
    ServerAlias    we-retail.adobe.com
    DocumentRoot    ${PUBLISH_DOCROOT}
    `<` IfModule mod_headers.c`>`
            Header always add X-Dispatcher ${DISP_ID}
            Header always add X-Vhost "werteail-publish"
            Header merge X-Frame-Options SAMEORIGIN "expr=%{resp:X-Frame-Options}!='SAMEORIGIN'"
            Header merge X-Content-Type-Options nosniff "expr=%{resp:X-Content-Type-Options}!='nosniff'"
        Header append Vary User-Agent env=!dont-vary
    `<` /IfModule`>`
....... SNIP.......
`<` /VirtualHost`>`

Agora atualizamos nosso ServerName e ServerAlias para corresponder aos novos nomes de domínio, bem como atualizar outros cabeçalhos de navegação estrutural.  Agora vamos permitir que nosso novo arquivo permita que o apache saiba usar nosso novo arquivo:

$ cd /etc/httpd/conf.d/enabled_vhosts/; ln -s ../available_vhosts/weretail_publish.vhost .

Agora, o servidor Web apache sabe que o domínio é algo para o qual ele deve fornecer tráfego, mas ainda precisamos informar ao módulo Dispatcher que ele tem um novo nome de domínio para honrar.  Começaremos criando um novo arquivo *_vhost.any /etc/httpd/conf.dispatcher.d/vhosts/weretail_vhosts.any e, dentro desse arquivo, colocaremos o nome de domínio que queremos honrar:

"we-retail.adobe.com"

Agora, precisamos criar um novo arquivo farm que usará nosso novo arquivo de entrada vhost e começaremos copiando um arquivo de início forte para o novo.

$ cp /etc/httpd/conf.dispatcher.d/available_farms/999_ams_publish_farm.any /etc/httpd/conf.dispatcher.d/available_farms/400_weretail_publish_farm.any

Vamos mostrar as alterações que precisaremos fazer neste arquivo farm

Antes:

/publishfarm {
    /virtualhosts {
        $include "/etc/httpd/conf.dispatcher.d/vhosts/ams_publish_vhosts.any"
    }
........SNIP.........
}

Depois:

/weretailpublishfarm {
    /virtualhosts {
        $include "/etc/httpd/conf.dispatcher.d/vhosts/weretail_publish_vhosts.any"
    }
........SNIP.........
}

Agora atualizamos o nome do farm e o item de inclusão é usado na seção /virtualhosts da configuração do farm.  Precisamos ativar este novo arquivo farm para que ele possa usá-lo na configuração em execução:

$ cd /etc/httpd/conf.dispatcher.d/enabled_farms/; ln -s ../available_farms/400_weretail_publish_farm.any .

Agora, basta recarregar o serviço do servidor da Web e usar nosso novo domínio!

Observação:

Observe que alteramos apenas as partes necessárias para alterar e aproveitar as inclusões e o código existentes que vieram com os arquivos de configuração da linha de base.  Temos apenas de definir o elemento que precisamos de mudar.  Torna as coisas muito mais fáceis e nos permite manter menos código

Nesta página