Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Infinispan doc updates #4101

Open
wants to merge 14 commits into
base: docs-staging
Choose a base branch
from
30 changes: 11 additions & 19 deletions docs/extend/extend-apiml/api-mediation-infinispan.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,22 @@ Configure Infinispan as a storage solution through the Caching service by settin
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`. 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`**

(OPTIONAL)The default value is `7098`. The port number used by Infinispan to synchronise data among cahing-service instances.

:::note
We recommend you define this value to avoid potential problems or errors in future Zowe upgrades.
:::

* **`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.

:::note
We recommend you define this value to avoid potential problems or errors in future Zowe upgrades.
:::

* **`zowe.components.caching-service.storage.infinispan.keyExchange.port`**

Expand All @@ -68,19 +64,15 @@ Configure Infinispan as a storage solution through the Caching service by settin
caching-service:
storage:
mode: infinispan
infinispan:
infinispan:
jgroups.port: 7098
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand this works, but I think we usually just nest the properties

Suggested change
jgroups.port: 7098
groups:
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:
infinispan:
jgroups.port: 7098
initialHosts: lpar1[7098]
persistence:
dataLocation: /global/zowe/workspace/caching-service/data02
indexLocation: /global/zowe/workspace/caching-service/index02
```
Original file line number Diff line number Diff line change
Expand Up @@ -36,28 +36,44 @@ Configure Infinispan as a storage solution through the Caching service by settin
* **`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`. 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).
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`. 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).
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 `7098`. The port number used by Infinispan to synchronise data among cahing-service instances.
(OPTIONAL) The default value is `7600`. The port number is used by Infinispan to synchronise data among Cahing 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 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.
(OPTIONAL) The default value is `7601`. The port number is used by Infinispan to exchange encryption key among Cahing 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.
:::

**Example of Caching service HA configuration using Infinispan:**

Expand All @@ -68,19 +84,21 @@ Configure Infinispan as a storage solution through the Caching service by settin
caching-service:
storage:
mode: infinispan
infinispan:
infinispan:
jgroups.port: 7098
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same thing about being consistent, use the nested format

initialHosts: lpar2[7098]
persistence:
dataLocation: /global/zowe/workspace/caching-service/data01
indexLocation: /global/zowe/workspace/caching-service/index01
dataLocation: /global/zowe/workspace/caching-service/data
indexLocation: /global/zowe/workspace/caching-service/index
Comment on lines +91 to +92
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
infinispan:
jgroups.port: 7098
initialHosts: lpar1[7098]
persistence:
dataLocation: /global/zowe/workspace/caching-service/data02
indexLocation: /global/zowe/workspace/caching-service/index02
dataLocation: /global/zowe/workspace/caching-service/data
indexLocation: /global/zowe/workspace/caching-service/index
```
Loading