Infinispan doc updates #4101
+74
−64
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,19 @@ | ||
| # Using Infinispan as a storage solution through the Caching Service | ||
|
|
||
| :::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 (HA) 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) | ||
| - [Infinispan replica instances](#infinispan-replica-instances) | ||
| - [Infinispan configuration](#infinispan-configuration) | ||
|
|
||
| ## Understanding Infinispan | ||
|
|
||
| Infinispan is a storage solution that stores data structures in key-value pairs. The API Caching Service uses hash sets, where each | ||
| service storing data via the Caching Service has its own hash, and each data entry is a key-value entry within that service's Infinispan hash set. | ||
|
|
||
| For more information on Infinispan, see the [official Infinispan documentation](https://infinispan.org/documentation/). | ||
|
|
||
|
|
@@ -26,40 +26,56 @@ For more information on Infinispan replication and how to configure a replica in | |
|
|
||
| ## Infinispan configuration | ||
|
|
||
| Configure Infinispan as a storage solution through the Caching Service by setting the following configuration parameters in the `zowe.yaml`. | ||
|
|
||
| * **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}]`. | ||
|
|
||
| * **zowe.components.caching-service.storage.infinispan.persistence.dataLocation** | ||
|
|
||
| The path where the service keeps its data files for the Infinispan Soft-Index Cache Store. | ||
| The default value is `data`. To run the Caching Service in HA, ensure that you apply the following configuration conditions: | ||
|
|
||
| - The value should be the same for each instance. | ||
| - The location should point to a non-shared filesystem. Each instance requires unique storage. | ||
| - 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`. To run the Caching Service in HA, ensure that you apply the following configuration conditions: | ||
|
|
||
| - The value should be the same for each instance. | ||
| - The location should point to a non-shared filesystem. Each instance requires unique storage. | ||
| - 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** | ||
|
|
||
| (Optional) The default value is `7600`. The port number is used by Infinispan to synchronise data among Caching Service instances. | ||
|
|
||
| :::note | ||
| We recommend you define this value to avoid potential problems or errors in future Zowe upgrades, for example | ||
| from version 2.x through v3.1 to v3.2 and newer versions. | ||
| ::: | ||
|
|
||
| * **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 Caching Service instances. | ||
|
|
||
| * **zowe.components.caching-service.storage.infinispan.keyExchange.port** | ||
|
|
||
| (Optional) The default value is `7601`. The port number is used by Infinispan to exchange encryption key among Caching Service instances. | ||
|
|
||
|
There was a problem hiding this comment. This one is not defined in https://github.com/zowe/zowe-install-packaging/blob/v3.x/staging/files/defaults.yaml |
||
| :::note | ||
| We recommend you define this value to avoid potential problems or errors in future Zowe upgrades, for example | ||
| from version 2.x through v3.1 to v3.2 and newer versions. | ||
| ::: | ||
|
|
||
| **Example of Caching Service HA configuration using Infinispan:** | ||
|
|
||
| ```yaml | ||
| haInstances: | ||
|
|
@@ -68,19 +84,21 @@ Configure Infinispan as a storage solution through the Caching service by settin | |
| caching-service: | ||
| storage: | ||
| mode: infinispan | ||
| infinispan: | ||
| jgroups.port: 7600 | ||
| initialHosts: lpar2[7600] | ||
| persistence: | ||
| dataLocation: /global/zowe/workspace/caching-service/data | ||
| indexLocation: /global/zowe/workspace/caching-service/index | ||
| lpar2: | ||
|
Comment on lines
+91
to
+92
There was a problem hiding this comment. add a comment to the example about needing to be in a non-shared filesystem (tendency to copy-paste) |
||
| components: | ||
| caching-service: | ||
| storage: | ||
| mode: infinispan | ||
| infinispan: | ||
| jgroups.port: 7600 | ||
| initialHosts: lpar1[7600] | ||
| persistence: | ||
| dataLocation: /global/zowe/workspace/caching-service/data | ||
| indexLocation: /global/zowe/workspace/caching-service/index | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is going with 3.2, I'd keep the 7098, I believe we need to update that in the
defaults.yaml