Infinispan doc updates #4101
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,9 +39,9 @@ To enable or disable cluster mode, see the [Advanced Application Framework Confi | |
| The Caching Service will use these additional ports if enabled (`zowe.components.caching-service.enabled: true`) and set to use infinispan (the default, `zowe.components.caching-service.storage.mode: infinispan`). | ||
|
|
||
| | Port number | zowe.yaml variable name | Purpose | | ||
| |-------------|------|------| | ||
| | 7099 | zowe.components.caching-service.storage.infinispan.jgroups.keyExchange.port | The port at which the key server in Infinispan is listening. If the port is not available, the next port is probed, up to port+5. Used by the key server (server) to create an SSLServerSocket and by clients to connect to the key server. | ||
| | 7098 | zowe.components.caching-service.storage.infinispan.jgroups.port | Bind port for the socket that is used to form an Infinispan cluster. | ||
|
There was a problem hiding this comment. These should be 7601 and 7600, right? |
||
|
|
||
| ## IP Addresses | ||
|
|
||
|
|
||
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 |
|---|---|---|
|
|
@@ -28,36 +28,52 @@ For more information on Infinispan replication and how to configure a replica in | |
|
|
||
| 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 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 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. | ||
|
There was a problem hiding this comment. Since this is going with 3.2, I'd keep the 7098, I believe we need to update that in the |
||
|
|
||
| :::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:** | ||
|
|
||
|
|
@@ -68,19 +84,21 @@ Configure Infinispan as a storage solution through the Caching service by settin | |
| caching-service: | ||
| storage: | ||
| mode: infinispan | ||
| infinispan: | ||
| jgroups.port: 7098 | ||
|
There was a problem hiding this comment. same thing about being consistent, use the nested format |
||
| initialHosts: lpar2[7098] | ||
| persistence: | ||
| dataLocation: /global/zowe/workspace/caching-service/data | ||
| indexLocation: /global/zowe/workspace/caching-service/index | ||
|
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) |
||
| lpar2: | ||
| components: | ||
| caching-service: | ||
| storage: | ||
| mode: infinispan | ||
| infinispan: | ||
| jgroups.port: 7098 | ||
| initialHosts: lpar1[7098] | ||
| 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.
There is no use case for infinispan running off-platform, right?