websphere-liberty

Estimated reading time: 9 minutes

Official IBM WebSphere Application Server for Developers Liberty image.

GitHub repo: https://github.com/WASdev/ci.docker

Library reference

This content is imported from the official Docker Library docs, and is provided by the original uploader. You can view the Docker Store page for this image at https://store.docker.com/images/websphere-liberty

Supported tags and respective Dockerfile links

Quick reference

Overview

The images in this repository contain IBM WebSphere Application Server Liberty for Developers and the IBM Java Runtime Environment. See the license section below for restrictions relating to the use of this image. For more information about WebSphere Application Server Liberty, see the WASdev site.

Images

There are multiple images available in this repository. The image with the tag beta contains the contents of the install archive for the latest monthly beta. The other images are all based on the latest generally available fix pack.

The kernel image contains just the Liberty kernel and no additional runtime features. This image can be used as the basis for custom built images that contain only the features required for a specific application. For example, the following Dockerfile starts with this image, copies in the server.xml that lists the features required by the application, and then uses the installUtility command to download those features from the online repository.

FROM websphere-liberty:kernel
COPY server.xml /config/
RUN installUtility install --acceptLicense defaultServer

The webProfile6 image contains the features required for Java EE6 Web Profile compliance. It also pulls in additional features to bring the contents in to line with the features available for download by using the runtime JAR, most notably the features required for OSGi applications.

The webProfile7 image contains the features required for Java EE7 Web Profile compliance. The javaee7 image extends this image and adds the features required for Java EE7 Full Platform compliance. The javaee7 image is also tagged with latest.

The webProfile6, webProfile7 and javaee7 images all also contain a common set of features that are expected to be of use for a typical production scenario. These features are: appSecurity-2.0, collectiveMember-1.0, localConnector-1.0, ldapRegistry-3.0, monitor-1.0, requestTiming-1.0, restConnector-1.0, sessionDatabase-1.0, ssl-1.0, and webCache-1.0.

Usage

The images are designed to support a number of different usage patterns. The following examples are based on the Java EE7 Liberty application deployment sample and assume that DefaultServletEngine.zip has been extracted to /tmp and the server.xml updated to accept HTTP connections from outside of the container by adding the following element inside the server stanza:

<httpEndpoint host="*" httpPort="9080" httpsPort="-1"/>

  1. Each image contains a default server configuration that specifies the corresponding features and exposes ports 9080 and 9443 for HTTP and HTTPS respectively. A .WAR file can therefore be mounted in the dropins directory of this server and run. The following example starts a container in the background running a .WAR file from the host file system with the HTTP and HTTPS ports mapped to 80 and 443 respectively.

    $ docker run -d -p 80:9080 -p 443:9443 \
    -v /tmp/DefaultServletEngine/dropins/Sample1.war:/config/dropins/Sample1.war \
    websphere-liberty:webProfile7

    When the server is started, you can browse to http://localhost/Sample1/SimpleServlet on the Docker host.

    Note: If you are using the boot2docker virtual machine on OS X or Windows, you need to get the IP of the virtual host by using the command boot2docker ip instead of by using localhost.

  2. For greater flexibility over configuration, it is possible to mount an entire server configuration directory from the host and then specify the server name as a parameter to the run command. Note: This particular example server configuration provides only HTTP access.

    $ docker run -d -p 80:9080 \
  -v /tmp/DefaultServletEngine:/config \
  websphere-liberty:webProfile7

  3. You can also build an application layer on top of this image by using either the default server configuration or a new server configuration. In this example, we have copied the Sample1.war from /tmp/DefaultServletEngine/dropins to the same directory as the following Dockerfile.

    FROM websphere-liberty:webProfile7
ADD Sample1.war /config/dropins/

    This can then be built and run as follows:

    $ docker build -t app .
$ docker run -d -p 80:9080 -p 443:9443 app

  4. You can mount a data volume container that contains the application and the server configuration on to the image. This has the benefit that it has no dependency on files from the host but still allows the application container to be easily re-mounted on a newer version of the application server image. This example assumes that you have copied the /tmp/DefaultServletEngine directory in to the same directory as the Dockerfile.

    Build and run the data volume container:

    FROM websphere-liberty:webProfile7
ADD DefaultServletEngine /config

    $ docker build -t app-image .
$ docker run -d -v /config \
    --name app app-image true

    Run the WebSphere Liberty image with the volumes from the data volume container mounted:

    $ docker run -d -p 80:9080 \
  --volumes-from app websphere-liberty:webProfile7

Using IBM JRE Class data sharing

The IBM JRE provides a feature Class data sharing which offers transparent and dynamic sharing of data between multiple Java Virtual Machines running on the same host by using shared memory backed by a file. When running the Liberty Docker image, it looks for the file at /opt/ibm/wlp/output/.classCache. To benefit from Class data sharing, this location needs to be shared between containers either through the host or a data volume container.

Taking the application image from example 3 above, containers can share the host file location (containing the shared cache) /tmp/websphere-liberty/classCache as follows:

docker run -d -p 80:9080 -p 443:9443 \
    -v /tmp/websphere-liberty/classCache:/opt/ibm/wlp/output/.classCache app

Or, create a named data volume container that exposes a volume at the location of the shared file:

docker run -e LICENSE=accept -v /opt/ibm/wlp/output/.classCache \
    --name classcache websphere-liberty true

Then, run the WebSphere Liberty image with the volumes from the data volume container classcache mounted as follows:

docker run -d -p 80:9080 -p 443:9443 --volumes-from classcache app

Running WebSphere Liberty in read-only mode

Liberty writes to two different directories when running: /opt/ibm/wlp/output and /logs. In order to run the Liberty image in read-only mode these may be mounted as temporary file systems. If using the provided image, the keystore will be generated on initial start up in the server configuration. This means that the server configuration directory either needs to be read-write or the keystore will need to be built into the image. In the example command /config is mounted as a read-write volume.

docker run -d -p 80:9080 -p 443:9443 \
    --tmpfs /opt/ibm/wlp/output --tmpfs /logs -v /config --read-only \
    websphere-liberty:javaee7

Changing locale

The base Ubuntu image does not include additional language packs. To use an alternative locale, build your own image that installs the required language pack and then sets the LANG environment variable. For example, the following Dockerfile starts with the websphere-liberty:webProfile7 image, installs the Portuguese language pack, and sets Brazilian Portuguese as the default locale:

FROM websphere-liberty:webProfile7
RUN apt-get update \
  && apt-get install -y language-pack-pt-base \
  && rm -rf /var/lib/apt/lists/*
ENV LANG pt_BR.UTF-8

License

The Dockerfiles and associated scripts are licensed under the Apache License 2.0.

Licenses for the products installed within the images are as follows:

Note: These licenses do not permit further distribution and that the terms for WebSphere Application Server in the non-beta images restrict usage to a developer machine or build server only, or subject to a maximum 2 gigabyte heap usage across all instances. Instructions are available to enable entitled customers to upgrade the Docker Hub image for production use or build their own production licensed image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in the repo-info repository’s websphere-liberty/ directory.

As for any pre-built image usage, it is the image user’s responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

library, sample, websphere-liberty