Explicación de los archivos de configuración | AEM

Descripción description

Entorno

Experience Manager

Problema/Síntomas

Este documento desglosa y explica cada uno de los archivos de configuración implementados en un servidor de Dispatcher creado de forma estándar y aprovisionado en Adobe Managed Services. Su uso, convención de nomenclatura, etc.

Convención de nombres

A Apache Webserver en realidad no le importa cuál sea la extensión de archivo de un archivo al segmentarlo con una instrucción opcional include o include. Nombrarlos apropiadamente con nombres que eliminen los conflictos y la confusión ayuda mucho. Los nombres utilizados describirán el ámbito de aplicación del archivo, lo que facilita las cosas. Si todo se llama .conf, esto se vuelve muy confuso. Evite archivos y extensiones con nombres incorrectos.

A continuación se muestra una lista de las diferentes extensiones de archivo personalizadas y convenciones de nomenclatura utilizadas en una configuración de Dispatcher típica de AMS.

Archivos incluidos en conf.d/

Archivos incluidos en conf.module.d/

Problemas evitados

Al seguir la convención de nombres, evite algunos errores bastante fáciles de cometer que pueden tener resultados catastróficos. Veamos unos cuantos ejemplos.

Ejemplo de problema

Como ejemplo de sitio para ExampleCo, los desarrolladores de las configuraciones de Dispatcher crean dos archivos de configuración.

/etc/httpd/conf.d/exampleco.conf

<VirtualHost *:80>

    ServerName  "exampleco"

    ServerAlias "www.exampleco.com"

    .......... SNIP ...............

    <IfModule mod_rewrite.c>

        ReWriteEngine   on

        LogLevel warn rewrite:trace1

        Include /etc/httpd/conf.d/rewrites/exampleco.conf

    </IfModule>

</VirtualHost>

/etc/httpd/conf.d/rewrites/exampleco.conf

RewriteRule /$ /content/exampleco/en.html [ PT,L]

RewriteRule /robots.txt$ /content/dam/exampleco/robots.txt [ PT,L]

PELIGRO POTENCIAL

A. Los nombres de archivo son los mismos.

Si el archivo vhost se coloca accidentalmente en la carpeta de reescritura y el archivo de reescritura se coloca en la carpeta vhosts. Parece que el nombre de archivo lo implementa correctamente, pero Apache genera un error y el problema no se ve inmediatamente.

¿Cómo se convierte esto en un problema?

Si los dos archivos se descargan en la misma ubicación, pueden sobrescribirse o hacerse indistinguibles, lo que convierte el proceso de implementación en una pesadilla.

B. Las extensiones de archivo son las mismas y propensas a la inclusión automática

Las extensiones de archivo son las mismas y utilizan la extensión incluida automáticamente que Apache incluye automáticamente cualquier archivo .conf en muchas de sus carpetas predeterminadas.

¿Cómo se convierte esto en un problema?

Si el archivo vhost con la extensión .conf se coloca en la carpeta /etc/httpd/conf.d/ intentará cargarlo en la memoria en Apache, lo que suele ser correcto, pero si el archivo de reglas de reescritura con la extensión .conf se coloca en la carpeta /etc/httpd/conf.d/, se incluirá automáticamente y se aplicará globalmente, causando resultados confusos y no deseados.

Resolución resolution

Asigne a los archivos un nombre basado en lo que hacen y de forma segura fuera del área de nombres de reglas de inclusión automática.

El uso de estas convenciones de nomenclatura evita problemas si un archivo se mueve a un directorio de inclusión automática al que no pertenece.

Por ejemplo, poner un archivo denominado con .rules, .any o .vhost en la carpeta de inclusión automática de /etc/httpd/conf.d/ no tendría ningún efecto.

Si una solicitud de cambio de implementación indica please deploy exampleco_rewrite.rules to production dispatchers, la persona que implementa los cambios ya puede saber que no está agregando un nuevo sitio; simplemente está actualizando las reglas de reescritura tal como indica el nombre de archivo.

Incluir pedido

Al ampliar la funcionalidad y las configuraciones en el servidor web Apache instalado en Enterprise Linux, tiene algunos pedidos de inclusión importantes que querrá comprender.

A. La Línea Base De Apache Incluye

El binario de Apache comienza con httpd.conf, que hace un includeoptional a los directorios conf.d/*.conf y conf.modules.d/*.conf.

Como se ve en el diagrama anterior, el binario httpd solo busca el archivo httpd.conf como su archivo de configuración. Ese archivo contiene las siguientes instrucciones:

Include conf.modules.d/*.conf
IncludeOptional conf.d/*.conf

B. El nivel superior de AMS incluye

Al aplicar nuestro estándar, añadimos algunos tipos de archivo adicionales e incluimos los nuestros.

Estos son los directorios de línea de base de AMS y las inclusiones de nivel superior

Basándonos en la línea de base de Apache, mostramos cómo AMS creó algunas carpetas adicionales e inclusiones de nivel superior para conf.d carpetas, así como directorios específicos de módulos anidados en /etc/httpd/conf.dispatcher.d/

Cuando Apache carga, extrae /etc/httpd/conf.modules.d/02-dispatcher.conf y ese archivo incluye el archivo binario /etc/httpd/modules/mod_dispatcher.so en su estado de ejecución.

LoadModule dispatcher_module modules/mod_dispatcher.so

Para usar el módulo en nuestro </VirtualHost>, soltamos un archivo de configuración en /etc/httpd/conf.d/ llamado dispatcher_vhost.conf y dentro de este archivo verá el uso de setup para que el módulo funcione:

<IfModule disp_apache2.c>
DispatcherConfig conf.dispatcher.d /dispatcher .any
...SNIP...
</IfModule>

Como puede ver arriba, esto incluye el archivo dispatcher.any de nivel superior para que nuestro módulo de Dispatcher recoja sus archivos de configuración de /etc/httpd/conf.dispatcher.d/dispatcher.any

Preste atención al contenido de este archivo:

/farms {
 $include "enabled_farms/*_farm.any"
}

El archivo Dispatcher.any incluye todos los archivos de granja habilitados que se encuentran en /etc/httpd/conf.dispatcher.d/enabled_farms/ con el nombre de archivo de <FILENAME>_farm.any, que sigue nuestra convención de nomenclatura estándar.

Más adelante en el archivo dispatcher_vhost.conf mencionado anteriormente también se hace una instrucción de inclusión para habilitar cada archivo host virtual habilitado que se encuentre en /etc/httpd/conf.d/enabled_vhosts/ con el nombre de archivo de <FILENAME>.vhost, que sigue nuestra convención de nomenclatura estándar.

IncludeOptional /etc/httpd/conf.d/enabled_vhosts/*.vhost

En cada uno de nuestros archivos .vhost verá que el módulo de Dispatcher se inicializa como controlador de archivo predeterminado para un directorio. Este es un ejemplo de archivo .vhost para mostrar la sintaxis:

<VirtualHost *:80>
 ServerName "weretail"
 ServerAlias www.weretail.com weretail.com
 <Directory />
 <IfModule disp_apache2.c>
 ....SNIP....
 SetHandler dispatcher-handler
 </IfModule>
 ....SNIP....
 </Directory>
 ....SNIP....
</VirtualHost>

Después de que el nivel superior incluye la resolución, tienen otras sub-inclusiones que vale la pena mencionar. Este es un diagrama de alto nivel sobre cómo los archivos farms y vhosts incluyen otros subelementos

C. El host virtual de AMS incluye

Cuando cualquier archivo .vhost del directorio /etc/httpd/conf.d/availabled_vhosts/ se enlace simbólicamente al directorio /etc/httpd/conf.d/enabled_vhosts/, se utilizará en la configuración en ejecución.

Los archivos .vhost tienen sub-inclusiones basadas en partes comunes que hemos encontrado. Cosas como variables, listas blancas y reglas de reescritura.

El archivo .vhost tendrá instrucciones de inclusión para cada archivo en función de dónde deban incluirse en el archivo .vhost. Esta es una sintaxis de ejemplo de un archivo .vhost como buena referencia:

Include /etc/httpd/conf .d /variables/weretail .vars VirtualHost *:80
ServerName "${MAIN_DOMAIN}"
Directory / Include /etc/httpd/conf .d /whitelists/weretail *_whitelist.rules
IfModule disp_apache2.c
....SNIP....
SetHandler dispatcher-handler
/IfModule
....SNIP....
/Directory
....SNIP....
IfModule mod_rewrite.c
ReWriteEngine on
LogLevel warn rewrite:trace1
Include /etc/httpd/conf .d /rewrites/weretail_rewrite .rules
/IfModule /VirtualHost

Como puede ver en el ejemplo anterior, hay una inclusión para las variables necesarias en este archivo de configuración que se utilizan más adelante.

Dentro del archivo /etc/httpd/conf.d/variables/weretail.vars podemos ver qué variables están definidas:

Define MAIN_DOMAIN dev.weretail.com

También puede ver una línea que incluye una lista de archivos whitelist.rules que restringen quién puede ver este contenido en función de diferentes criterios de la lista blanca. Veamos el contenido de uno de los archivos de la lista blanca /etc/httpd/conf.d/whitelists/weretail_mainoffice_whitelist.rules:

<RequireAny>
 Require ip 192.150.16.0/23
</RequireAny>

También puede ver una línea que incluye un conjunto de reglas de reescritura. Vamos a echar un vistazo al contenido del archivo weretail_rewrite.rules:

RewriteRule /robots.txt$ /content/dam/weretail/robots.txt [ NC,PT]
RewriteCond %{SERVER_NAME} brand1.weretail.net [ NC]
RewriteRule /favicon.ico$ /content/dam/weretail/favicon.ico [ NC,PT]
RewriteCond %{SERVER_NAME} brand2.weretail.com [ NC]
RewriteRule /sitemap.xml$ /content/weretail/general/sitemap.xml [ NC,PT]
RewriteRule /logo.jpg$ /content/dam/weretail/general/logo.jpg [ NC,PT]

D. La granja de AMS incluye

Cuando cualquier archivo <FILENAME>_farm.any del directorio /etc/httpd/conf.dispatcher.d/available_farms/ se enlace simbólicamente al directorio /etc/httpd/conf.dispatcher.d/enabled_farms/, se utilizará en la configuración en ejecución.

Los archivos de granja tienen subinclusiones basadas en secciones de nivel superior de la granja, como caché, clientheaders, filtros, procesamientos y vhosts.

Los <FILENAME>_farm.any archivos tendrán instrucciones de inclusión para cada archivo en función de dónde deban incluirse en el archivo de granja. Esta es una sintaxis de ejemplo de un archivo <FILENAME>_farm.any como buena referencia:

/weretailfarm {
 /clientheaders {
 $include "/etc/httpd/conf.dispatcher.d/clientheaders/ams_publish_clientheaders.any"
 $include "/etc/httpd/conf.dispatcher.d/clientheaders/ams_common_clientheaders.any"
 }
 /virtualhosts {
 $include "/etc/httpd/conf.dispatcher.d/vhosts/weretail_vhosts.any"
 }
 /renders {
 $include "/etc/httpd/conf.dispatcher.d/renders/ams_publish_renders.any"
 }
 /filter {
 $include "/etc/httpd/conf.dispatcher.d/filters/ams_publish_filters.any"
 $include "/etc/httpd/conf.dispatcher.d/filters/weretail_search_filters.any"
 }
 ....SNIP....
 /cache {
 ....SNIP....
 /rules {
 $include "/etc/httpd/conf.dispatcher.d/cache/ams_publish_cache.any"
 }
 ....SNIP....
 /allowedClients {
 /0000 {
 /glob "*.*.*.*"
 /type "deny"
 }
 $include "/etc/httpd/conf.dispatcher.d/cache/ams_publish_invalidate_allowed.any"
 }
 ....SNIP....
 }
}

Como puede ver en cada sección de la granja de servidores de correo electrónico, en lugar de tener toda la sintaxis necesaria, se utiliza una instrucción de inclusión.

Veamos la sintaxis de algunas de estas inclusiones para tener la idea de qué aspecto tendría cada subíndice /etc/httpd/conf.dispatcher.d/vhosts/weretail_publish_vhosts.any:

"brand1.weretail.com"
"brand2.weretail.com"
"www.weretail.comf"

Como puede ver, es una nueva lista separada por líneas de nombres de dominio que deben procesarse desde esta granja sobre los demás.

A continuación, veamos /etc/httpd/conf.dispatcher.d/filters/weretail_search_filters.any:

/400 { /type "allow" /method "GET" /path "/bin/weretail/lists/*" /extension "json" }
/401 { /type "allow" /method "POST" /path "/bin/weretail/search/" /extension "html" }