Local AEM dispatcher setup

[pun-ky]

AEM on Vagrant / VirtualBox works, but its performance is not enough good as native.

Taks aemSetup is now able to rollout easily native AEM instances. The missing parts of typical production ready AEM stack are:

• Apache with Dispatcher module
• MongoDB
• Apache Solr
• Knot.X (optionally)

Imagine:

sh gradlew aemSetup

• will create native AEM instances as usual
• will run Vagrant Box with AEM stack described above
• AEM stack will use project local folder mounted e.g /stack which will holds configurations for Dispatcher, Rewrite, Solr, Mongo, Knot.x

We will achieve full AEM stack configured in one place (one project VCS repository) with native AEM performance.

[pun-ky]

maybe it is only needed to use https://github.com/bmuschko/gradle-vagrant-plugin and create valid box.

[pun-ky]

consider following this approach and setup 2 sites for example project: https://helpx.adobe.com/experience-manager/dispatcher/using/dispatcher-domains.html

[pun-ky]

https://www.vagrantup.com/docs/boxes/base.html

[mierzwid]

It is possible to run Vagrant on Docker, so we could possibly have one plugin that uses Vagrant and runs both Docker containers and Vagrant images.

[mierzwid]

Added the first proposal of the solution:

• starting docker compose with a dispatcher and solr
• there are few remarks to consider:
  • Docker library doesn't understand compose file v3 memory: "200M"
  • (working on it) We need some mechanism to extract host IP, so dispatcher can connect to AEM on local - however it is possible
  • It would be nice to wait for docker services to start
  • It would be nice to check if docker is installed

https://github.com/mierzwid/gradle-aem-plugin/pull/2

[mierzwid]

Problem is routing from dispatcher to local instance. It is not possible to access hosts localhost from Docker network. Also, it would be good to configure only logical names in dispatchers, solrs, etc. configurations instead of hardcoding IPs or specific hosts.

I am working on it.

[mierzwid]

I find out that this is not a problem, at least for Docker on Mac and Windows. I used host.docker.internal name as the host address. Dispatcher connects to publish without any problems. I won't introduce and proxies then to keep the setup simple.

[mierzwid]

PR with a proposal of local environment setup for project multi (basic dispatcher and unconfigured solr instances): https://github.com/Cognifide/gradle-aem-multi/pull/45

[mierzwid]

Implementing improvements after review:

• Extracted new environment plugin - DONE
• Updated DSL for this plugin to avoid using "docker" name since it could work with vagrant as well - DONE
• simple setup of dispatcher with URL shortening on AEM (https://github.com/Cognifide/gradle-aem-multi/pull/45) - in progress
• automating configuration of /etc/hosts and dispatcher flush - planned

[mierzwid]

Status

DONE

• Extracted new environment plugin - DONE
• Updated DSL for this plugin to avoid using "docker" name since it could work with vagrant as well - DONE
• simple setup of dispatcher with URL shortening on AEM (Cognifide/gradle-aem-multi#45) - DONE
• automating configuration of /etc/hosts and dispatcher flush - DONE

CODE

• GAP PR: https://github.com/Cognifide/gradle-aem-plugin/pull/336
• MULTI PR: https://github.com/Cognifide/gradle-aem-multi/pull/45

TODO

• 7.0.0 Move files
  • local-instance -> aem/gradle/instance
  • local-environment -> aem/gradle/environment
• 7.0.0 Move example of dispatcher configuration to GAP
  • GAP is autogenerating default environment when running aemEnvUp and aem/gradle/instance dir does not exist
• 7.0.0 Publish dispatcher image on Cognifide DockerHub

RELATED

337, #338

[mierzwid]

Status

DONE

• Extracted new environment plugin - DONE
• Updated DSL for this plugin to avoid using "docker" name since it could work with vagrant as well - DONE
• simple setup of dispatcher with URL shortening on AEM (Cognifide/gradle-aem-multi#45) - DONE
• automating configuration of /etc/hosts and dispatcher flush - DONE
• Move example of dispatcher configuration to GAP - DONE
  • GAP is autogenerating default environment when running aemEnvUp and aem/gradle/instance dir

CODE

• GAP PR: https://github.com/Cognifide/gradle-aem-plugin/pull/336
• MULTI PR: https://github.com/Cognifide/gradle-aem-multi/pull/45

TODO

• 7.0.0 Move files
  • local-instance -> aem/gradle/instance
• 7.0.0 Publish dispatcher image on Cognifide DockerHub - BLOCKED

RELATED

337, #338

[mierzwid]

This is the final PR for this task: https://github.com/Cognifide/gradle-aem-plugin/pull/361

[pun-ky]

done, to be released within 7.0.0