⚠️ DISCLAIMER

These artifacts are built as a reference implementation only developed for research and learning purposes and should not be used in production. You can find a prebuilt docker image of these reference builds for amd64 and arm64 cpu architectures in the dockerhub

---

Changelog

This section defines the deviations in this version from the original Dockerfile implementaion of wso2 identity server Alpine base image.

1. Migration from adoptium temurin jdk 11 to liberica jre 11

This change is done mainly to achieve a smaller Docker image size. Compared to the original implementation, which downloads the binary release of jdk from the adoption GitHub release, this version utilizes the already available liberica-runtime-container. I found open issue #332 and PR #332 that may address some regressions due to not using OS as the base image, but I couldn't find any evidence or reasons why this change was made.

2. Fix for a error warning massage that appears due to not using Location to store java preferences

This also has an open issue #355 and a following #357 which seems to fix the problem but not yet merged. I implemented the same fix here to avoid warning log messages.

3. Some other smaller fixes such as,

• Avoiding legacy backward compatible Alternative syntax of ENV instruction used in the Dockerfile. https://docs.docker.com/reference/dockerfile/#env
• Avoid setting JAVA_HOME & PATH Environment variables since the base image already correctly sets those variables.
• Removing k8 membership scheme as mentioned in the #403
• Removing preinstalled packages such as wget, unzip, and netcat-openbsd. I could not find any use case for these packages other than for downloading and extracting the IS server ZIP file.

Todo

• Test whether use of liberica runtime image cause any regressions.
• Provide a seperate image with JDK and other OS base images provided by liberica

Dockerfile for WSO2 Identity Server

This section defines the step-by-step instructions to build an liberica-runtime-container based Docker image for WSO2 Identity Server 7.0.0.

Prerequisites

• Docker v17.09.0 or above
• Git client

How to build an image and run

1. Checkout this repository into your local machine using the following Git client command.

git clone https://github.com/iamtrazy/wso2is-docker.git

2. Build the Docker image.

• Navigate to cloned repository directory.
  Execute docker build command as shown below.
  • docker build -t wso2is:7.0.0 .

Tip - If you require the container to run with a different UID and GID, pass the preferred values of the UID and GID as values for build arguments USER_ID and USER_GROUP_ID when building the image, as shown below. Note that setting lower values for the UID and GID is not recommended.

• docker build -t wso2is:7.0.0 --build-arg USER_ID=<UID> --build-arg USER_GROUP_ID=<GID> .

3. Running the Docker image.

• docker run -it -p 9443:9443 wso2is:7.0.0

Here, only port 9443 (HTTPS servlet transport) has been mapped to a Docker host port. You may map other container service ports, which have been exposed to Docker host ports, as desired.

4. Accessing management consoles.

• To access the user interfaces, use the docker host IP and port 9443.
  • Management Console: https://<DOCKER_HOST>:9443/console
  • User Portal: https://<DOCKER_HOST>:9443/myaccount

In here, <DOCKER_HOST> refers to hostname or IP of the host machine on top of which containers are spawned.

How to update configurations

Configurations would lie on the Docker host machine and they can be volume mounted to the container.
As an example, steps required to change the port offset using deployment.toml is as follows:

1. Stop the Identity Server container if it's already running.

In WSO2 Identity Server version 7.0.0 product distribution, deployment.toml configuration file
can be found at <DISTRIBUTION_HOME>/repository/conf. Copy the file to some suitable location of the host machine,
referred to as <SOURCE_CONFIGS>/deployment.toml and change the [server] -> offset value to 1.

2. Grant read permission to other users for <SOURCE_CONFIGS>/deployment.toml.

chmod o+r <SOURCE_CONFIGS>/deployment.toml

3. Run the image by mounting the file to container as follows:

docker run \
-p 9444:9444 \
--volume <SOURCE_CONFIGS>/deployment.toml:<TARGET_CONFIGS>/deployment.toml \
wso2is:7.0.0

In here, <TARGET_CONFIGS> refers to /home/wso2carbon/wso2is-7.0.0/repository/conf folder of the container.

Docker command usage references

• Docker build command reference
• Docker run command reference
• Dockerfile reference