+

Search Tips   |   Advanced Search

Set variables for Liberty servers

We must set one or more WebSphere variables before we can use the job manager to remotely install and manage Liberty servers. We can set the variables in an administrative console, a wsadmin script, or the registerHost command. The variables specify the root directories to which to install Liberty resources and specify search paths for finding resources that are not yet registered with the job manager.

Liberty resources include projects, software development kits (Java runtime environments), Liberty runtimes, servers, and applications. See Liberty resources.

If we are using an administrative console, wsadmin, or the registerHost command to set values for Liberty server variables, start the job manager or the deployment manager.

We can specify values for WebSphere variables and built-in variables.

WebSphere variables

Before installing Liberty resources using the job manager, we must set one or more WebSphere variables. The amount of configuration depends on the topology being deployed. We can set values for variables using the job manager console, deployment manager console, wsadmin, or registerHost command.

We can install Liberty resources to a working, non-shared location or to a shared location. Do not share resources installed to the working location.

Resources installed to a shared location can be used by Liberty servers installed to a working location. For example, we can configure working Liberty servers to use one or more of the following types of shared resources:

  • Liberty runtime
  • Software development kit
  • Application

Install resources in shared locations as read-only. We can share resources within a host or across hosts using disk sharing approaches such as Network File System (NFS).

During resource installation, unless there is a name conflict, the resources in the Liberty compressed file are extracted to the working root directory specified by WLP_WORKING_DIR or to the shared directory specified by WLP_SHARED_DIR.

Default variables Description
WLP_WORKING_DIR The installation or inventory search path for nonshared working Liberty resources. If a job submission does not specify that the installation or search directory be shared, then the job uses this variable. By default, Liberty resources are installed to the nonshared working directory that this variable defines.

Specify an absolute path for this variable. Do not specify a relative path.

WLP_SHARED_DIR The installation or inventory search path for shared Liberty resources. If a job submission specifies that the installation or search directory be shared, then the job uses this variable.

Specify an absolute path for this variable. Do not specify a relative path.

WLP_ADDITIONAL_DIRS (optional) Specifies additional paths to search for Liberty resources beyond the paths included in the WLP_SHARED_DIR and WLP_WORKING_DIR variables.

We must configure the additional search paths for Liberty resources to:

  • Search for previously installed software development kits that are managed separately from the job manager.
  • Search for any server resources that are not installed in the default working and shared directories. For example, we might define different installation locations relative to the home directories of several different users. See descriptions of the HOME and USER variables.

Specify an absolute path for this variable. Do not specify a relative path.

Built-in variables

When we use the job manager to remotely install and manage Liberty servers, we can set the following built-in variables to customize installation locations and Liberty configuration files based on operating system home directory, operating system user, host name, and project membership:

HOME

Contains the home directory of the operating system user name used to submit an Install Liberty resources job. Use the HOME variable to set up a working directory that is relative to the home directory of the submitting user; for example:
WLP_WORKING_DIR=${HOME}/working

USER

Contains the name of the operating system user used to submit an Install Liberty resources job. Use the USER variable to set up a working directory for each user, relative to a global directory; for example:
WLP_WORKING_DIR=/working/${USER}

When using the HOME variable or the USER variable to customize the installation location, we must configure the WLP_ADDITIONAL_DIRS variable with the specific directories for each user; for example:

WLP_ADDITIONAL_DIRS=/usr/home/user1;/usr/home/user2

If we do not include the directories in the WLP_ADDITIONAL_DIRS variable, inventory jobs do not locate the associated Liberty resources on the target hosts.

HOSTNAME

Contains the configured host name of the target host where an Install Liberty resources job is run. Use the HOSTNAME variable in the server bootstrap.properties file; for example:
hostname=${HOSTNAME}

We can then use the hostname variable in the server configuration file, server.xml; for example:

<httpEndpoint host="${hostname}" httpPort="9081" httpsPort="9444" id="defaultHttpEndpoint"/>

CURRENT_PROJECT

Contains the name of the project that is included in the Liberty resources compressed file.


Tasks

We can set WebSphere variables for all target hosts at a specified scope or set WebSphere variables at a target host level.

After we save the changes, the changes are viewable in the list of variables on a console WebSphere variables page.

After we have defined the variables, see Packaging Liberty resources for information on how to properly package files for the Install Liberty resources job. If we use Installation Manager to install Liberty, create a subdirectory under the location of WLP_WORKING_DIR. This directory will be used to identify this instance of the Liberty runtime. Use this directory as the installation directory during installation with Installation Manager. If WLP_WORKING_DIR is set to /liberty/working, for example, create a runtime_1 subdirectory; then, use /liberty/working/runtime_1 as the installation directory during installation using Installation Manager.


What to do next

We can now submit a job that installs resources from a Liberty resources compressed file, as well as an inventory job that searches for previously existing Liberty resources.

We can later set variables that override the values of variables for different target hosts or substitute user-defined variables:


Related:

  • Liberty resources
  • Submitting jobs to deploy and manage Liberty installations
  • Registering host computers with job managers
  • Install Liberty resources using the job manager
  • Start and stop the job manager
  • Packaging Liberty resources
  • Administrative job types