[MNT-23917] Update Hazelcast and Spring beans for ACS 7.2, 7.3, 7.4, …

…23.x (#1406) * [MNT-23917] Update Hazlecast x.x.x version for ACS 7.2 * [MNT-23917] Minor change * [MNT-23917] Update Hazelcast for ACS 7.3 * [MNT-23917] Update Hazelcast for ACS 7.4 * [MNT-23917] Update Hazelcast for ACS 23.x * [MNT-23917] Minor fix Co-authored-by: Adelaide Nxumalo <27953420+anxumalo@users.noreply.github.com> --------- Co-authored-by: Adelaide Nxumalo <27953420+anxumalo@users.noreply.github.com>
Alfresco · Apr 4, 2024 · 004ac2a · 004ac2a
1 parent ebbb7ab
commit 004ac2a
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 29 deletions.
diff --git a/content-services/7.2/admin/cluster.md b/content-services/7.2/admin/cluster.md
@@ -183,19 +183,26 @@ To enable Hazelcast clustering between Share instances, configure the `custom-sl
 
 To enable the Hazelcast cluster messaging, edit this section on each Share Tomcat instance:
 
+> **Note:** For the correct version numbers of both Spring beans and Hazelcast Spring, list the files referring to Hazelcast in the following directory:
+> 
+> ```text
+> cd <tomcat_home>/webapps/share/WEB-INF/lib
+> ls -al | grep hazelcast
+> ```
+
 ```xml
 <?xml version='1.0' encoding='UTF-8'?>
 <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:hz="http://www.hazelcast.com/schema/spring"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
-                http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
+                http://www.springframework.org/schema/beans/spring-beans-x.x.xsd
                 http://www.hazelcast.com/schema/spring
-                http://www.hazelcast.com/schema/spring/hazelcast-spring-3.12.xsd">
+                http://www.hazelcast.com/schema/spring/hazelcast-spring-x.x.xsd">
    <!--
         Hazelcast distributed messaging configuration - Share web-tier cluster config
         - see http://www.hazelcast.com/docs.jsp
-        - and specifically https://docs.hazelcast.org/docs/3.12/manual/html-single/#SpringIntegration
+        - and specifically https://docs.hazelcast.org/docs/x.x/manual/html-single/#SpringIntegration
    -->
    <!-- Configure cluster to use either Multicast or direct TCP-IP messaging - multicast is default -->
    <!-- Optionally specify network interfaces - server machines likely to have more than one interface -->
@@ -227,7 +234,7 @@ To enable the Hazelcast cluster messaging, edit this section on each Share Tomca
 </beans>
 ```
 
-This configuration enables the Hazelcast Spring integration, which in turn, starts the Hazelcast server. The Hazelcast server is easily configurable and can use either multicast (default) or TCP-IP direct, if preferred. For more information, see the [Hazelcast Documentation](https://hazelcast.com/products/in-memory-computing/#resources){target="_blank"}.
+This configuration enables the Hazelcast Spring integration, which in turn, starts the Hazelcast server. The Hazelcast server is easily configurable and can use either multicast (default) or TCP-IP direct, if preferred. For more information, see the [Hazelcast Documentation](https://hazelcast.com/products/in-memory-computing/#resources){:target="_blank"}.
 
 If this configuration is enabled, the Share instance becomes a cluster node and Hazelcast is started. If this configuration is disabled (such as, for a default install), then Hazelcast is not started. While using Share, only when any of the following actions occur, the cache invalidation messages will be sent from the affected node to other nodes in the cluster:
 

diff --git a/content-services/7.3/admin/cluster.md b/content-services/7.3/admin/cluster.md
@@ -174,25 +174,35 @@ This information describes the configuration of Hazelcast clustering between ins
 
 In a load balanced environment, Share now uses Hazelcast to provide multicast messaging between the web-tier nodes. As a result, Share caches no longer need to be disabled for any node, simple cache invalidation message are sent to all nodes when appropriate. Each node functions practically as fast as a single Share instance, enhancing the overall performance of Share.
 
-To enable Hazelcast clustering between Share instances, configure the `custom-slingshot-application-context.xml` file found at `<TOMCAT-HOME>/shared/classes/alfresco/web-extension`. This file is used to override the Spring application context beans for Share.
+To enable Hazelcast clustering between Share instances, configure the `custom-slingshot-application-context.xml` file and place it in the `<TOMCAT-HOME>/shared/classes/alfresco/web-extension` folder. This file is used to override the Spring application context beans for Share.
 
-> **Note:** An example `custom-slingshot-application-context.xml.sample` file is provided in the distribution, which now includes this configuration.
+> **Note:** An example file which includes this configuration is provided in the distribution.zip and is located at
+> `web-server/shared/classes/alfresco/web-extension/web-extension/custom-slingshot-application-context.xml.sample`
+> as well as in the extracted `share.war` under
+> `web-server/webapps/share/WEB-INF/classes/alfresco/web-extension/custom-slingshot-application-context.xml.sample`.
 
 To enable the Hazelcast cluster messaging, edit this section on each Share Tomcat instance:
 
+> **Note:** For the correct version numbers of both Spring beans and Hazelcast Spring, list the files referring to Hazelcast in the following directory:
+> 
+> ```text
+> cd <tomcat_home>/webapps/share/WEB-INF/lib
+> ls -al | grep hazelcast
+> ```
+
 ```xml
 <?xml version='1.0' encoding='UTF-8'?>
 <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:hz="http://www.hazelcast.com/schema/spring"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
-                http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+                http://www.springframework.org/schema/beans/spring-beans-x.x.xsd
                 http://www.hazelcast.com/schema/spring
-                http://www.hazelcast.com/schema/spring/hazelcast-spring-2.4.xsd">
+                http://www.hazelcast.com/schema/spring/hazelcast-spring-x.x.xsd">
    <!--
         Hazelcast distributed messaging configuration - Share web-tier cluster config
         - see http://www.hazelcast.com/docs.jsp
-        - and specifically http://docs.hazelcast.org/docs/2.4/manual/html-single/#SpringIntegration
+        - and specifically https://docs.hazelcast.org/docs/x.x/manual/html-single/#SpringIntegration
    -->
    <!-- Configure cluster to use either Multicast or direct TCP-IP messaging - multicast is default -->
    <!-- Optionally specify network interfaces - server machines likely to have more than one interface -->
@@ -203,11 +213,11 @@ To enable the Hazelcast cluster messaging, edit this section on each Share Tomca
          <hz:group name="slingshot" password="alfresco"/>
          <hz:network port="5801" port-auto-increment="true">
             <hz:join>
-               <hz:multicast enabled="true"
+               <hz:multicast enabled="false"
                      multicast-group="224.2.2.5"
                      multicast-port="54327"/>
-               <hz:tcp-ip enabled="false">
-                  <hz:members></hz:members>
+               <hz:tcp-ip enabled="true">
+                  <hz:members>192.168.15,192.168.16</hz:members>
                </hz:tcp-ip>
             </hz:join>
             <hz:interfaces enabled="false">
@@ -224,7 +234,7 @@ To enable the Hazelcast cluster messaging, edit this section on each Share Tomca
 </beans>
 ```
 
-This configuration enables the Hazelcast Spring integration, which in turn, starts the Hazelcast server. The Hazelcast server is easily configurable and can use either multicast (default) or TCP-IP direct, if preferred. For more information, see the [Hazelcast Documentation](https://hazelcast.com/products/in-memory-computing/#resources){target="_blank"}.
+This configuration enables the Hazelcast Spring integration, which in turn, starts the Hazelcast server. The Hazelcast server is easily configurable and can use either multicast (default) or TCP-IP direct, if preferred. For more information, see the [Hazelcast Documentation](https://hazelcast.com/products/in-memory-computing/#resources){:target="_blank"}.
 
 If this configuration is enabled, the Share instance becomes a cluster node and Hazelcast is started. If this configuration is disabled (such as, for a default install), then Hazelcast is not started. While using Share, only when any of the following actions occur, the cache invalidation messages will be sent from the affected node to other nodes in the cluster:
 
@@ -261,6 +271,15 @@ INFO: /127.0.0.1]:5801 [slingshot] Address[127.0.0.1]:5801 is STARTED
 
 The message shows that the configuration has successfully initialized Hazelcast between Share instances.
 
+### Share Cluster Troubleshooting
+
+In case the Share cluster does not start, check the `share.log` for details.
+
+> **Note**: To setup an ACS Share cluster without internet connection, make sure to check the Hazelcast
+> `xsi:schemaLocation=http://www.hazelcast.com/schema/spring/hazelcast-spring-<version-string>.xsd` is the same Hazelcast version as in the corresponding Share lib
+> `share/WEB-INF/lib/hazelcast-spring-<version>.jar`.
+
+
 ### Configure Alfresco Share clustering
 
 These steps are required for cluster configuration for Share. If you're using an HTTP load-balancing mechanism in front of a clustered installation, ‘sticky’ routing must be enabled for the HTTP requests made by the Share tier to the repository tier (the `/alfresco` application).

diff --git a/content-services/7.4/admin/cluster.md b/content-services/7.4/admin/cluster.md
@@ -174,25 +174,35 @@ This information describes the configuration of Hazelcast clustering between ins
 
 In a load balanced environment, Share now uses Hazelcast to provide multicast messaging between the web-tier nodes. As a result, Share caches no longer need to be disabled for any node, simple cache invalidation message are sent to all nodes when appropriate. Each node functions practically as fast as a single Share instance, enhancing the overall performance of Share.
 
-To enable Hazelcast clustering between Share instances, configure the `custom-slingshot-application-context.xml` file found at `<TOMCAT-HOME>/shared/classes/alfresco/web-extension`. This file is used to override the Spring application context beans for Share.
+To enable Hazelcast clustering between Share instances, configure the `custom-slingshot-application-context.xml` file and place it in the `<TOMCAT-HOME>/shared/classes/alfresco/web-extension` folder. This file is used to override the Spring application context beans for Share.
 
-> **Note:** An example `custom-slingshot-application-context.xml.sample` file is provided in the distribution, which now includes this configuration.
+> **Note:** An example file which includes this configuration is provided in the distribution.zip and is located at
+> `web-server/shared/classes/alfresco/web-extension/web-extension/custom-slingshot-application-context.xml.sample`
+> as well as in the extracted `share.war` under
+> `web-server/webapps/share/WEB-INF/classes/alfresco/web-extension/custom-slingshot-application-context.xml.sample`.
 
 To enable the Hazelcast cluster messaging, edit this section on each Share Tomcat instance:
 
+> **Note:** For the correct version numbers of both Spring beans and Hazelcast Spring, list the files referring to Hazelcast in the following directory:
+> 
+> ```text
+> cd <tomcat_home>/webapps/share/WEB-INF/lib
+> ls -al | grep hazelcast
+> ```
+
 ```xml
 <?xml version='1.0' encoding='UTF-8'?>
 <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:hz="http://www.hazelcast.com/schema/spring"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
-                http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+                http://www.springframework.org/schema/beans/spring-beans-x.x.xsd
                 http://www.hazelcast.com/schema/spring
-                http://www.hazelcast.com/schema/spring/hazelcast-spring-2.4.xsd">
+                http://www.hazelcast.com/schema/spring/hazelcast-spring-x.x.xsd">
    <!--
         Hazelcast distributed messaging configuration - Share web-tier cluster config
         - see http://www.hazelcast.com/docs.jsp
-        - and specifically http://docs.hazelcast.org/docs/2.4/manual/html-single/#SpringIntegration
+        - and specifically https://docs.hazelcast.org/docs/x.x/manual/html-single/#SpringIntegration
    -->
    <!-- Configure cluster to use either Multicast or direct TCP-IP messaging - multicast is default -->
    <!-- Optionally specify network interfaces - server machines likely to have more than one interface -->
@@ -203,11 +213,11 @@ To enable the Hazelcast cluster messaging, edit this section on each Share Tomca
          <hz:group name="slingshot" password="alfresco"/>
          <hz:network port="5801" port-auto-increment="true">
             <hz:join>
-               <hz:multicast enabled="true"
+               <hz:multicast enabled="false"
                      multicast-group="224.2.2.5"
                      multicast-port="54327"/>
-               <hz:tcp-ip enabled="false">
-                  <hz:members></hz:members>
+               <hz:tcp-ip enabled="true">
+                  <hz:members>192.168.15,192.168.16</hz:members>
                </hz:tcp-ip>
             </hz:join>
             <hz:interfaces enabled="false">
@@ -261,6 +271,14 @@ INFO: /127.0.0.1]:5801 [slingshot] Address[127.0.0.1]:5801 is STARTED
 
 The message shows that the configuration has successfully initialized Hazelcast between Share instances.
 
+### Share Cluster Troubleshooting
+
+In case the Share cluster does not start, check the `share.log` for details.
+
+> **Note**: To setup an ACS Share cluster without internet connection, make sure to check the Hazelcast
+> `xsi:schemaLocation=http://www.hazelcast.com/schema/spring/hazelcast-spring-<version-string>.xsd` is the same Hazelcast version as in the corresponding Share lib
+> `share/WEB-INF/lib/hazelcast-spring-<version>.jar`.
+
 ### Configure Alfresco Share clustering
 
 These steps are required for cluster configuration for Share. If you're using an HTTP load-balancing mechanism in front of a clustered installation, ‘sticky’ routing must be enabled for the HTTP requests made by the Share tier to the repository tier (the `/alfresco` application).

diff --git a/content-services/latest/admin/cluster.md b/content-services/latest/admin/cluster.md
@@ -174,25 +174,35 @@ This information describes the configuration of Hazelcast clustering between ins
 
 In a load balanced environment, Share now uses Hazelcast to provide multicast messaging between the web-tier nodes. As a result, Share caches no longer need to be disabled for any node, simple cache invalidation message are sent to all nodes when appropriate. Each node functions practically as fast as a single Share instance, enhancing the overall performance of Share.
 
-To enable Hazelcast clustering between Share instances, configure the `custom-slingshot-application-context.xml` file found at `<TOMCAT-HOME>/shared/classes/alfresco/web-extension`. This file is used to override the Spring application context beans for Share.
+To enable Hazelcast clustering between Share instances, configure the `custom-slingshot-application-context.xml` file and place it in the `<TOMCAT-HOME>/shared/classes/alfresco/web-extension` folder. This file is used to override the Spring application context beans for Share.
 
-> **Note:** An example `custom-slingshot-application-context.xml.sample` file is provided in the distribution, which now includes this configuration.
+> **Note:** An example file which includes this configuration is provided in the distribution.zip and is located at
+> `web-server/shared/classes/alfresco/web-extension/web-extension/custom-slingshot-application-context.xml.sample`
+> as well as in the extracted `share.war` under
+> `web-server/webapps/share/WEB-INF/classes/alfresco/web-extension/custom-slingshot-application-context.xml.sample`.
 
 To enable the Hazelcast cluster messaging, edit this section on each Share Tomcat instance:
 
+> **Note:** For the correct version numbers of both Spring beans and Hazelcast Spring, list the files referring to Hazelcast in the following directory:
+> 
+> ```text
+> cd <tomcat_home>/webapps/share/WEB-INF/lib
+> ls -al | grep hazelcast
+> ```
+
 ```xml
 <?xml version='1.0' encoding='UTF-8'?>
 <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:hz="http://www.hazelcast.com/schema/spring"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
-                http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+                http://www.springframework.org/schema/beans/spring-beans-x.x.xsd
                 http://www.hazelcast.com/schema/spring
-                http://www.hazelcast.com/schema/spring/hazelcast-spring-5.3.xsd">
+                http://www.hazelcast.com/schema/spring/hazelcast-spring-x.x.xsd">
    <!--
         Hazelcast distributed messaging configuration - Share web-tier cluster config
         - see http://www.hazelcast.com/docs.jsp
-        - and specifically http://docs.hazelcast.org/docs/2.4/manual/html-single/#SpringIntegration
+        - and specifically https://docs.hazelcast.org/docs/x.x/manual/html-single/#SpringIntegration
    -->
    <!-- Configure cluster to use either Multicast or direct TCP-IP messaging - multicast is default -->
    <!-- Optionally specify network interfaces - server machines likely to have more than one interface -->
@@ -202,11 +212,11 @@ To enable the Hazelcast cluster messaging, edit this section on each Share Tomca
       <hz:config>
          <hz:network port="5801" port-auto-increment="true">
             <hz:join>
-               <hz:multicast enabled="true"
+               <hz:multicast enabled="false"
                      multicast-group="224.2.2.5"
                      multicast-port="54327"/>
-               <hz:tcp-ip enabled="false">
-                  <hz:members></hz:members>
+               <hz:tcp-ip enabled="true">
+                  <hz:members>192.168.15,192.168.16</hz:members>
                </hz:tcp-ip>
             </hz:join>
             <hz:interfaces enabled="false">
@@ -260,6 +270,14 @@ INFO: /127.0.0.1]:5801 [slingshot] Address[127.0.0.1]:5801 is STARTED
 
 The message shows that the configuration has successfully initialized Hazelcast between Share instances.
 
+### Share Cluster Troubleshooting
+
+In case the Share cluster does not start, check the `share.log` for details.
+
+> **Note**: To setup an ACS Share cluster without internet connection, make sure to check the Hazelcast
+> `xsi:schemaLocation=http://www.hazelcast.com/schema/spring/hazelcast-spring-<version-string>.xsd` is the same Hazelcast version as in the corresponding Share lib
+> `share/WEB-INF/lib/hazelcast-spring-<version>.jar`.
+
 ### Configure Alfresco Share clustering
 
 These steps are required for cluster configuration for Share. If you're using an HTTP load-balancing mechanism in front of a clustered installation, ‘sticky’ routing must be enabled for the HTTP requests made by the Share tier to the repository tier (the `/alfresco` application).