Skip to content

Commit

Permalink
Add using infinispan to sidebar (#3366)
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Jandacek <[email protected]>
  • Loading branch information
janan07 authored Jan 17, 2024
1 parent 88f54b1 commit 623b898
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
19 changes: 13 additions & 6 deletions docs/extend/extend-apiml/api-mediation-caching-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ The Caching Service is available only for internal Zowe applications, and is not

- [Architecture](#architecture)
- [Storage methods](#storage-methods)
- [Infinispan](#infinispan)
- [VSAM](#vsam)
- [Redis](#redis)
- [Infinispan](#infinispan)
- [InMemory](#inmemory)
- [How to start the service](#how-to-start-the-service)
- [Methods to use the Caching service API](#methods-to-use-the-caching-service-api)
- [Configuration properties](#configuration-properties)
- [Authentication](#authentication)

## Architecture

A precondition to provide for High Availability of all components within Zowe is the requirement that these components be either stateless, or for the resources of the service, to be offloaded to a location accessible by all instances of the service. This condition also applies to recently started instances. Some services, however, are not and cannot be stateless. The Caching Service is designed for these types of services.
Expand All @@ -36,25 +37,30 @@ Information from cached APIs is stored as a JSON in the following format:
## Storage methods

The Caching Service supports the following storage solutions, which provide the option to add custom implementation.

### Infinispan (recommended)

Infinispan is a storage solution that can also run on the z/OS platform. It can store data structures in key-value pairs, has high-availability support, and is highly performant.

For more information about the Infinispan storage access method, see [Using Infinispan as a storage solution through the Caching service](./api-mediation-infinispan.md).

### VSAM

VSAM can be used to organize records into four types of data sets: key-sequenced, entry-sequenced, linear, or relative record. Use VSAM as the storage solution for production. VSAM is used primarily for applications and is not used for source programs, JCL, or executable modules. ISPF cannot be used to display or edit VSAM files.

For more information about the VSAM storage access method, see [Using VSAM as a storage solution through the Caching Service](./api-mediation-vsam.md).

### Redis

Redis is a common storage solution that runs outside of the z/OS platform. It can store data structures in key-value pairs, has high-availability support, and is highly performant.

For more information about the Redis storage access method, see [Using Redis as a storage solution through the Caching Service](./api-mediation-redis.md).
### Infinispan

Infinispan is a storage solution that can also run on the z/OS platform. It can store data structures in key-value pairs, has high-availability support, and is highly performant.

For more information about the Infinispan storage access method, see [Using Infinispan as a storage solution through the Caching service](./api-mediation-infinispan.md).
### InMemory

The InMemory storage method is a method suitable for testing and integration verification. Be sure not to use InMemory storage in production.
The key/value pairs are stored only in the memory of a single instance of the service. As such, the key/value pairs do not persist.

## How to start the Service

By default, the Caching Service starts along with the other Zowe components. To prevent the Caching Service from starting, set
Expand Down Expand Up @@ -102,9 +108,10 @@ This parameter specifies service behavior when the limit of records is reached.
* **removeOldest**
removes the oldest item in the cache when the service reaches the configured maximum number

**Notes:**
:::note**Notes:**
- For more information about how to configure the Caching Service in the `application.yml`, see: [Add API Onboarding Configuration](../extend-apiml/onboard-spring-boot-enabler.md).
- When using VSAM, ensure that you set the additional configuration parameters. For more information about setting these parameters, see [Using VSAM as a storage solution through the Caching Service](./api-mediation-vsam.md).
:::

## Authentication

Expand Down
10 changes: 5 additions & 5 deletions docs/extend/extend-apiml/api-mediation-infinispan.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ For more information on Infinispan, see the [official Infinispan documentation](

### Infinispan replica instances

Infinispan can be used with both on standalone instance and High Availability mode. In case of multiple Caching Service instances,
you will have to specify all the cluster nodes (members). Each Infinispan node is bound to specific Caching Service instance and runs on a different port and host, which can be configured. See the [nfinispan configuration](#infinispan-configuration) to know how to configure multiple Infinispan nodes.
Infinispan can be used with both a standalone instance and high availability mode. When using multiple Caching Service instances,
it is necessary to specify all of the cluster nodes (members). Each Infinispan node is bound to a specific Caching Service instance and runs on a different port and host, which can be configured. For more information about configuring multiple Infinispan modes, see the [Infinispan configuration](#infinispan-configuration).

For more information on Infinispan replication and how to configure a replica instance, see the [official Infinispan Cross-site Replication documentation](https://infinispan.org/docs/stable/titles/xsite/xsite.html).
For more information on Infinispan replication and how to configure a replica instance, see the [Infinispan Cross-site Replication](https://infinispan.org/docs/stable/titles/xsite/xsite.html) documentation.

## Infinispan configuration

Expand All @@ -35,10 +35,10 @@ Configure Infinispan as a storage solution through the Caching service by settin

* **`CACHING_STORAGE_INFINISPAN_PERSISTENCE_DATALOCATION`**

The path where the Soft-Index store will keep its data files for the Infinispan Soft-Index Cache Store.
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 [Soft-Index File Store](https://infinispan.org/blog/2014/10/31/soft-index-file-store).
instance. For more information, see the [Soft-Index File Store](https://infinispan.org/blog/2014/10/31/soft-index-file-store).


* **`JGROUPS_BIND_PORT`**
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,7 @@ module.exports = {
label: "Caching service",
items: [
"extend/extend-apiml/api-mediation-caching-service",
"extend/extend-apiml/api-mediation-infinispan"
"extend/extend-apiml/api-mediation-vsam",
"extend/extend-apiml/api-mediation-redis",
],
Expand Down

0 comments on commit 623b898

Please sign in to comment.