Skip to content

Commit

Permalink
update infinispan docs according to the current configuration (#3848)
Browse files Browse the repository at this point in the history
* update infinispan docs according to the current configuration

Signed-off-by: ac892247 <a.chmelo@gmail.com>

* add role to storage provider options

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

* minor intro edit

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

---------

Signed-off-by: ac892247 <a.chmelo@gmail.com>
Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
Co-authored-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
  • Loading branch information
2 people authored and zFernand0 committed Sep 9, 2024
1 parent a5ad834 commit e4fc9e0
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 12 deletions.
31 changes: 24 additions & 7 deletions docs/extend/extend-apiml/api-mediation-infinispan.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -31,17 +33,30 @@ 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}]`.

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 `7600`. 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 `7601`. The port number used by Infinispan to exchange encryption key among cahing-service instances.


**Example of Caching service HA configuration using Infinispan:**
Expand All @@ -60,6 +75,7 @@ Configure Infinispan as a storage solution through the Caching service by settin
port: 7098
persistence:
dataLocation: /global/zowe/workspace/caching-service/data01
indexLocation: global/zowe/workspace/caching-service/index01
lpar2:
components:
caching-service:
Expand All @@ -71,4 +87,5 @@ Configure Infinispan as a storage solution through the Caching service by settin
port: 7099
persistence:
dataLocation: /global/zowe/workspace/caching-service/data02
indexLocation: global/zowe/workspace/caching-service/index02
```
6 changes: 4 additions & 2 deletions docs/extend/extend-apiml/api-mediation-redis.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Using Redis as a storage solution through the Caching service

As an API developer, you can configure Redis as a storage solution through the Caching service. This article describes how to configure your storage solution for Redis.
You can configure Redis 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 Redis as a storage solution through the Caching service, as well as configure Redis for high availability to replicate data to provide data durability and availability.

- [Understanding Redis](#understanding-redis)
- [Redis configuration](#redis-configuration)
Expand Down
10 changes: 7 additions & 3 deletions docs/extend/extend-apiml/api-mediation-vsam.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Using VSAM as a storage solution through the Caching service **Deprecated**

The VSAM as a storage solution is deprecated in V3, please use [Infinispan](./api-mediation-infinispan), which is packaged as part of the Caching Service.
:::info Required roles: system administrator, security administrator
:::

As an API developer, you can configure VSAM as a storage solution through the Caching service. The procedure in this article
describes how to configure your storage solution for VSAM. Configuring VSAM ensures that you do not lose data if you need to restart. Configuring VSAM also makes it possible to leverage multiple caching services concurrently, whereby clients can retreive data through VSAM.
:::caution Important
VSAM as a storage solution is deprecated in Zowe V3, please use [Infinispan](./api-mediation-infinispan), which is packaged as part of the Caching Service.
:::

In Zowe v2 or previous versions, it is possible to configure VSAM as a storage solution through the Caching service. Configuring VSAM ensures that you do not lose data if you need to restart. Configuring VSAM also makes it possible to leverage multiple caching services concurrently, whereby clients can retreive data through VSAM.

- [Understanding VSAM](#understanding-vsam)
- [VSAM configuration](#vsam-configuration)
Expand Down

0 comments on commit e4fc9e0

Please sign in to comment.