Lokale gereedschappen voor Dispatcher instellen set-up-local-dispatcher-tools

De Verzender van Adobe Experience Manager (AEM) is een Apache HTTP- de servermodule die een veiligheid en prestatieslaag tussen CDN en AEM publicatielaag verstrekt. Dispatcher is een integraal onderdeel van de algehele architectuur van de Experience Manager en moet onderdeel zijn van de lokale ontwikkelinstellingen.

De AEM as a Cloud Service SDK bevat de aanbevolen versie van Dispatcher Tools waarmee u het valideren kunt configureren en de Dispatcher lokaal kunt simuleren. Dispatcher Tools bestaat uit:

Let op: ~ wordt gebruikt als steno voor de Folder van de Gebruiker. In Windows is dit het equivalent van %HOMEPATH%.

Vereisten

Download de Dispatcher Tools (als onderdeel van de AEM SDK)

De AEM as a Cloud Service SDK, of AEM SDK, bevat de Dispatcher Tools die worden gebruikt om de Apache HTTP Web-server met de module Dispatcher lokaal voor ontwikkeling uit te voeren, en compatibele QuickStart Jar.

Als de AEM as a Cloud Service SDK al is gedownload naar de lokale AEM-runtime instellenhoeft u de toepassing niet opnieuw te downloaden.

De Dispatcher Tools extraheren uit de AEM SDK zip

De versie van Dispatcher Tools verschilt van die van de AEM SDK. Zorg ervoor dat de versie van Dispatcher Tools beschikbaar is via de AEM SDK-versie die overeenkomt met de as a Cloud Service versie van AEM.

$ 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

Alle hieronder uitgegeven bevelen veronderstellen dat de huidige het werk folder de het uitvouwen inhoud van de Hulpmiddelen van de Verzender bevat.

Deze video gebruikt macOS ter illustratie. Met de equivalente Windows/Linux-opdrachten kunt u vergelijkbare resultaten bereiken.

De Dispatcher-configuratiebestanden begrijpen

De Dispatcher Tools biedt een set Apache HTTP Web-server- en Dispatcher-configuratiebestanden die gedrag voor alle omgevingen, inclusief lokale ontwikkeling, definiëren.

Deze bestanden zijn bedoeld om naar een Experience Manager Maven-project te worden gekopieerd dispatcher/src als deze niet bestaan in het Experience Manager Maven-project.

Een volledige beschrijving van de configuratiebestanden is beschikbaar in de onverpakte Dispatcher Tools als dispatcher-sdk-x.x.x/docs/Config.html.

Configuraties valideren

Optioneel, de Dispatcher en Apache de serverconfiguraties van het Web (via httpd -t) kan worden gevalideerd met de validate script (niet te verwarren met het validator uitvoerbaar). De validate is een handige manier om het script uit te voeren drie fasen van de validator.

$ ./bin/validate.sh ./src

$ bin\validate src

$ ./bin/validate.sh ./src

Verzending lokaal uitvoeren

AEM Dispatcher lokaal wordt uitgevoerd met Docker op de src Configuratiebestanden van de server Dispatcher en Apache Web.

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

De <aem-publish-host> kan worden ingesteld op host.docker.internal, verstrekt een speciale DNS naamDocker in de container die aan IP van de gastheermachine oplost. Als de host.docker.internal niet wordt opgelost, zie de problemen oplossen hieronder.

U kunt bijvoorbeeld de Dispatcher Docker-container starten met de standaardconfiguratiebestanden van de Dispatcher Tools:

Start Dispatcher Docker-container die het pad naar de Dispatcher-configuratiemap bevat:

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

De AEM as a Cloud Service publicatieservice van SDK, die plaatselijk op haven 4503 loopt is beschikbaar door Dispatcher bij http://localhost:8080.

Om de Hulpmiddelen van de Verzender tegen de configuratie van de Verzender van een project van de Experience Manager in werking te stellen, richt aan uw project dispatcher/src map.

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

Logboeken voor Dispatcher Tools

Logboeken van de verzender zijn nuttig tijdens lokale ontwikkeling om te begrijpen als en waarom de Verzoeken van HTTP worden geblokkeerd. U kunt het logniveau instellen door vooraf de uitvoering van docker_run met omgevingsparameters.

Logboeken van Dispatcher Tools worden uitgestraald naar de standaard wanneer docker_run wordt uitgevoerd.

Nuttige parameters voor het zuiveren Dispatcher omvatten:

Een of meer parameters, die kunnen worden doorgegeven aan 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

Toegang tot logbestanden

Logbestanden van Apache-webservers en AEM Dispatcher kunnen rechtstreeks worden geopend in de Docker-container:

Wanneer werkt u de Dispatcher Tools bij dispatcher-tools-version

Versies van Dispatcher Tools nemen minder vaak toe dan de Experience Manager en dus vereisen Dispatcher Tools minder updates in de lokale ontwikkelomgeving.

De aanbevolen versie van Dispatcher Tools is die welke is meegeleverd bij de AEM as a Cloud Service SDK die overeenkomt met de as a Cloud Service versie van de Experience Manager. De versie van AEM as a Cloud Service is te vinden via Cloud Manager.

De versie Dispatcher Tools komt niet overeen met de versie van Experience Manager.

De basislijnset van Apache- en Dispatcher-configuraties bijwerken

De basislijnset van Apache- en Dispatcher-configuratie wordt regelmatig verbeterd en vrijgegeven met de AEM as a Cloud Service SDK-versie. Het is beste praktijken om de verhogingen van de basislijnconfiguratie in uw AEM project op te nemen en te vermijden lokale validatie en fouten met de pijpleiding in Cloud Manager. Werk ze bij met de functie update_maven.sh script van het .../dispatcher-sdk-x.x.x/bin map.

Deze video gebruikt macOS ter illustratie. Met de equivalente Windows/Linux-opdrachten kunt u vergelijkbare resultaten bereiken.

Laten we aannemen dat u in het verleden een AEM project hebt gemaakt met Projectarchetype AEMDe basislijnconfiguraties Apache en Dispatcher waren actueel. Gebruikend deze basislijnconfiguraties werden uw project-specifieke configuraties gecreeerd door, de dossiers als opnieuw te gebruiken en te kopiëren *.vhost, *.conf, *.farm en *.any van de dispatcher/src/conf.d en dispatcher/src/conf.dispatcher.d mappen. Uw lokale Dispatcher-validatie en Cloud Manager-pijplijnen waren prima.

Ondertussen werden de basislijnconfiguraties Apache en Dispatcher verbeterd om verschillende redenen, zoals nieuwe functies, beveiligingsoplossingen en optimalisatie. Ze worden vrijgegeven via een nieuwere versie van Dispatcher Tools als onderdeel van de AEM as a Cloud Service release.

Nu, wanneer het bevestigen van uw project-specifieke configuraties van de Verzender tegen de recentste versie van de Hulpmiddelen van de Verzender beginnen zij te ontbreken. Om dit te verhelpen, moeten de basislijnconfiguraties door onder stappen worden bijgewerkt te gebruiken:

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

Problemen oplossen

docker_run resulteert in het bericht 'Wachten tot host.docker.internal beschikbaar is' troubleshooting-host-docker-internal

De host.docker.internal is hostname die aan Docker wordt verstrekt die aan de gastheer oplost. Per docs.docker.com (macOS, Windows):

Vanaf Docker 18.03 moet de aanbeveling met de speciale DNS naam host.docker.internal verbinden, die aan het interne IP adres oplost dat door de gastheer wordt gebruikt

Wanneer bin/docker_run src host.docker.internal:4503 8080 resulteert in het bericht Wachten tot host.docker.internal beschikbaar is, dan:

Voorbeeldfout

$ 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

Aanvullende bronnen