Maintenance of API deployments

Workload distribution requires IBM® z/OS® Connect Servers to be kept in sync.

Started task Applies to z/OS Connect Servers run by using a z/OS started task procedure.

To enable workload distribution across a group of servers, the servers must have the same APIs and API requesters deployed. Any changes to those APIs, or API requesters must be reflected across all the servers that participate in the shared workload.

Maintenance of APIs and API requester deployments with zosConnect-3.0

zosConnect-3.0 Applies to zosConnect-3.0.

Storing the API and API requester WAR files in a single directory that is shared by all servers ensures that the same versions of all APIs are available in all servers.

Maintenance of APIs, services, and API requester deployments with zosConnect-2.0

zosConnect-2.0 Applies to zosConnect-2.0.

APIs are deployed to a location directory that is specified by the location attribute of the zosconnect_zosConnectAPIs element. By default, this attribute contains the server-specific directory ${server.config.dir}/resources/zosconnect/apis. Storing the API archive files in a single directory that is shared by all servers ensures that the same versions of all APIs are available in all servers.

Likewise, API requesters are deployed to a directory that is specified in the location attribute of the zosconnect_apirequesters element. By default, this attribute contains the server-specific directory ${server.config.dir}/resources/zosconnect/apiRequesters. Storing the API requester archive files in a single directory that is shared by all servers ensures that the same versions of all API requesters are available in all servers.

Files that are associated with services can also be stored in UNIX System Services directories, depending on the service provider they use. For example, the WOLA service provider uses the supplied DataXForm to transform JSON payload to bytes. This service requires WSbind files and JSON schema files whose locations are specified to the zosconnect_zosConnectDataXform server configuration element. Choosing to store all the service files in directories that are shared by all the servers ensures that the same versions of all services are available in all servers.

Deciding where to store the API, service, and API requester files

The API location directory, any directories that contain service files (zosConnect-2.0), and the API requesters must be stored in a location that all servers have read and write access to.

It is good practice to use the Liberty profile's shared directory structure. The shared.resource.dir property specifies the location $WLP_USER_DIR/shared/resources. You can use this property name within your server configuration file. You can choose to create nested subdirectories within this directory that are appropriate for your APIs.

For more information about storing shared files, see Location of shared configuration files.