Merge pull request #3956 from zowe/update_ha_doc

Update documentation about Infinispan config
zowe · Oct 18, 2024 · bc45a1d · bc45a1d
2 parents b0f8221 + ea038d4
commit bc45a1d
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 27 deletions.
diff --git a/docs/extend/extend-apiml/api-mediation-infinispan.md b/docs/extend/extend-apiml/api-mediation-infinispan.md
@@ -47,7 +47,7 @@ Configure Infinispan as a storage solution through the Caching service by settin
 
 * **`zowe.components.caching-service.storage.infinispan.jgroups.port`**
 
-  (OPTIONAL)The default value is `7600`. The port number used by Infinispan to synchronise data among cahing-service instances.
+  (OPTIONAL)The default value is `7098`. The port number used by Infinispan to synchronise data among cahing-service instances.
 
 * **`zowe.components.caching-service.storage.infinispan.jgroups.host`**
 
@@ -56,36 +56,31 @@ Configure Infinispan as a storage solution through the Caching service by settin
 
 * **`zowe.components.caching-service.storage.infinispan.keyExchange.port`**
 
-  (OPTIONAL)The default value is `7601`. The port number used by Infinispan to exchange encryption key among cahing-service instances.
+  (OPTIONAL)The default value is `7118`. The port number used by Infinispan to exchange encryption key among cahing-service instances.
 
 
   **Example of Caching service HA configuration using Infinispan:**
 
   ```yaml
-  zowe
   haInstances:
     lpar1:
       components:
         caching-service:
           storage:
             mode: infinispan
             infinispan: 
-              initialHosts: lpar2[7099]
-              jgroups:
-                port: 7098
+              initialHosts: lpar2[7098]
               persistence:
                 dataLocation: /global/zowe/workspace/caching-service/data01
-                indexLocation: global/zowe/workspace/caching-service/index01
+                indexLocation: /global/zowe/workspace/caching-service/index01
     lpar2:
       components:
         caching-service:
           storage:
             mode: infinispan
             infinispan: 
               initialHosts: lpar1[7098]
-              jgroups:
-                port: 7099
               persistence:
                 dataLocation: /global/zowe/workspace/caching-service/data02
-                indexLocation: global/zowe/workspace/caching-service/index02
+                indexLocation: /global/zowe/workspace/caching-service/index02
   ```
diff --git a/docs/user-guide/configure-sysplex.md b/docs/user-guide/configure-sysplex.md
@@ -12,11 +12,10 @@ Zowe high availability instances require a Sysplex environment that consists of
 - Connection to shared DASD
 - Shared SAF database, see [Sharing a database with sysplex communication in data sharing mode](https://www.ibm.com/docs/en/zos/2.1.0?topic=sd-sharing-database-sysplex-communication-in-data-sharing-mode)
 - Sysplex Distributor with configured Dynamic VIPA TCP/IP address, see [Configuring Sysplex Distributor](#configuring-sysplex-distributor) for instructions
-- VSAM record-level sharing (RLS), see [Preparing for VSAM record-level sharing](https://www.ibm.com/docs/en/zos/2.4.0?topic=sharing-preparing-vsam-record-level)
 - USS Shared file system, see [How to share file systems in a Sysplex](https://www.ibm.com/docs/en/zos/2.4.0?topic=planning-sharing-file-systems-in-sysplex)
 - JESPlex/JES2 Multi-Access Spool (MAS) environment
 - z/OSMF high availability, see [Configuring z/OSMF high availability in Sysplex](systemrequirements-zosmf-ha.md)
-- Node.js v14.x (except v14.17.2), or v16.x
+- Node.js v16.x or higher, required in case you enable Zowe Desktop
 
 :::note
 It is highly recommended that Node.js is installed on a shared file system.

diff --git a/versioned_docs/version-v1.28.x/user-guide/configure-sysplex.md b/versioned_docs/version-v1.28.x/user-guide/configure-sysplex.md
@@ -16,7 +16,7 @@ Zowe high availability instances require a Sysplex environment that consists of
 - USS Shared file system, see [How to share file systems in a Sysplex](https://www.ibm.com/docs/en/zos/2.4.0?topic=planning-sharing-file-systems-in-sysplex)
 - JESPlex/JES2 Multi-Access Spool (MAS) environment
 - z/OSMF high availability, see [Configuring z/OSMF high availability in Sysplex](systemrequirements-zosmf-ha.md)
-- Node.js v14.x (except v14.17.2) or v16.x
+- Node.js v16.x or higher, required in case you enable Zowe Desktop
 
   **Note:** It is highly recommended that Node.js installed on a shared file system.
 

diff --git a/versioned_docs/version-v2.18.x/extend/extend-apiml/api-mediation-infinispan.md b/versioned_docs/version-v2.18.x/extend/extend-apiml/api-mediation-infinispan.md
@@ -1,7 +1,9 @@
 # Using Infinispan as a storage solution through the Caching service
 
-As an API developer, you can configure Infinispan as a storage solution through the Caching service. This article describes how to configure your storage solution for Infinispan.
-You can configure Infinispan for high availability as well as to replicate data to provide data durability and availability.
+:::info Required roles: system administrator, security administrator
+:::
+
+You can configure Infinispan as a storage solution through the Caching service, as well as configure Infinispan for high availability to replicate data to provide data durability and availability.
 
 - [Using Infinispan as a storage solution through the Caching service](#using-infinispan-as-a-storage-solution-through-the-caching-service)
   - [Understanding Infinispan](#understanding-infinispan)
@@ -28,47 +30,53 @@ Configure Infinispan as a storage solution through the Caching service by settin
 
 * **`zowe.components.caching-service.storage.infinispan.initialHosts`**
 
-  This property specifies the list of cluster nodes (members). In case of multiple instances, the value for each Caching Service instance can be 
-  either a list of all the members, separated by a comma, or just the replica. The format is `${haInstance.hostname}[${zowe.components.caching-service.storage.infinispan.jgroups.port}]`.
-
+  This property specifies the list of cluster nodes (members). In case of multiple instances, the value for each Caching Service instance can be
   either a list of all the members, separated by a comma, or just the replica. The format is `${haInstance.hostname}[${zowe.components.caching-service.storage.infinispan.jgroups.port}]`.
 
 * **`zowe.components.caching-service.storage.infinispan.persistence.dataLocation`**
 
-  The path where the Soft-Index store keeps its data files for the Infinispan Soft-Index Cache Store. 
-  The default value is `data`. If you run the Caching Service in HA and the instances use the same filesystem, you have to specify a different value of the `CACHING_STORAGE_INFINISPAN_PERSISTENCE_DATALOCATION` property for each instance. For more information, see the [Soft-Index File Store](https://infinispan.org/blog/2014/10/31/soft-index-file-store).
+  The path where the service keeps its data files for the Infinispan Soft-Index Cache Store.
+  The default value is `data`. If you run the Caching Service in HA and the instances use the same filesystem, you have to specify a different value of the data property for each instance. For more information, see the [Soft-Index File Store](https://infinispan.org/blog/2014/10/31/soft-index-file-store).
+
+* **`zowe.components.caching-service.storage.infinispan.persistence.indexLocation`**
 
+  The path where the service keeps its index data for the Infinispan Soft-Index Cache Store.
+  The default value is `index`. If you run the Caching Service in HA and the instances use the same filesystem, you have to specify a different value of the index property for each instance. For more information, see the [Soft-Index File Store](https://infinispan.org/blog/2014/10/31/soft-index-file-store).
 
 * **`zowe.components.caching-service.storage.infinispan.jgroups.port`**
 
-  The port number used by Infinispan to synchronise data among cahing-service instances.
+  (OPTIONAL)The default value is `7098`. The port number used by Infinispan to synchronise data among cahing-service instances.
+
+* **`zowe.components.caching-service.storage.infinispan.jgroups.host`**
+
+  (OPTIONAL)The default value is taken from zowe hostname. The hostname used by Infinispan to synchronise data among cahing-service instances.
+
+* **`zowe.components.caching-service.storage.infinispan.keyExchange.port`**
 
+  (OPTIONAL)The default value is `7118`. The port number used by Infinispan to exchange encryption key among cahing-service instances.
 
   **Example of Caching service HA configuration using Infinispan:**
 
   ```yaml
-  zowe
   haInstances:
     lpar1:
       components:
         caching-service:
           storage:
             mode: infinispan
             infinispan: 
-              initialHosts: lpar2[7099]
-              jgroups:
-                port: 7098
+              initialHosts: lpar2[7098]
               persistence:
                 dataLocation: /global/zowe/workspace/caching-service/data01
+                indexLocation: /global/zowe/workspace/caching-service/index01
     lpar2:
       components:
         caching-service:
           storage:
             mode: infinispan
             infinispan: 
               initialHosts: lpar1[7098]
-              jgroups:
-                port: 7099
               persistence:
                 dataLocation: /global/zowe/workspace/caching-service/data02
+                indexLocation: /global/zowe/workspace/caching-service/index02
   ```