Step 29B(II): Configurations for the OPT_LIBERTY_DEPLOYED Option

This topic describes the configuration steps for the OPT_LIBERTY_DEPLOYED option. If you're using the OPT_EMBEDDED_WEBSERVER option, see Step 29B(I): Configurations for the OPT_EMBEDDED_WEBSERVER Option.

Deploy the Operations REST Server

You need to deploy the Operations REST Server "war" file to your WebSphere® Liberty environment, adapt the JCL that starts the WebSphere server instance, and customize the server.xml and server.env files.

Note: The REST API requires either ‘servlet-5.0’ or ‘servlet-6.0’ WLP features.

Procedure

Choose an existing or create a new liberty server instance to host the System Automation Operations REST Server that is found as a "war" file in the directory /usr/lpp/ing/restsrvr/lib. Use your standard procedure to deploy this "war" file as "APP". For example, copy it into the /apps directory of the liberty server instance directory that you have chosen to host the Operations REST Server.
Modify the CONFIG parameter in the start procedure of your WebSphere Liberty server that you have chosen to deploy the Operations REST Server.
Adapt the files "server.xml" and "server.env" that have been created by the liberty-owned command to create a new liberty server instance.
In the server.xml file, define the name of your System Automation Operations REST Server running as a liberty APP, the context-root for the app and port(s).
Here is an example excerpt of server.xml . Choose the values that are suitable for your environment.
```
...
<httpEndpoint id="defaultHttpEndpoint" host="*" httpPort="9081" httpsPort="9444"/>
...
<application context-root="/ibm/sa" type="war" id="SAREST" location="ingoperations.war" name="SAREST" />
...
```
The configuration of the System Automation Operations REST Server is done with the environment variables which have to be added to the server.env file. For example, you can configure tracing and logging. See Table 1 for all the properties and descriptions.
Make sure that your <NETVIEW_V63_HOME>/restsrvr/bin is added to the PATH environment of the user that starts the Operations REST Server.

Table 1. Properties in the server.env file
Properties	Description	Default
SPRINGDOC_SWAGGER_UI_ENABLED	Swagger UI	true
ING_OPERATIONS_LOG_LEVEL	Sets the log level for the application.	INFO
ING_OPERATIONS_{LOG,TRACE}_FILE_PATH	Sets the path where the {log,trace} files will be written.	/var/log/ing/restsrvr
ING_OPERATIONS_{LOG,TRACE}_FILE_NAME	Sets the name of the {log,trace} file.	{ing.operations,ing.operations.trace}
ING_OPERATIONS_{LOG,TRACE}_FILE_ARCHIVE_PATTERN	The file name pattern for archived {log,trace} files.	/var/log/ing/restsrvr/%d{yyyy-MM}/{ing.operations,ing.operations.trace}-%d{yyyy-MM-dd}-%i
ING_OPERATIONS_{LOG,TRACE}_FILE_DELETE_AFTER	Specify the number of days for which {log,trace} files are kept. If a log file is older than the specified period, it is automatically deleted.	{730,10} (in days)
ING_OPERATIONS_{LOG,TRACE}_FILE_MAX_PER_DAY	Specify how many {log,trace} files may be created per day before old log files are overwritten.	{10,100}
ING_OPERATIONS_{LOG,TRACE}_FILE_MAX_SIZE	Specify the maximum size of the {log,trace} file (in megabytes). If the maximum size is exceeded, a new {log,trace} file is automatically created.	20 (in MB)
ING_OPERATIONS_ZOWE_URLS_QUERY	Specify the URL where the Zowe API Mediation Layer validates the JWT token.	${zowe.urls.apiml}/api/v1/gateway/auth/query

Configurations for using RACF key rings

The System Automation Operations REST Server can use RACF key rings to manage certificates if configured accordingly for the OPT_LIBERTY_DEPLOYED option. Integrated Cryptographic Service Facility (ICSF) key rings are not supported.

For details of the configuration steps, see Configuring SAF certificates and keyrings for TLS on the z/OS operating system in WebSphere Application Server for z/OS Liberty documentation.