Merge branch 'develop'

wcm-io-devops · Feb 19, 2025 · 14ef4be · 14ef4be
2 parents 1b93b95 + 95035b0
commit 14ef4be
Show file tree

Hide file tree

Showing 13 changed files with 129 additions and 77 deletions.
diff --git a/.github/workflows/release-from-tag.yml b/.github/workflows/release-from-tag.yml
@@ -15,5 +15,5 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ncipollo/release-action@v1
       with:
-        body: 'Changes: https://devops.wcm.io/conga/definitions/aem/changes-report.html'
+        body: 'Changes: https://devops.wcm.io/conga/definitions/aem/changes.html'
         token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/changes.xml b/changes.xml
@@ -19,10 +19,17 @@
   #L%
   -->
 
-<document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/changes/1.0.0"
-    xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd">
+<document xmlns="http://maven.apache.org/changes/2.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/changes/2.0.0 https://maven.apache.org/xsd/changes-2.0.0.xsd">
   <body>
 
+    <release version="2.0.8" date="2025-02-19">
+      <action type="update" dev="sseifert" issue="94">
+        Role aem-dispatcher-cloud: Sync with default dispatcher configuration from Adobe AEM project archetype 48 to 51.
+      </action>
+    </release>
+
     <release version="2.0.6" date="2024-12-10">
       <action type="update" dev="twolfart" issue="93">
         Dynamically generate X-Vhost value.

diff --git a/conga-aem-definitions/pom.xml b/conga-aem-definitions/pom.xml
@@ -25,13 +25,13 @@
   <parent>
     <groupId>io.wcm.devops.conga.definitions</groupId>
     <artifactId>io.wcm.devops.conga.definitions.aem.parent</artifactId>
-    <version>2.0.6</version>
+    <version>2.0.8</version>
     <relativePath>../parent/pom.xml</relativePath>
   </parent>
 
   <groupId>io.wcm.devops.conga.definitions</groupId>
   <artifactId>io.wcm.devops.conga.definitions.aem</artifactId>
-  <version>2.0.6</version>
+  <version>2.0.8</version>
   <packaging>config-definition</packaging>
 
   <name>CONGA AEM Definitions</name>

diff --git a/...finitions/src/main/resources/aem-sdk-dispatcher/src/conf.d/available_vhosts/default.vhost b/...finitions/src/main/resources/aem-sdk-dispatcher/src/conf.d/available_vhosts/default.vhost
@@ -28,7 +28,7 @@ Include conf.d/variables/custom.vars
 			# Some items cache with the wrong mime type
 			# Use this option to use the name to auto-detect mime types when cached improperly
 			ModMimeUsePathInfo On
-			# Use this option to avoid cache poisioning
+			# Use this option to avoid cache poisoning
 			# Sling will return /content/image.jpg as well as /content/image.jpg/ but apache can't search /content/image.jpg/ as a file
 			# Apache will treat that like a directory.  This assures the last slash is never stored in cache
 			DirectorySlash Off

diff --git a/conga-aem-definitions/src/main/resources/aem-sdk-dispatcher/src/conf.d/dispatcher_vhost.conf b/conga-aem-definitions/src/main/resources/aem-sdk-dispatcher/src/conf.d/dispatcher_vhost.conf
@@ -15,8 +15,6 @@ Include conf.d/variables/global.vars
 
 # Liveness probe URL
 Alias "/system/probes/live" probes/live-status.json
-# Readiness probe URL
-Alias "/system/probes/ready" probes/ready-status.json
 # Startup probe URL
 Alias "/system/probes/start" probes/startup-status.json
 
@@ -111,16 +109,53 @@ Alias "/system/probes/start" probes/startup-status.json
 	</LocationMatch>
 </IfDefine>
 
-# Legacy /systemready mapped to new Health probe URL /system/probes/health in AEM
-<Location "/systemready">
-	ProxyPass http://${AEM_HOST}:${AEM_PORT}/system/probes/health
-	RewriteEngine Off
-</Location>
-
-# Allow ingressroute checks through on /system/probes/health (regardless of dispatcher filters)
-<Location "/system/probes/health">
-	ProxyPass http://${AEM_HOST}:${AEM_PORT}/system/probes/health
-	RewriteEngine Off
+# managed redirect maps not configured (= backward-compatible)
+<IfFile !opt-in/managed-rewrite-maps.yaml>
+	# Legacy /systemready mapped to new Health probe URL /system/probes/health in AEM
+	<Location "/systemready">
+		ProxyPass http://${AEM_HOST}:${AEM_PORT}/system/probes/health
+		RewriteEngine Off
+	</Location>
+
+	# Allow ingressroute checks through on /system/probes/health (regardless of dispatcher filters)
+	<Location "/system/probes/health">
+		ProxyPass http://${AEM_HOST}:${AEM_PORT}/system/probes/health
+		RewriteEngine Off
+	</Location>
+</IfFile>
+# managed redirect maps configured
+<IfFile opt-in/managed-rewrite-maps.yaml>
+	# check if traffic can be already allowed to pass (404/redirects not existing yet prevention)
+	<IfFile /tmp/rewrites/ready>
+		# Legacy /systemready mapped to new Health probe URL /system/probes/health in AEM
+		<Location "/systemready">
+			ProxyPass http://${AEM_HOST}:${AEM_PORT}/system/probes/health
+			RewriteEngine Off
+		</Location>
+
+		# Allow ingressroute checks through on /system/probes/health (regardless of dispatcher filters)
+		<Location "/system/probes/health">
+			ProxyPass http://${AEM_HOST}:${AEM_PORT}/system/probes/health
+			RewriteEngine Off
+		</Location>
+	</IfFile>
+	# else forcing "403 Forbidden" for Health probes
+	# "Any code greater than or equal to 200 and less than 400 indicates success. Any other code indicates failure."
+	# as per https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
+	<IfFile !/tmp/rewrites/ready>
+	    <Location "/systemready">
+	        Require all denied
+	    </Location>
+	    <Location "/system/probes/health">
+	        Require all denied
+	    </Location>
+	</IfFile>
+</IfFile>
+
+# Readiness probe for K8S Endpoints also depends on AEM readiness probe
+<Location "/system/probes/ready">
+    ProxyPass http://${AEM_HOST}:${AEM_PORT}/system/probes/ready
+    RewriteEngine Off
 </Location>
 
 # Allow access to CRXDE on dev environment
@@ -228,48 +263,48 @@ Alias "/gitinit-status" metadata/gitinit-status.json
     Require expr "%{HTTP_HOST} == '${POD_NAME}'"
 </Directory>
 
-# Dedicated vhost for EaaS:
+# Dedicated vhost for Adobe proxy testing:
 # (currently disabled, but customers can expect it to be enabled in future versions - CQ-4349728)
-#<VirtualHost *:80>
-#	ServerName	"test.eaas"
-#	# possibility to make overrides before directives in this vhost
-#	IncludeOptional conf.d/includes/first-listed-vhost.pre.includes
-#	# since this vhost is first-listed one, this setting influences other vhosts - see https://httpd.apache.org/docs/2.4/mod/core.html#limitrequestfieldsize
-#	LimitRequestFieldSize 32768
-#	DocumentRoot /var/www/localhost/htdocs
-#	AllowEncodedSlashes NoDecode
-#	<IfModule mod_headers.c>
-#		Header add X-Vhost "test.eaas"
-#	</IfModule>
-#	<Directory "/var/www/localhost/htdocs">
-#		Options Indexes FollowSymLinks
-#		AllowOverride None
-#		Require all granted
-#	</Directory>
-#
-#	# SKYOPS-49434: Allow EaaS to access publish instance directly for dev and stage environments when test.eaas vhost is requested
-#	<IfDefine ENVIRONMENT_DEV>
-#		<LocationMatch "/">
-#			ProxyPassMatch http://${AEM_HOST}:${AEM_PORT}
-#			RewriteEngine Off
-#		</LocationMatch>
-#	</IfDefine>
-#	<IfDefine ENVIRONMENT_STAGE>
-#		<LocationMatch "/">
-#			ProxyPassMatch http://${AEM_HOST}:${AEM_PORT}
-#			RewriteEngine Off
-#		</LocationMatch>
-#	</IfDefine>
-#	# 403 Forbidden on prod
-#	<IfDefine ENVIRONMENT_PROD>
-#		<IfModule mod_rewrite.c>
-#			RewriteEngine	on
-#			RewriteRule ^ - [F]
-#		</IfModule>
-#	</IfDefine>
-#	# possibility to make overrides after directives in this vhost
-#	IncludeOptional conf.d/includes/first-listed-vhost.post.includes
-#</VirtualHost>
+<VirtualHost *:80>
+	ServerName	"test.proxy"
+	# possibility to make overrides before directives in this vhost
+	IncludeOptional conf.d/includes/first-listed-vhost.pre.includes
+	# since this vhost is first-listed one, this setting influences other vhosts - see https://httpd.apache.org/docs/2.4/mod/core.html#limitrequestfieldsize
+	LimitRequestFieldSize 32768
+	DocumentRoot /var/www/localhost/htdocs
+	AllowEncodedSlashes NoDecode
+	<IfModule mod_headers.c>
+		Header add X-Vhost "test.proxy"
+	</IfModule>
+	<Directory "/var/www/localhost/htdocs">
+		Options Indexes FollowSymLinks
+		AllowOverride None
+		Require all granted
+	</Directory>
+
+	# SKYOPS-49434: Allow EaaS to access publish instance directly for dev and stage environments when test.proxy vhost is requested
+	<IfDefine ENVIRONMENT_DEV>
+		<LocationMatch "/">
+			ProxyPassMatch http://${AEM_HOST}:${AEM_PORT}
+			RewriteEngine Off
+		</LocationMatch>
+	</IfDefine>
+	<IfDefine ENVIRONMENT_STAGE>
+		<LocationMatch "/">
+			ProxyPassMatch http://${AEM_HOST}:${AEM_PORT}
+			RewriteEngine Off
+		</LocationMatch>
+	</IfDefine>
+	# 403 Forbidden on prod
+	<IfDefine ENVIRONMENT_PROD>
+		<IfModule mod_rewrite.c>
+			RewriteEngine	on
+			RewriteRule ^ - [F]
+		</IfModule>
+	</IfDefine>
+	# possibility to make overrides after directives in this vhost
+	IncludeOptional conf.d/includes/first-listed-vhost.post.includes
+</VirtualHost>
 
 # Customer's vhosts:
 Include conf.d/enabled_vhosts/*.vhost

diff --git a/.../src/main/resources/aem-sdk-dispatcher/src/conf.dispatcher.d/available_farms/default.farm b/.../src/main/resources/aem-sdk-dispatcher/src/conf.dispatcher.d/available_farms/default.farm
@@ -9,6 +9,9 @@
 #
 
 /publishfarm {
+	# Dispatcher Debugging Flag
+	# Include X-Cache-Info response header if X-Dispatcher-Info is in request header
+	# /info "1"
 	# client headers which should be passed through to the render instances
 	# (feature supported since dispatcher build 2.6.3.5222)
 	/clientheaders {
@@ -34,6 +37,7 @@
 	#	/url    "/libs/granite/dispatcher/content/vanityUrls.html"
 	#	/file   "/tmp/vanity_urls"
 	#	/delay  300
+	#	/loadOnStartup 1
 	# }
 	# allow propagation of replication posts (should seldomly be used)
 	/propagateSyndPost "0"
@@ -86,9 +90,17 @@
 		}
 		# The ignoreUrlParams section contains query string parameter names that
 		# should be ignored when determining whether some request's output can be
-		# cached or delivered from cache.
+		# cached or delivered from cache. Please only enable one of the examples below.
+		# The recommended setting is to ignore all parameters and selectively allow them. e.g.
+		# /ignoreUrlParams {
+		# 	/0001 { /glob "*" /type "allow" }
+		# 	/0002 { /glob "page" /type "deny" }
+		# 	/0003 { /glob "product" /type "deny" }
+		# }
+		#
 		# In this example configuration, the "q" parameter will be ignored as 
 		# well as general marketing related parameters such as e.g. utm_campaign.
+		# If any other parameters are specified the request gets forwarded to the publisher.
 		# Marketing parameters can normally be ignored on most websites as they are tracked
 		# through different means. 
 		# /ignoreUrlParams {

diff --git a/...s/src/main/resources/aem-sdk-dispatcher/src/conf.dispatcher.d/filters/default_filters.any b/...s/src/main/resources/aem-sdk-dispatcher/src/conf.dispatcher.d/filters/default_filters.any
@@ -96,8 +96,8 @@
 # GraphQL Persisted Queries & preflight requests
 /0061 { /type "allow" /method '(GET|POST|OPTIONS)' /url "/graphql/execute.json*" }
 
-# Allow Forms Document Services requests
-/0062 { /type "allow" /method '(GET|POST)' /url "/adobe/forms/*" }
+# Allow Adaptive Form & Document Services requests
+/0062 { /type "allow" /method '(GET|POST|OPTIONS)' /url "/adobe/forms/*" }
 
 # Allow PUT for Forms DocAssurance Services Decryption API
 /0063 { /type "allow" /method "PUT" /url "/adobe/forms/document/assure/encrypt" }
diff --git a/...src/main/templates/aem-dispatcher-cloud/conf.d/available_vhosts/tenant.vhost.partials.hbs b/...src/main/templates/aem-dispatcher-cloud/conf.d/available_vhosts/tenant.vhost.partials.hbs
@@ -47,7 +47,7 @@ AllowEncodedSlashes NoDecode
     # Some items cache with the wrong mime type
     # Use this option to use the name to auto-detect mime types when cached improperly
     ModMimeUsePathInfo On
-    # Use this option to avoid cache poisioning
+    # Use this option to avoid cache poisoning
     # Sling will return /content/image.jpg as well as /content/image.jpg/ but apache can't search /content/image.jpg/ as a file
     # Apache will treat that like a directory.  This assures the last slash is never stored in cache
     DirectorySlash Off

diff --git a/example/pom.xml b/example/pom.xml
@@ -32,7 +32,7 @@
   <groupId>io.wcm.devops.conga.definitions</groupId>
   <artifactId>io.wcm.devops.conga.definitions.aem.example</artifactId>
   <packaging>config</packaging>
-  <version>2.0.6</version>
+  <version>2.0.8</version>
 
   <name>CONGA AEM Definitions Example</name>
   <description>Example environment definition.</description>
@@ -43,7 +43,7 @@
     <dependency>
       <groupId>io.wcm.devops.conga.definitions</groupId>
       <artifactId>io.wcm.devops.conga.definitions.aem</artifactId>
-      <version>2.0.6</version>
+      <version>2.0.8</version>
       <scope>compile</scope>
     </dependency>
 

diff --git a/parent/pom.xml b/parent/pom.xml
@@ -25,13 +25,13 @@
   <parent>
     <groupId>io.wcm.devops</groupId>
     <artifactId>io.wcm.devops.parent_toplevel</artifactId>
-    <version>1.4.6</version>
+    <version>1.5.0</version>
     <relativePath />
   </parent>
 
   <groupId>io.wcm.devops.conga.definitions</groupId>
   <artifactId>io.wcm.devops.conga.definitions.aem.parent</artifactId>
-  <version>2.0.6</version>
+  <version>2.0.8</version>
   <packaging>pom</packaging>
 
   <name>CONGA AEM Definitions</name>

diff --git a/pom.xml b/pom.xml
@@ -23,13 +23,13 @@
   <parent>
     <groupId>io.wcm.devops.conga.definitions</groupId>
     <artifactId>io.wcm.devops.conga.definitions.aem.parent</artifactId>
-    <version>2.0.6</version>
+    <version>2.0.8</version>
     <relativePath>parent/pom.xml</relativePath>
   </parent>
 
   <groupId>io.wcm.devops.conga.definitions</groupId>
   <artifactId>io.wcm.devops.conga.definitions.aem.root</artifactId>
-  <version>2.0.6</version>
+  <version>2.0.8</version>
   <packaging>pom</packaging>
 
   <name>CONGA AEM Definitions</name>

diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
@@ -38,7 +38,7 @@ The plugins [CONGA Sling Plugin][conga-sling] and [CONGA AEM Plugin][conga-aem]
 
 
 [usage]: usage.html
-[changelog]: changes-report.html
+[changelog]: changes.html
 [conga]: https://devops.wcm.io/conga/
 [conga-sling]: https://devops.wcm.io/conga/plugins/sling/
 [conga-aem]: https://devops.wcm.io/conga/plugins/aem/

diff --git a/src/site/site.xml b/src/site/site.xml
@@ -19,13 +19,11 @@
   #L%
   -->
 
-<project name="CONGA AEM Definitions"
-  xmlns="http://maven.apache.org/DECORATION/1.8.0"
+<site name="CONGA AEM Definitions"
+  xmlns="http://maven.apache.org/SITE/2.0.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
+  xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd">
 
-  <bannerRight>
-    <name><![CDATA[<img src="https://devops.wcm.io/conga/images/conga.png" style="height:120px"/>]]></name>
-  </bannerRight>
+  <bannerRight name="&lt;image src='https://devops.wcm.io/conga/images/conga.png' style='height:120px'/&gt;"/>
 
-</project>
+</site>