Förklaring av konfigurationsfiler | AEM

Beskrivning description

Miljö

Experience Manager

Problem/symtom

I det här dokumentet bryts ned och förklaras var och en av konfigurationsfilerna som distribuerats i en standardserver från Dispatcher som skapats i Adobe Managed Services. Deras användning, namnkonventioner osv.

Namnkonvention

Apache Webserver bryr sig egentligen inte om vad filtillägget är för en fil när den används med en include- eller include-sats. Att namnge dem på rätt sätt med namn som eliminerar konflikter och förvirring hjälper till. Namn som används beskriver omfattningen av filens tillämpning och gör livet enklare. Om allt heter .conf blir det förvirrande. Undvik dåligt namngivna filer och tillägg.

Nedan finns en lista över de olika anpassade filtillägg och namnkonventioner som används i en typisk AMS-konfigurerad Dispatcher.

Filer i conf.d/

Filer i conf.modules.d/

Undandragna problem

När du följer namnkonventionen bör du undvika att göra misstag som kan få katastrofala resultat. Låt oss ta några exempel.

Exempel på problem

Som ett exempel på en plats för ExampleCo skapas två konfigurationsfiler av utvecklarna av Dispatcher-konfigurationerna.

/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]

POTENTIELL FARA

A. Filnamnen är desamma.

Om värdfilen av misstag placeras i mappen för omskrivningar och filen för omskrivningar placeras i mappen vhosts. Det verkar ha distribuerats korrekt av filnamnet, men i Apache uppstår ett fel och problemet är inte omedelbart uppenbart.

Hur blir detta vanligtvis ett problem?

Om de två filerna laddas ned till samma plats kan de antingen skriva över sig själva eller göra det omöjligt att särskilja, vilket gör distributionsprocessen till en mardröm.

B. Filtilläggen är desamma och tar automatiskt med benen

Filtilläggen är desamma och använder automatiskt inkluderat tillägg som Apache automatiskt inkluderar alla .conf-filer i många av sina standardmappar.

Hur blir detta vanligtvis ett problem?

Om värdfilen med tillägget .conf placeras i mappen /etc/httpd/conf.d/ försöker den läsa in den i minnet på Apache, vilket vanligtvis är ok, men om filen med tillägget .conf placeras i mappen /etc/httpd/conf.d/, inkluderas den automatiskt och används globalt, vilket ger förvirrande och oönskade resultat.

Upplösning resolution

Namnge filerna baserat på vad de gör och säkert ut ur namnutrymmet för automatiska inkluderingsregler.

Om du använder dessa namnkonventioner undviker du problem om en fil flyttas till en katalog för automatisk infogning som den inte tillhör.

Om du till exempel placerar en fil med namnet .rules, .any eller .vhost i mappen för automatisk infogning i /etc/httpd/conf.d/ får det ingen effekt.

Om en distributionsändringsbegäran säger please deploy exampleco_rewrite.rules to production dispatchers kan personen som distribuerar ändringarna redan veta att de inte lägger till en ny plats. De uppdaterar bara omskrivningsregler enligt filnamnet.

Inkludera beställning

När du utökar funktioner och konfigurationer i Apache Webserver som är installerad på Enterprise Linux har du några viktiga inkluderingsorder som du vill veta.

A. Baslinjen för Apache innehåller

Apache-binärfilen börjar med httpd.conf som gör en includeoptional till katalogerna conf.d/*.conf och conf.modules.d/*.conf.

Som du ser i diagrammet ovan söker binärfilen för httpd bara efter filen httpd.conf som konfigurationsfilen. Filen innehåller följande programsatser:

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

B. AMS-toppnivån innehåller

När vi tillämpade vår standard lade vi till ytterligare filtyper och inkluderar våra egna.

Här är AMS-originalkataloger och toppnivån innehåller

Bygger på Apache baslinje visar vi hur AMS skapade ytterligare mappar och inkluderingar på översta nivån för conf.d-mappar samt modulspecifika kataloger som är kapslade under /etc/httpd/conf.dispatcher.d/

När Apache läser in den hämtas den i /etc/httpd/conf.modules.d/02-dispatcher.conf och den filen innehåller den binära filen /etc/httpd/modules/mod_dispatcher.so i körningsläge.

LoadModule dispatcher_module modules/mod_dispatcher.so

Om du vill använda modulen i </VirtualHost> släpper vi en konfigurationsfil i /etc/httpd/conf.d/ med namnet dispatcher_vhost.conf och i den här filen använder du de grundläggande parametrar som behövs för att modulen ska fungera:

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

Som du kan se ovan omfattar detta den översta nivån dispatcher.alla filer som Dispatcher-modulen kan hämta konfigurationsfiler från /etc/httpd/conf.dispatcher.d/dispatcher.any

Tänk på innehållet i den här filen:

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

Dispatcher på den översta nivån.alla filer innehåller alla aktiverade servergruppsfiler som finns i /etc/httpd/conf.dispatcher.d/enabled_farms/ med filnamnet <FILENAME>_farm.any som följer vår standardnamnkonvention.

Senare i filen dispatcher_vhost.conf som nämndes tidigare gör vi också en include-sats för att aktivera varje aktiverad virtuell värdfil som finns i /etc/httpd/conf.d/enabled_vhosts/ med filnamnet <FILENAME>.vhost som följer vår standardnamnkonvention.

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

I var och en av våra .vhost-filer kommer du att märka att dispatchermodulen initieras som en standardfilhanterare för en katalog. Här är ett exempel på en .vhost-fil som visar syntaxen:

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

När den översta nivån innehåller en lösning har de andra underinkluderingar som är värda att nämnas. Här följer ett diagram på hög nivå över hur servergrupperna och värdfilerna innehåller andra underelement

C. AMS Virtual Host innehåller

När en .vhost-fil från /etc/httpd/conf.d/availabled_vhosts/-katalogen får en länk till /etc/httpd/conf.d/enabled_vhosts/-katalogen används de i den konfiguration som körs.

.vhost-filerna har underinkluderingar som baseras på de vanligaste bitarna som vi har hittat. Saker som variabler, vitlistor och skrivregler.

.vhost-filen kommer att innehålla programsatser för varje fil baserat på var de måste inkluderas i .vhost-filen. Här följer ett exempel på syntax för en Vhost-fil som en bra referens:

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

Som du ser i exemplet ovan finns det en inkluderingsfunktion för de variabler som behövs i konfigurationsfilen och som används senare.

I filen /etc/httpd/conf.d/variables/weretail.vars kan vi se vilka variabler som är definierade:

Define MAIN_DOMAIN dev.weretail.com

Du kan också se en rad som innehåller en lista med whitelist.rules-filer som begränsar vilka som kan visa innehållet baserat på olika vitlistvillkor. Här kan du se innehållet i en av de vita listfilerna /etc/httpd/conf.d/whitelists/weretail_mainoffice_whitelist.rules:

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

Du kan även se en rad som innehåller en uppsättning regler för omskrivning. Låt oss titta på innehållet i filen 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. AMS-servergruppen innehåller

När en <FILENAME>_farm.any-fil från /etc/httpd/conf.dispatcher.d/available_farms/-katalogen länkas till /etc/httpd/conf.dispatcher.d/enabled_farms/-katalogen används de i den konfiguration som körs.

Servergruppsfilerna innehåller undergrupper baserade på toppnivåavsnitt i servergruppen som cache, klienthuvuden, filter, återgivningar och värdar.

Filerna <FILENAME>_farm.any kommer att innehålla programsatser för varje fil baserat på var de måste inkluderas i servergruppsfilen. Här är ett exempel på syntax för en <FILENAME>_farm.any-fil som en bra referens:

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

Som du kan se varje avsnitt för den lokala servergruppen i stället för att ha all syntax som behövs använder du programsatsen include.

Låt oss titta på syntaxen för några av dessa funktioner för att få en uppfattning om hur varje undergrupp skulle se ut /etc/httpd/conf.dispatcher.d/vhosts/weretail_publish_vhosts.any:

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

Som du ser är det en ny radavgränsad lista med domännamn som ska återges från den här servergruppen över de andra.

Titta sedan på /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" }