Explicación de los archivos de configuración

Tabla de contenidos

<- Anterior: diseño básico del archivo

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 nomenclatura

Al servidor web Apache no le importa realmente la extensión de archivo de un archivo cuando se le dirige con una instrucción Include o IncludeOptional.  Nombrarlos apropiadamente con nombres que eliminen conflictos y confusión ayudará a ton. Los nombres utilizados describirán el ámbito de aplicación del archivo, lo que facilita las cosas. Si todo se llama .conf, esto puede resultar muy confuso. Queremos evitar 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.dispatcher.d/

Problemas evitados

Al seguir la convención de nombres, puede evitar algunos errores bastante fáciles de cometer que pueden tener resultados catastróficos.  Vamos a ver algunos ejemplos.

Ejemplo de problema

Como ejemplo de sitio para ExampleCo, los desarrolladores de las configuraciones de Dispatcher crearon 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]

POTENTIAL DANGER - The file names are the same

Si el archivo vhost se coloca accidentalmente en la carpeta rewrites y rewrites file se coloca en la carpeta vhosts.  Parece que el nombre de archivo lo ha implementado correctamente, pero Apache generará ERROR y el problema no se mostrará inmediatamente.

Cómo se convierte esto en un problema

Si se descargan los two files en la ubicación same, pueden overwrite themselves o no distinguirlos, lo que convierte el proceso de implementación en una pesadilla.

Las extensiones de archivo son las mismas y propensas a incluirse automáticamente

Las extensiones de archivo son las mismas y usan la extensión incluida automáticamente que Apache auto include cualquier .conf archivo 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, lo que causará resultados confusos y no deseados.

Resolución

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.

Si se trata de un archivo host virtual, póngale el nombre con .vhost como extensión.

Si se trata de un archivo de reglas de reescritura, póngale nombre con el sitio _rewrite.rules como sufijo y extensión. Esta convención de nombres aclarará para qué sitio es y que es un conjunto de reglas de reescritura.

Si se trata de un archivo de regla de lista blanca de IP, póngale nombre a description_whitelist.rules como sufijo y extensión. Esta convención de nombres le dará una descripción de para qué sirve y de que es un conjunto de reglas coincidentes de IP.

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

Por ejemplo, poner un archivo con el nombre .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 "implemente example_rewrite.rules en Dispatchers de producción", la persona que implementa los cambios ya puede saber que no está agregando un nuevo sitio, solo 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

La Línea Base Apache Incluye

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

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 se cargue, se abrirá /etc/httpd/conf.modules.d/02-dispatcher.conf y ese archivo incluirá 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 de nivel superior dispatcher.any 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 de nivel superior 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 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

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 de .vhost tienen subinclusiones basadas en elementos 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 se deban incluir 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 _whitelist.rules archivos 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]

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 cómo se vería cada subcomponente

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

Siguiente -> Explicación de la caché