Spiegazione dei file di configurazione

Sommario

<- Precedente: Layout dei file di base

Questo documento analizza e spiega tutti i file di configurazione distribuiti in un server Dispatcher standard fornito in Adobe Managed Services. Il loro uso, le convenzioni di denominazione, ecc…

Convenzione di denominazione

Apache Web Server non si preoccupa effettivamente dell’estensione di un file quando esegue il targeting con un’istruzione Include o IncludeOptional.  Assegnare nomi corretti che eliminino conflitti e confusione aiuta a tonnellata. I nomi utilizzati descrivono l’ambito di applicazione del file per facilitarne l’utilizzo. Se tutto si chiama .conf, si crea molta confusione. Vogliamo evitare file ed estensioni con nomi errati.  Di seguito è riportato un elenco delle diverse estensioni di file personalizzati e convenzioni di denominazione utilizzate in un tipico Dispatcher configurato in AMS.

File contenuti in conf.d/

File contenuti in conf.dispatcher.d/

Problemi evitati

Quando si segue la convenzione di denominazione è possibile evitare alcuni errori abbastanza facili da commettere che possono avere risultati catastrofici.  Seguiremo alcuni esempi.

Esempio di problema

Come esempio di sito per ExampleCo sono stati creati due file di configurazione dagli sviluppatori delle configurazioni Dispatcher.

/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

Se il file vhost viene inserito accidentalmente nella cartella rewrites e rewrites file viene inserito nella cartella vhosts.  Il nome file potrebbe essere stato distribuito correttamente, tuttavia Apache genererà un ERRORE e il problema non sarà immediatamente evidente.

Questo problema si pone in genere

Se i two files vengono scaricati nel percorso same, possono essere overwrite themselves o renderli indistinguibili, rendendo il processo di distribuzione un incubo.

Le estensioni dei file sono le stesse e includono automaticamente i file proni

Le estensioni dei file sono le stesse e utilizzano l'estensione inclusa automaticamente che Apache auto include qualsiasi file .conf in molte delle sue cartelle predefinite.

Questo problema si pone in genere

Se il file vhost con estensione di .conf viene inserito nella cartella /etc/httpd/conf.d/, tenterà di caricarlo in memoria su Apache, in genere senza problemi, ma se il file delle regole di riscrittura con estensione di .conf viene inserito nella cartella /etc/httpd/conf.d/, verrà incluso automaticamente e applicato globalmente, causando risultati confusi e indesiderati.

Risoluzione

Denomina i file in base alle operazioni eseguite e in modo sicuro fuori dallo spazio dei nomi delle regole di inclusione automatica.

Se si tratta di un nome di file host virtuale, con .vhost come estensione.

Se si tratta di un file di regole di riscrittura, assegnargli un nome con sito_rewrite.rules come suffisso ed estensione. Questa convenzione per i nomi chiarirà a quale sito è destinata e che si tratta di un set di regole di riscrittura.

Se si tratta di un file di regole della whitelist IP, denominalo _whitelist.rules come suffisso ed estensione. Questa convenzione per i nomi fornirà una descrizione del suo scopo e del fatto che si tratta di un set di regole di corrispondenza IP.

L’utilizzo di queste convenzioni di denominazione evita problemi, se un file viene spostato in una directory di inclusione automatica a cui non appartiene.

Ad esempio, inserire un file denominato con .rules, .any o .vhost nella cartella di inclusione automatica di /etc/httpd/conf.d/ non avrebbe alcun effetto.

Se una richiesta di modifica della distribuzione riporta la dicitura "distribuisci example_rewrite.rules ai Dispatcher di produzione", chi distribuisce le modifiche può già sapere che non sta aggiungendo un nuovo sito, ma sta semplicemente aggiornando le regole di riscrittura come indicato dal nome del file.

Includi ordine

Quando si estendono funzionalità e configurazioni in Apache Webserver installato su Enterprise Linux si hanno alcuni importanti ordini di inclusione che si desidera comprendere

La linea di base di Apache include

Come mostrato nel diagramma precedente, il file binario httpd cerca solo il file httpd.conf come file di configurazione.  Tale file contiene le seguenti istruzioni:

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

Include il primo livello di AMS

Quando abbiamo applicato il nostro standard abbiamo aggiunto alcuni tipi di file aggiuntivi e include.

Di seguito sono elencate le directory della linea di base di AMS e i principali livelli di inclusione

Basandoci sulla linea di base di Apache, viene mostrato come AMS ha creato alcune cartelle aggiuntive e include di primo livello per conf.d cartelle, nonché directory specifiche per i moduli nidificate in /etc/httpd/conf.dispatcher.d/

Quando Apache viene caricato, eseguirà il pull in /etc/httpd/conf.modules.d/02-dispatcher.conf e il file includerà il file binario /etc/httpd/modules/mod_dispatcher.so nel suo stato di esecuzione.

LoadModule dispatcher_module modules /mod_dispatcher .so

Per utilizzare il modulo in <VirtualHost />, viene rilasciato un file di configurazione in /etc/httpd/conf.d/ denominato dispatcher_vhost.conf, all'interno del quale vengono visualizzati i parametri di base necessari per il funzionamento del modulo:

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

Come vedi sopra, questo include il file di livello principale dispatcher.any per il modulo Dispatcher per raccogliere i file di configurazione da /etc/httpd/conf.dispatcher.d/dispatcher.any

Presta attenzione al contenuto di questo file:

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

Il file di livello principale dispatcher.any include tutti i file di farm abilitati che risiedono in /etc/httpd/conf.dispatcher.d/enabled_farms/ con il nome di file FILENAME_farm.any, che segue la convenzione di denominazione standard.

Più avanti nel file dispatcher_vhost.conf menzionato in precedenza viene inoltre eseguita un'istruzione include per abilitare ogni file host virtuale abilitato che risiede in /etc/httpd/conf.d/enabled_vhosts/ con il nome file di FILENAME.vhost, che segue la convenzione di denominazione standard.

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

In ciascuno dei nostri file .vhost noterai che il modulo Dispatcher viene inizializzato come gestore di file predefinito per una directory.  Ecco un esempio di file .vhost per mostrare la sintassi:

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

Dopo che il livello superiore include la risoluzione, hanno altre inclusioni secondarie che vale la pena menzionare.  Ecco un diagramma di alto livello su come i file farm e vhosts includono altri elementi secondari

AMS Virtual Host include

Quando uno qualsiasi dei file .vhost della directory /etc/httpd/conf.d/availabled_vhosts/ viene collegato alla directory /etc/httpd/conf.d/enabled_vhosts/, verrà utilizzato nella configurazione in esecuzione.

Nei file .vhost sono presenti sottoinclusioni basate sui pezzi comuni trovati.  Cose come variabili, whitelist e regole di riscrittura.

Il file .vhost includerà istruzioni di inclusione per ciascun file in base alla posizione in cui devono essere incluse nel file .vhost.  Di seguito è riportata una sintassi di esempio di un file .vhost come riferimento valido:

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>

Come puoi vedere nell’esempio precedente, esiste un’inclusione per le variabili necessarie in questo file di configurazione che vengono successivamente utilizzate.

All'interno del file /etc/httpd/conf.d/variables/weretail.vars è possibile vedere quali variabili sono definite:

Define MAIN_DOMAIN dev.weretail.com

È inoltre possibile visualizzare una riga che include un elenco di _whitelist.rules file che limitano gli utenti autorizzati a visualizzare il contenuto in base a criteri di whitelist diversi.  Esaminiamo il contenuto di uno dei file della whitelist /etc/httpd/conf.d/whitelists/weretail_mainoffice_whitelist.rules:

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

È inoltre possibile visualizzare una riga che include un set di regole di riscrittura.  Diamo un'occhiata al contenuto del file 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 farm AMS include

Quando un file FILENAME_farm.any della directory /etc/httpd/conf.dispatcher.d/available_farms/ viene collegato alla directory /etc/httpd/conf.dispatcher.d/enabled_farms/, verrà utilizzato nella configurazione in esecuzione.

I file della farm contengono sottoinclusioni basate su sezioni di primo livello della farm come cache, clientheaders, filtri, rendering e vhosts.

I file FILENAME_farm.any avranno istruzioni di inclusione per ciascun file in base alla posizione in cui devono essere inclusi nel file farm.  Di seguito è riportata una sintassi di esempio di un file FILENAME_farm.any come riferimento valido:

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

Poiché è possibile vedere ogni sezione per la farm weretail invece di avere tutta la sintassi necessaria, si utilizza invece un’istruzione "include".

Vediamo la sintassi di alcuni di questi include per capire come apparirebbe ogni sotto include

/etc/httpd/conf.dispatcher.d/vhosts/weretail_publish_vhosts.any:

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

Come puoi vedere, si tratta di un nuovo elenco di nomi di dominio separati da righe che deve essere riprodotto da questa farm rispetto agli altri.

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

Avanti -> Informazioni sulla cache