Konfigurera lokala Dispatcher-verktyg set-up-local-dispatcher-tools

Adobe Experience Manager (AEM) Dispatcher är en Apache HTTP-webbservermodul som tillhandahåller ett säkerhets- och prestandalager mellan CDN-nivån och AEM Publish-nivån. Dispatcher är en integrerad del av den övergripande Experience Manager-arkitekturen och bör ingå i den lokala utvecklingsmiljön.

AEM as a Cloud Service SDK innehåller den rekommenderade Dispatcher Tools-versionen som underlättar konfigurering av validering och simulering av Dispatcher lokalt. Dispatcher Tools består av:

Observera att ~ används som kortskrift för användarens katalog. I Windows motsvarar detta %HOMEPATH%.

Förutsättningar

Ladda ned Dispatcher Tools (som en del av AEM SDK)

AEM as a Cloud Service SDK, eller AEM SDK, innehåller de Dispatcher-verktyg som används för att köra Apache HTTP Web-servern med Dispatcher-modulen lokalt för utveckling, samt den kompatibla QuickStart Jar.

Om AEM as a Cloud Service SDK redan har laddats ned för att installera den lokala AEMbehöver den inte laddas ned igen.

Extrahera Dispatcher Tools från AEM SDK

Versionen av Dispatcher Tools skiljer sig från AEM SDK. Kontrollera att den version av Dispatcher Tools som finns i den AEM SDK-version som matchar AEM as a Cloud Service-versionen finns tillgänglig.

$ chmod a+x aem-sdk-dispatcher-tools-x.x.x-unix.sh
$ ./aem-sdk-dispatcher-tools-x.x.x-unix.sh

$ chmod a+x aem-sdk-dispatcher-tools-x.x.x-unix.sh
$ ./aem-sdk-dispatcher-tools-x.x.x-unix.sh

Alla kommandon som anges nedan förutsätter att den aktuella arbetskatalogen innehåller det expanderande Dispatcher Tools-innehållet.

I den här videon används macOS för illustrativa ändamål. Motsvarande Windows/Linux-kommandon kan användas för att uppnå liknande resultat.

Förstå Dispatcher konfigurationsfiler

Dispatcher Tools innehåller en uppsättning konfigurationsfiler för Apache HTTP Web Server och Dispatcher som definierar beteendet för alla miljöer, inklusive lokal utveckling.

Dessa filer är avsedda att kopieras till ett Experience Manager Maven-projekt till mappen dispatcher/src, om de inte finns i Experience Manager Maven-projektet.

En fullständig beskrivning av konfigurationsfilerna finns i de opackade Dispatcher-verktygen som dispatcher-sdk-x.x.x/docs/Config.html.

Validera konfigurationer

Dispatcher- och Apache-webbserverkonfigurationerna (via httpd -t) kan valideras med skriptet validate (ska inte blandas ihop med den körbara filen validator). Skriptet validate är ett praktiskt sätt att köra tre faseri validator.

$ ./bin/validate.sh ./src

$ bin\validate src

$ ./bin/validate.sh ./src

Kör Dispatcher lokalt

AEM Dispatcher körs lokalt med Docker mot konfigurationsfilerna för src Dispatcher- och Apache-webbservrar.

$ ./bin/docker_run_hot_reload.sh <src-folder> <aem-publish-host>:<aem-publish-port> <dispatcher-port>

$ bin\docker_run <src-folder> <aem-publish-host>:<aem-publish-port> <dispatcher-port>

$ ./bin/docker_run_hot_reload.sh <src-folder> <aem-publish-host>:<aem-publish-port> <dispatcher-port>

<aem-publish-host> kan anges till host.docker.internal. En speciell DNS-namnDocker tillhandahåller i behållaren som matchar värddatorns IP-adress. Om host.docker.internal inte kan lösas kan du läsa avsnittet felsökning nedan.

Du kan till exempel starta Dispatcher Docker-behållaren med standardkonfigurationsfilerna som finns i Dispatcher-verktygen:

Starta Dispatcher Docker-behållaren och ange sökvägen till Dispatcher konfigurationsmapp:

$ ./bin/docker_run_hot_reload.sh ./src host.docker.internal:4503 8080

$ bin\docker_run src host.docker.internal:4503 8080

$ ./bin/docker_run_hot_reload.sh ./src host.docker.internal:4503 8080

AEM as a Cloud Service SDK:s Publish-tjänst som körs lokalt på port 4503 är tillgänglig via Dispatcher på http://localhost:8080.

Om du vill köra Dispatcher-verktyg mot ett Experience Manager-projekts Dispatcher-konfiguration pekar du på ditt projekts dispatcher/src-mapp.

$ ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

$ bin\docker_run <User Directory>/code/my-project/dispatcher/src host.docker.internal:4503 8080

$ ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

Dispatcher Tools-loggar

Dispatcher loggar är användbara vid lokal utveckling för att förstå om och varför HTTP-begäranden blockeras. Loggnivån kan anges genom att köra docker_run med miljöparametrar som prefix.

Loggar för Dispatcher-verktyg skickas till standard-out när docker_run körs.

Användbara parametrar för felsökning av Dispatcher är:

En eller flera parametrar kan skickas till docker_run

$ DISP_LOG_LEVEL=Debug REWRITE_LOG_LEVEL=Debug ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

$ DISP_LOG_LEVEL=Debug REWRITE_LOG_LEVEL=Debug bin\docker_run <User Directory>/code/my-project/dispatcher/src host.docker.internal:4503 8080

$ DISP_LOG_LEVEL=Debug REWRITE_LOG_LEVEL=Debug ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

Loggfilsåtkomst

Du kan komma åt Apache-webbservern och AEM Dispatcher-loggar direkt i Docker-behållaren:

När Dispatcher Tools ska uppdateras dispatcher-tools-version

Dispatcher Tools-versionerna ökar inte lika ofta som Experience Manager och därför kräver Dispatcher Tools färre uppdateringar i den lokala utvecklingsmiljön.

Den rekommenderade Dispatcher Tools-versionen är den som medföljer AEM as a Cloud Service SDK som överensstämmer med Experience Manager as a Cloud Service-versionen. Versionen av AEM as a Cloud Service finns via Cloud Manager.

Observera att Dispatcher Tools-versionen inte överensstämmer med Experience Manager.

Så här uppdaterar du baslinjeuppsättningen med Apache- och Dispatcher-konfigurationer

Baslinjeuppsättningen med Apache- och Dispatcher-konfigurationer förbättras regelbundet och släpps med AEM as a Cloud Service SDK-versionen. Det är en god vana att inkludera förbättringarna av baslinjekonfigurationen i ditt AEM och undvika lokal validering och fel i Cloud Manager pipeline. Uppdatera dem med skriptet update_maven.sh från mappen .../dispatcher-sdk-x.x.x/bin.

I den här videon används macOS för illustrativa ändamål. Motsvarande Windows/Linux-kommandon kan användas för att uppnå liknande resultat.

Vi antar att du tidigare har skapat ett AEM projekt med AEM Project Archetype. Baslinjen för Apache och Dispatcher var aktuella. Med hjälp av dessa baslinjekonfigurationer skapades dina projektspecifika konfigurationer genom att återanvända och kopiera filer som *.vhost, *.conf, *.farm och *.any från mapparna dispatcher/src/conf.d och dispatcher/src/conf.dispatcher.d. Din lokala Dispatcher-validering och Cloud Manager-rörledningar fungerade bra.

Samtidigt har Apache- och Dispatcher-konfigurationerna förbättrats av olika skäl, till exempel nya funktioner, säkerhetskorrigeringar och optimering. De släpps via en nyare version av Dispatcher Tools som en del av AEM as a Cloud Service.

När du validerar dina projektspecifika Dispatcher-konfigurationer mot den senaste Dispatcher Tools-versionen börjar de nu misslyckas. För att lösa detta måste baslinjekonfigurationerna uppdateras genom att följa stegen nedan:

$ ./bin/validate.sh ${YOUR-AEM-PROJECT}/dispatcher/src

...
checking 'conf.dispatcher.d/renders/default_renders.any' immutability (if present)
checking existing 'conf.dispatcher.d/renders/default_renders.any' for changes
checking 'conf.dispatcher.d/virtualhosts/default_virtualhosts.any' immutability (if present)
checking existing 'conf.dispatcher.d/virtualhosts/default_virtualhosts.any' for changes
no immutable file has been changed - check is SUCCESSFUL
Phase 3 finished

Felsökning

docker_run resulterar i meddelandet"Väntar tills host.docker.internal är tillgänglig" troubleshooting-host-docker-internal

host.docker.internal är ett värdnamn som anges för Docker-behållaren som löses till värden. Per docs.docker.com (macOS, Windows):

Från och med Docker 18.03 rekommenderar vi att du ansluter till det särskilda DNS-namnet host.docker.internal, som matchar den interna IP-adressen som används av värden

När bin/docker_run src host.docker.internal:4503 8080 resulterar i meddelandet Väntar tills host.docker.internal är tillgänglig:

Exempel på fel

$ docker_run src host.docker.internal:4503 8080

Running script /docker_entrypoint.d/10-check-environment.sh
Running script /docker_entrypoint.d/20-create-docroots.sh
Running script /docker_entrypoint.d/30-wait-for-backend.sh
Waiting until host.docker.internal is available

Ytterligare resurser