Configure the Liberty server

Prerequisite tasks

The following tasks need to be completed before you can complete this chapter:

• A Liberty angel process must be running. If this is a named angel, you will need the angel name ${WLP_ANGEL_NAME}.
• The required network configuration must be completed.

Directory setup

The following directories need to be created:

• ${SERVER_DIRECTORY} - the directory where the configuration files of the active Liberty server (server.env and jvm.options) are residing
• ${SERVER_OUTPUT_DIR} - optional output directory for the server logs, otherwise they will be created in the ${SERVER_DIRECTORY}

The ${SERVER_DIRECTORY} requires a special format. WebSphere Liberty expects to find the configuration files in a directory with the name of the server under ${WLP_USER_DIR}/servers/. It is recommended to use the name of the Liberty server started task ${SERVER_STC_NAME} as server name, so that the ${SERVER_DIRECTORY} will be ${WLP_USER_DIR}/servers/{SERVER_STC_NAME}.

The installation workflows can guide you through the creation of the required directories as well as the allocation of ZFS datasets that will be mounted there.

Configure the Liberty server

The configuration of the Liberty server consists of some generic configuration, followed by specific steps depending on what the server is used for.

cd ${WLP_USER_DIR}/servers/${SERVER_STC_NAME}
cp ${INSTALL_DIR}/server.env server.env

cd ${WLP_USER_DIR}/servers/${SERVER_STC_NAME}
cp ${INSTALL_DIR}/jvm.options jvm.options

cd ${WLP_USER_DIR}/servers/${SERVER_STC_NAME}
mkdir configDropins
mkdir configDropins/overrides
ln -s ${INSTALL_DIR}/configDropins/defaults configDropins/defaults
ln -s ${INSTALL_DIR}/configDropins/options configDropins/options

cd ${WLP_USER_DIR}/servers/${SERVER_STC_NAME}
ln -s ${INSTALL_DIR}/EkmfWeb.properties EkmfWeb.properties
ln -s ${INSTALL_DIR}/apps apps
ln -s ${INSTALL_DIR}/resources resources
ln -s ${INSTALL_DIR}/server.xml server.xml

Create the server procedure

Create a procedure to start the server and copy it to your ${ZOS_PROCLIB}. If you don't use the workflow, you can use the following sample procedure and replace all ${placeholders} to match your environment:

//${SERVER_STC_NAME} PROC PARMS='${SERVER_STC_NAME}'
// SET WLPHOME='${WLP_INSTALL_DIR}'
//*
//STEP1    EXEC PGM=BPXBATSL,REGION=0M,TIME=NOLIMIT,
//  PARM='PGM &WLPHOME./lib/native/zos/s390x/bbgzsrv --clean &PARMS.'
//STEPLIB  DD DSN=${DB_HLQ}.SDSNEXIT,DISP=SHR
//         DD DSN=${DB_HLQ}.SDSNLOAD,DISP=SHR
//         DD DSN=${DB_HLQ}.SDSNLOD2,DISP=SHR
//STDOUT   DD   SYSOUT=*
//STDERR   DD   SYSOUT=*
//STDIN    DD   DUMMY
//STDENV   DD   *
_BPX_SHAREAS=YES
JAVA_HOME=${JAVA_HOME}
WLP_USER_DIR=${WLP_USER_DIR}
#JVM_OPTIONS=<Optional JVM parameters>
//*
// PEND
//

Configure security for the server

Perform the statements in the Security setup for the Liberty server chapter.

Start the server

You are now ready to start the server. Issue the following command:

/START ${SERVER_STC_NAME}

Alternatively, you can use the workflow to start the server. The Validate console API sub-step checks whether the user ID running the step is allowed to issue console commands and whether a task with the ${SERVER_STC_NAME} is already running. Afterwards, in the Start server via console sub-step, it issues the START command to the console.

Note: To use that part of the workflow, your userid needs to be enabled to use the console API. The provided workflow is sending console requests to /zosmf/restconsoles/consoles/defcn. This means that the name of the console that is used to issue the command is generated by the REST Console API, by adding CN to the logon user ID.

For example, if user UKOSTC plans to accept the default console name, UKOSTCCN, this user can issue this RACF command to set console attributes for the console:

ADDUSER UKOSTCCN OPERPARM(AUTH(MASTER) ROUTCODE(ALL))

If the user ID is longer than 6 characters, the user ID is truncated. For example, if the user ID is UKORACF, the console name is UKORACFN.

Refer to the z/OSMF documentation for more information on issuing commands from a system console.