diff --git a/CHANGELOG.md b/CHANGELOG.md index 0d76da54..2c002ab7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,11 @@ will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) +## [v5.10.0.9] - 2021-12-13 + +### Changed +- Add alpine, ubuntu and centos dockerfiles to dockerfiles directory for backward comfortability. + ## [v5.10.0.8] - 2021-11-17 ### Changed diff --git a/dockerfiles/alpine/is/Dockerfile b/dockerfiles/alpine/is/Dockerfile new file mode 100755 index 00000000..f4e26b29 --- /dev/null +++ b/dockerfiles/alpine/is/Dockerfile @@ -0,0 +1,97 @@ +# ------------------------------------------------------------------------ +# +# Copyright 2021 WSO2, Inc. (http://wso2.com) +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License +# +# ------------------------------------------------------------------------ + +# set base Docker image to AdoptOpenJDK Alpine Docker image +FROM adoptopenjdk/openjdk11:jdk-11.0.11_9-alpine +LABEL maintainer="WSO2 Docker Maintainers " \ + com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.9" + +# set Docker image build arguments +# build arguments for user/group configurations +ARG USER=wso2carbon +ARG USER_ID=802 +ARG USER_GROUP=wso2 +ARG USER_GROUP_ID=802 +ARG USER_HOME=/home/${USER} +# build arguments for WSO2 product installation +ARG WSO2_SERVER_NAME=wso2is +ARG WSO2_SERVER_VERSION=5.10.0 +ARG WSO2_SERVER_REPOSITORY=product-is +ARG WSO2_SERVER=${WSO2_SERVER_NAME}-${WSO2_SERVER_VERSION} +ARG WSO2_SERVER_HOME=${USER_HOME}/${WSO2_SERVER} +ARG WSO2_SERVER_DIST_URL=https://github.com/wso2/${WSO2_SERVER_REPOSITORY}/releases/download/v${WSO2_SERVER_VERSION}/${WSO2_SERVER}.zip +# build arguments for external artifacts +ARG DNS_JAVA_VERSION=2.1.8 +ARG K8S_MEMBERSHIP_SCHEME_VERSION=1.0.7 +ARG MYSQL_CONNECTOR_VERSION=8.0.17 +# build argument for MOTD +ARG MOTD='printf "\n\ + Welcome to WSO2 Docker Resources \n\ + --------------------------------- \n\ + This Docker container comprises of a WSO2 product, running with its latest GA release \n\ + which is under the Apache License, Version 2.0. \n\ + Read more about Apache License, Version 2.0 here @ http://www.apache.org/licenses/LICENSE-2.0.\n"' +ENV ENV=${USER_HOME}"/.ashrc" + +# create the non-root user and group and set MOTD login message +RUN \ + addgroup -S -g ${USER_GROUP_ID} ${USER_GROUP} \ + && adduser -S -u ${USER_ID} -h ${USER_HOME} -G ${USER_GROUP} ${USER} \ + && echo ${MOTD} > "${ENV}" + +# create Java prefs dir +# this is to avoid warning logs printed by FileSystemPreferences class +RUN \ + mkdir -p ${USER_HOME}/.java/.systemPrefs \ + && mkdir -p ${USER_HOME}/.java/.userPrefs \ + && chmod -R 755 ${USER_HOME}/.java \ + && chown -R ${USER}:${USER_GROUP} ${USER_HOME}/.java + +# copy init script to user home +COPY --chown=wso2carbon:wso2 docker-entrypoint.sh ${USER_HOME}/ + +# install required packages +RUN apk add --no-cache netcat-openbsd + +# add the WSO2 product distribution to user's home directory +RUN \ + wget -O ${WSO2_SERVER}.zip "${WSO2_SERVER_DIST_URL}" \ + && unzip -d ${USER_HOME} ${WSO2_SERVER}.zip \ + && chown wso2carbon:wso2 -R ${WSO2_SERVER_HOME} \ + && rm -f ${WSO2_SERVER}.zip + +# add libraries for Kubernetes membership scheme based clustering +ADD --chown=wso2carbon:wso2 https://repo1.maven.org/maven2/dnsjava/dnsjava/${DNS_JAVA_VERSION}/dnsjava-${DNS_JAVA_VERSION}.jar ${WSO2_SERVER_HOME}/repository/components/lib +ADD --chown=wso2carbon:wso2 http://maven.wso2.org/nexus/content/repositories/releases/org/wso2/carbon/kubernetes/artifacts/kubernetes-membership-scheme/${K8S_MEMBERSHIP_SCHEME_VERSION}/kubernetes-membership-scheme-${K8S_MEMBERSHIP_SCHEME_VERSION}.jar ${WSO2_SERVER_HOME}/repository/components/dropins +# add MySQL JDBC connector to server home as a third party library +ADD --chown=wso2carbon:wso2 https://repo1.maven.org/maven2/mysql/mysql-connector-java/${MYSQL_CONNECTOR_VERSION}/mysql-connector-java-${MYSQL_CONNECTOR_VERSION}.jar ${WSO2_SERVER_HOME}/repository/components/dropins/ + +# set the user and work directory +USER ${USER_ID} +WORKDIR ${USER_HOME} + +# set environment variables +ENV JAVA_OPTS="-Djava.util.prefs.systemRoot=${USER_HOME}/.java -Djava.util.prefs.userRoot=${USER_HOME}/.java/.userPrefs" \ + WORKING_DIRECTORY=${USER_HOME} \ + WSO2_SERVER_HOME=${WSO2_SERVER_HOME} + +# expose ports +EXPOSE 4000 9763 9443 + +# initiate container and start WSO2 Carbon server +ENTRYPOINT ["/home/wso2carbon/docker-entrypoint.sh"] diff --git a/dockerfiles/alpine/is/README.md b/dockerfiles/alpine/is/README.md new file mode 100755 index 00000000..aae0e0cd --- /dev/null +++ b/dockerfiles/alpine/is/README.md @@ -0,0 +1,74 @@ +# Dockerfile for WSO2 Identity Server # + +This section defines the step-by-step instructions to build an [Alpine](https://hub.docker.com/_/alpine/) Linux based Docker image for WSO2 Identity Server 5.10.0. + +## Prerequisites + +* [Docker](https://www.docker.com/get-docker) v17.09.0 or above +* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-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/wso2/docker-is.git +``` + +>The local copy of the `dockerfiles/alpine/is` directory will be referred to as `IS_DOCKERFILE_HOME` from this point onwards. + +##### 2. Build the Docker image. + +- Navigate to `` directory.
+ Execute `docker build` command as shown below. + + `docker build -t wso2is:5.10.0-alpine .` + +> By default, the Docker image will prepackage the General Availability (GA) release version of the relevant WSO2 product. + +##### 3. Running the Docker image. + +- `docker run -it -p 9443:9443 wso2is:5.10.0-alpine` + +>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 console. + +- To access the management console, use the docker host IP and port 9443. + + `https://:9443/carbon` + +>In here, 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 5.10.0 product distribution, `deployment.toml` configuration file
+can be found at `/repository/conf`. Copy the file to some suitable location of the host machine,
+referred to as `/deployment.toml` and change the `[server] -> offset` value to 1. + +##### 2. Grant read permission to `other` users for `/deployment.toml`. + +``` +chmod o+r /deployment.toml +``` + +##### 3. Run the image by mounting the file to container as follows: + +``` +docker run \ +-p 9444:9444 \ +--volume /deployment.toml:/deployment.toml \ +wso2is:5.10.0-alpine +``` + +>In here, refers to /home/wso2carbon/wso2is-5.10.0/repository/conf folder of the container. + +## Docker command usage references + +* [Docker build command reference](https://docs.docker.com/engine/reference/commandline/build/) +* [Docker run command reference](https://docs.docker.com/engine/reference/run/) +* [Dockerfile reference](https://docs.docker.com/engine/reference/builder/) diff --git a/dockerfiles/alpine/is/docker-entrypoint.sh b/dockerfiles/alpine/is/docker-entrypoint.sh new file mode 100755 index 00000000..3d00248e --- /dev/null +++ b/dockerfiles/alpine/is/docker-entrypoint.sh @@ -0,0 +1,36 @@ +#!/bin/sh +# ------------------------------------------------------------------------ +# Copyright 2021 WSO2, Inc. (http://wso2.com) +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License +# ------------------------------------------------------------------------ + +set -e + +# volume mounts +config_volume=${WORKING_DIRECTORY}/wso2-config-volume +artifact_volume=${WORKING_DIRECTORY}/wso2-artifact-volume + +# check if the WSO2 non-root user home exists +test ! -d ${WORKING_DIRECTORY} && echo "WSO2 Docker non-root user home does not exist" && exit 1 + +# check if the WSO2 product home exists +test ! -d ${WSO2_SERVER_HOME} && echo "WSO2 Docker product home does not exist" && exit 1 + +# copy any configuration changes mounted to config_volume +test -d ${config_volume} && [ "$(ls -A ${config_volume})" ] && cp -RL ${config_volume}/* ${WSO2_SERVER_HOME}/ +# copy any artifact changes mounted to artifact_volume +test -d ${artifact_volume} && [ "$(ls -A ${artifact_volume})" ] && cp -RL ${artifact_volume}/* ${WSO2_SERVER_HOME}/ + +# start WSO2 Carbon server +sh ${WSO2_SERVER_HOME}/bin/wso2server.sh "$@" diff --git a/dockerfiles/centos/is/Dockerfile b/dockerfiles/centos/is/Dockerfile new file mode 100755 index 00000000..dd03f426 --- /dev/null +++ b/dockerfiles/centos/is/Dockerfile @@ -0,0 +1,93 @@ +# ------------------------------------------------------------------------ +# +# Copyright 2021 WSO2, Inc. (http://wso2.com) +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License +# +# ------------------------------------------------------------------------ + +# set base Docker image to AdoptOpenJDK CentOS Docker image +FROM adoptopenjdk/openjdk11:x86_64-centos-jdk-11.0.11_9 +LABEL maintainer="WSO2 Docker Maintainers " \ + com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.9" + +# set Docker image build arguments +# build arguments for user/group configurations +ARG USER=wso2carbon +ARG USER_ID=802 +ARG USER_GROUP=wso2 +ARG USER_GROUP_ID=802 +ARG USER_HOME=/home/${USER} +# build arguments for WSO2 product installation +ARG WSO2_SERVER_NAME=wso2is +ARG WSO2_SERVER_VERSION=5.10.0 +ARG WSO2_SERVER_REPOSITORY=product-is +ARG WSO2_SERVER=${WSO2_SERVER_NAME}-${WSO2_SERVER_VERSION} +ARG WSO2_SERVER_HOME=${USER_HOME}/${WSO2_SERVER} +ARG WSO2_SERVER_DIST_URL=https://github.com/wso2/${WSO2_SERVER_REPOSITORY}/releases/download/v${WSO2_SERVER_VERSION}/${WSO2_SERVER}.zip +# build arguments for external artifacts +ARG DNS_JAVA_VERSION=2.1.8 +ARG K8S_MEMBERSHIP_SCHEME_VERSION=1.0.7 +ARG MYSQL_CONNECTOR_VERSION=8.0.17 +# build argument for MOTD +ARG MOTD='printf "\n\ +Welcome to WSO2 Docker resources.\n\ +------------------------------------ \n\ +This Docker container comprises of a WSO2 product, running with its latest GA release \n\ +which is under the Apache License, Version 2.0. \n\ +Read more about Apache License, Version 2.0 here @ http://www.apache.org/licenses/LICENSE-2.0.\n\n"' + +# create the non-root user and group and set MOTD login message +RUN \ + groupadd --system -g ${USER_GROUP_ID} ${USER_GROUP} \ + && useradd --system --create-home --home-dir ${USER_HOME} --no-log-init -g ${USER_GROUP_ID} -u ${USER_ID} ${USER} \ + && echo ${MOTD} > /etc/profile.d/motd.sh + +# copy init script to user home +COPY --chown=wso2carbon:wso2 docker-entrypoint.sh ${USER_HOME}/ + +# install required packages +RUN \ + yum -y update \ + && yum install -y \ + nc \ + unzip \ + wget \ + && rm -rf /var/cache/yum/* + +# add the WSO2 product distribution to user's home directory +RUN \ + wget -O ${WSO2_SERVER}.zip "${WSO2_SERVER_DIST_URL}" \ + && unzip -d ${USER_HOME} ${WSO2_SERVER}.zip \ + && chown wso2carbon:wso2 -R ${WSO2_SERVER_HOME} \ + && rm -f ${WSO2_SERVER}.zip + +# add libraries for Kubernetes membership scheme based clustering +ADD --chown=wso2carbon:wso2 https://repo1.maven.org/maven2/dnsjava/dnsjava/${DNS_JAVA_VERSION}/dnsjava-${DNS_JAVA_VERSION}.jar ${WSO2_SERVER_HOME}/repository/components/lib +ADD --chown=wso2carbon:wso2 http://maven.wso2.org/nexus/content/repositories/releases/org/wso2/carbon/kubernetes/artifacts/kubernetes-membership-scheme/${K8S_MEMBERSHIP_SCHEME_VERSION}/kubernetes-membership-scheme-${K8S_MEMBERSHIP_SCHEME_VERSION}.jar ${WSO2_SERVER_HOME}/repository/components/dropins +# add MySQL JDBC connector to server home as a third party library +ADD --chown=wso2carbon:wso2 https://repo1.maven.org/maven2/mysql/mysql-connector-java/${MYSQL_CONNECTOR_VERSION}/mysql-connector-java-${MYSQL_CONNECTOR_VERSION}.jar ${WSO2_SERVER_HOME}/repository/components/dropins/ + +# set the user and work directory +USER ${USER_ID} +WORKDIR ${USER_HOME} + +# set environment variables +ENV WORKING_DIRECTORY=${USER_HOME} \ + WSO2_SERVER_HOME=${WSO2_SERVER_HOME} + +# expose ports +EXPOSE 4000 9763 9443 + +# initiate container and start WSO2 Carbon server +ENTRYPOINT ["/home/wso2carbon/docker-entrypoint.sh"] diff --git a/dockerfiles/centos/is/README.md b/dockerfiles/centos/is/README.md new file mode 100755 index 00000000..ccf36a47 --- /dev/null +++ b/dockerfiles/centos/is/README.md @@ -0,0 +1,74 @@ +# Dockerfile for WSO2 Identity Server # + +This section defines the step-by-step instructions to build an [CentOS](https://hub.docker.com/_/centos/) Linux based Docker image for WSO2 Identity Server 5.10.0. + +## Prerequisites + +* [Docker](https://www.docker.com/get-docker) v17.09.0 or above +* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-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/wso2/docker-is.git +``` + +>The local copy of the `dockerfiles/centos/is` directory will be referred to as `IS_DOCKERFILE_HOME` from this point onwards. + +##### 2. Build the Docker image. + +- Navigate to `` directory.
+ Execute `docker build` command as shown below. + + `docker build -t wso2is:5.10.0-centos .` + +> By default, the Docker image will prepackage the General Availability (GA) release version of the relevant WSO2 product. + +##### 3. Running the Docker image. + +- `docker run -it -p 9443:9443 wso2is:5.10.0-centos` + +>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 console. + +- To access the management console, use the docker host IP and port 9443. + + `https://:9443/carbon` + +>In here, 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 5.10.0 product distribution, `deployment.toml` configuration file
+can be found at `/repository/conf`. Copy the file to some suitable location of the host machine,
+referred to as `/deployment.toml` and change the `[server] -> offset` value to 1. + +##### 2. Grant read permission to `other` users for `/deployment.toml`. + +``` +chmod o+r /deployment.toml +``` + +##### 3. Run the image by mounting the file to container as follows: + +``` +docker run \ +-p 9444:9444 \ +--volume /deployment.toml:/deployment.toml \ +wso2is:5.10.0-centos +``` + +>In here, refers to /home/wso2carbon/wso2is-5.10.0/repository/conf folder of the container. + +## Docker command usage references + +* [Docker build command reference](https://docs.docker.com/engine/reference/commandline/build/) +* [Docker run command reference](https://docs.docker.com/engine/reference/run/) +* [Dockerfile reference](https://docs.docker.com/engine/reference/builder/) diff --git a/dockerfiles/centos/is/docker-entrypoint.sh b/dockerfiles/centos/is/docker-entrypoint.sh new file mode 100755 index 00000000..3d00248e --- /dev/null +++ b/dockerfiles/centos/is/docker-entrypoint.sh @@ -0,0 +1,36 @@ +#!/bin/sh +# ------------------------------------------------------------------------ +# Copyright 2021 WSO2, Inc. (http://wso2.com) +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License +# ------------------------------------------------------------------------ + +set -e + +# volume mounts +config_volume=${WORKING_DIRECTORY}/wso2-config-volume +artifact_volume=${WORKING_DIRECTORY}/wso2-artifact-volume + +# check if the WSO2 non-root user home exists +test ! -d ${WORKING_DIRECTORY} && echo "WSO2 Docker non-root user home does not exist" && exit 1 + +# check if the WSO2 product home exists +test ! -d ${WSO2_SERVER_HOME} && echo "WSO2 Docker product home does not exist" && exit 1 + +# copy any configuration changes mounted to config_volume +test -d ${config_volume} && [ "$(ls -A ${config_volume})" ] && cp -RL ${config_volume}/* ${WSO2_SERVER_HOME}/ +# copy any artifact changes mounted to artifact_volume +test -d ${artifact_volume} && [ "$(ls -A ${artifact_volume})" ] && cp -RL ${artifact_volume}/* ${WSO2_SERVER_HOME}/ + +# start WSO2 Carbon server +sh ${WSO2_SERVER_HOME}/bin/wso2server.sh "$@" diff --git a/dockerfiles/jdk11/alpine/is/Dockerfile b/dockerfiles/jdk11/alpine/is/Dockerfile index 570e4ffe..6d2e08fe 100755 --- a/dockerfiles/jdk11/alpine/is/Dockerfile +++ b/dockerfiles/jdk11/alpine/is/Dockerfile @@ -19,7 +19,7 @@ # set base Docker image to AdoptOpenJDK Alpine Docker image FROM adoptopenjdk/openjdk11:jdk-11.0.11_9-alpine LABEL maintainer="WSO2 Docker Maintainers " \ - com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.7" + com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.9" # set Docker image build arguments # build arguments for user/group configurations diff --git a/dockerfiles/jdk11/centos/is/Dockerfile b/dockerfiles/jdk11/centos/is/Dockerfile index 10cfcfad..e266ebbb 100755 --- a/dockerfiles/jdk11/centos/is/Dockerfile +++ b/dockerfiles/jdk11/centos/is/Dockerfile @@ -19,7 +19,7 @@ # set base Docker image to AdoptOpenJDK CentOS Docker image FROM adoptopenjdk/openjdk11:x86_64-centos-jdk-11.0.11_9 LABEL maintainer="WSO2 Docker Maintainers " \ - com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.7" + com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.9" # set Docker image build arguments # build arguments for user/group configurations diff --git a/dockerfiles/jdk11/ubuntu/is/Dockerfile b/dockerfiles/jdk11/ubuntu/is/Dockerfile index 6200706d..5766af82 100755 --- a/dockerfiles/jdk11/ubuntu/is/Dockerfile +++ b/dockerfiles/jdk11/ubuntu/is/Dockerfile @@ -19,7 +19,7 @@ # set base Docker image to AdoptOpenJDK Ubuntu Docker image FROM adoptopenjdk:11.0.11_9-jdk-hotspot-focal LABEL maintainer="WSO2 Docker Maintainers " \ - com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.7" + com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.9" # set Docker image build arguments # build arguments for user/group configurations diff --git a/dockerfiles/jdk8/alpine/is/Dockerfile b/dockerfiles/jdk8/alpine/is/Dockerfile index 77a6ec43..8abe1203 100755 --- a/dockerfiles/jdk8/alpine/is/Dockerfile +++ b/dockerfiles/jdk8/alpine/is/Dockerfile @@ -19,7 +19,7 @@ # set base Docker image to AdoptOpenJDK Alpine Docker image FROM adoptopenjdk/openjdk8:jdk8u292-b10-alpine LABEL maintainer="WSO2 Docker Maintainers " \ - com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.8" + com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.9" # set Docker image build arguments # build arguments for user/group configurations diff --git a/dockerfiles/jdk8/centos/is/Dockerfile b/dockerfiles/jdk8/centos/is/Dockerfile index 82723d36..1d3dd600 100755 --- a/dockerfiles/jdk8/centos/is/Dockerfile +++ b/dockerfiles/jdk8/centos/is/Dockerfile @@ -19,7 +19,7 @@ # set base Docker image to AdoptOpenJDK CentOS Docker image FROM adoptopenjdk/openjdk8:jdk8u292-b10-centos LABEL maintainer="WSO2 Docker Maintainers " \ - com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.8" + com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.9" # set Docker image build arguments # build arguments for user/group configurations diff --git a/dockerfiles/jdk8/ubuntu/is/Dockerfile b/dockerfiles/jdk8/ubuntu/is/Dockerfile index e649e686..abfc59f3 100755 --- a/dockerfiles/jdk8/ubuntu/is/Dockerfile +++ b/dockerfiles/jdk8/ubuntu/is/Dockerfile @@ -19,7 +19,7 @@ # set base Docker image to AdoptOpenJDK Ubuntu Docker image FROM adoptopenjdk:8u292-b10-jdk-hotspot-focal LABEL maintainer="WSO2 Docker Maintainers " \ - com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.8" + com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.9" # set Docker image build arguments # build arguments for user/group configurations diff --git a/dockerfiles/ubuntu/is/Dockerfile b/dockerfiles/ubuntu/is/Dockerfile new file mode 100755 index 00000000..547020fd --- /dev/null +++ b/dockerfiles/ubuntu/is/Dockerfile @@ -0,0 +1,102 @@ +# ------------------------------------------------------------------------ +# +# Copyright 2021 WSO2, Inc. (http://wso2.com) +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License +# +# ------------------------------------------------------------------------ + +# set base Docker image to AdoptOpenJDK Ubuntu Docker image +FROM adoptopenjdk:11.0.11_9-jdk-hotspot-focal +LABEL maintainer="WSO2 Docker Maintainers " \ + com.wso2.docker.source="https://github.com/wso2/docker-is/releases/tag/v5.10.0.9" + +# set Docker image build arguments +# build arguments for user/group configurations +ARG USER=wso2carbon +ARG USER_ID=802 +ARG USER_GROUP=wso2 +ARG USER_GROUP_ID=802 +ARG USER_HOME=/home/${USER} +# build arguments for WSO2 product installation +ARG WSO2_SERVER_NAME=wso2is +ARG WSO2_SERVER_VERSION=5.10.0 +ARG WSO2_SERVER_REPOSITORY=product-is +ARG WSO2_SERVER=${WSO2_SERVER_NAME}-${WSO2_SERVER_VERSION} +ARG WSO2_SERVER_HOME=${USER_HOME}/${WSO2_SERVER} +ARG WSO2_SERVER_DIST_URL=https://github.com/wso2/${WSO2_SERVER_REPOSITORY}/releases/download/v${WSO2_SERVER_VERSION}/${WSO2_SERVER}.zip +# build arguments for external artifacts +ARG DNS_JAVA_VERSION=2.1.8 +ARG K8S_MEMBERSHIP_SCHEME_VERSION=1.0.7 +ARG MYSQL_CONNECTOR_VERSION=8.0.17 +# build argument for MOTD +ARG MOTD="\n\ +Welcome to WSO2 Docker resources.\n\ +------------------------------------ \n\ +This Docker container comprises of a WSO2 product, running with its latest GA release \n\ +which is under the Apache License, Version 2.0. \n\ +Read more about Apache License, Version 2.0 here @ http://www.apache.org/licenses/LICENSE-2.0.\n" + +# create the non-root user and group and set MOTD login message +RUN \ + groupadd --system -g ${USER_GROUP_ID} ${USER_GROUP} \ + && useradd --system --create-home --home-dir ${USER_HOME} --no-log-init -g ${USER_GROUP_ID} -u ${USER_ID} ${USER} \ + && echo '[ ! -z "${TERM}" -a -r /etc/motd ] && cat /etc/motd' >> /etc/bash.bashrc; echo "${MOTD}" > /etc/motd + +# create Java prefs dir +# this is to avoid warning logs printed by FileSystemPreferences class +RUN \ + mkdir -p ${USER_HOME}/.java/.systemPrefs \ + && mkdir -p ${USER_HOME}/.java/.userPrefs \ + && chmod -R 755 ${USER_HOME}/.java \ + && chown -R ${USER}:${USER_GROUP} ${USER_HOME}/.java + +# copy init script to user home +COPY --chown=wso2carbon:wso2 docker-entrypoint.sh ${USER_HOME}/ + +# install required packages +RUN \ + apt-get update \ + && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \ + netcat \ + unzip \ + wget \ + && rm -rf /var/lib/apt/lists/* + +# add the WSO2 product distribution to user's home directory +RUN \ + wget -O ${WSO2_SERVER}.zip "${WSO2_SERVER_DIST_URL}" \ + && unzip -d ${USER_HOME} ${WSO2_SERVER}.zip \ + && chown wso2carbon:wso2 -R ${WSO2_SERVER_HOME} \ + && rm -f ${WSO2_SERVER}.zip + +# add libraries for Kubernetes membership scheme based clustering +ADD --chown=wso2carbon:wso2 https://repo1.maven.org/maven2/dnsjava/dnsjava/${DNS_JAVA_VERSION}/dnsjava-${DNS_JAVA_VERSION}.jar ${WSO2_SERVER_HOME}/repository/components/lib +ADD --chown=wso2carbon:wso2 http://maven.wso2.org/nexus/content/repositories/releases/org/wso2/carbon/kubernetes/artifacts/kubernetes-membership-scheme/${K8S_MEMBERSHIP_SCHEME_VERSION}/kubernetes-membership-scheme-${K8S_MEMBERSHIP_SCHEME_VERSION}.jar ${WSO2_SERVER_HOME}/repository/components/dropins +# add MySQL JDBC connector to server home as a third party library +ADD --chown=wso2carbon:wso2 https://repo1.maven.org/maven2/mysql/mysql-connector-java/${MYSQL_CONNECTOR_VERSION}/mysql-connector-java-${MYSQL_CONNECTOR_VERSION}.jar ${WSO2_SERVER_HOME}/repository/components/dropins/ + +# set the user and work directory +USER ${USER_ID} +WORKDIR ${USER_HOME} + +# set environment variables +ENV JAVA_OPTS="-Djava.util.prefs.systemRoot=${USER_HOME}/.java -Djava.util.prefs.userRoot=${USER_HOME}/.java/.userPrefs" \ + WORKING_DIRECTORY=${USER_HOME} \ + WSO2_SERVER_HOME=${WSO2_SERVER_HOME} + +# expose ports +EXPOSE 4000 9763 9443 + +# initiate container and start WSO2 Carbon server +ENTRYPOINT ["/home/wso2carbon/docker-entrypoint.sh"] diff --git a/dockerfiles/ubuntu/is/README.md b/dockerfiles/ubuntu/is/README.md new file mode 100755 index 00000000..68f0129e --- /dev/null +++ b/dockerfiles/ubuntu/is/README.md @@ -0,0 +1,74 @@ +# Dockerfile for WSO2 Identity Server # + +This section defines the step-by-step instructions to build an [Ubuntu](https://hub.docker.com/_/ubuntu/) Linux based Docker image for WSO2 Identity Server 5.10.0. + +## Prerequisites + +* [Docker](https://www.docker.com/get-docker) v17.09.0 or above +* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-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/wso2/docker-is.git +``` + +>The local copy of the `dockerfiles/ubuntu/is` directory will be referred to as `IS_DOCKERFILE_HOME` from this point onwards. + +##### 2. Build the Docker image. + +- Navigate to `` directory.
+ Execute `docker build` command as shown below. + + `docker build -t wso2is:5.10.0 .` + +> By default, the Docker image will prepackage the General Availability (GA) release version of the relevant WSO2 product. + +##### 3. Running the Docker image. + +- `docker run -it -p 9443:9443 wso2is:5.10.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 console. + +- To access the management console, use the docker host IP and port 9443. + + `https://:9443/carbon` + +>In here, 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 5.10.0 product distribution, `deployment.toml` configuration file
+can be found at `/repository/conf`. Copy the file to some suitable location of the host machine,
+referred to as `/deployment.toml` and change the `[server] -> offset` value to 1. + +##### 2. Grant read permission to `other` users for `/deployment.toml`. + +``` +chmod o+r /deployment.toml +``` + +##### 3. Run the image by mounting the file to container as follows: + +``` +docker run \ +-p 9444:9444 \ +--volume /deployment.toml:/deployment.toml \ +wso2is:5.10.0 +``` + +>In here, refers to /home/wso2carbon/wso2is-5.10.0/repository/conf folder of the container. + +## Docker command usage references + +* [Docker build command reference](https://docs.docker.com/engine/reference/commandline/build/) +* [Docker run command reference](https://docs.docker.com/engine/reference/run/) +* [Dockerfile reference](https://docs.docker.com/engine/reference/builder/) diff --git a/dockerfiles/ubuntu/is/docker-entrypoint.sh b/dockerfiles/ubuntu/is/docker-entrypoint.sh new file mode 100755 index 00000000..3d00248e --- /dev/null +++ b/dockerfiles/ubuntu/is/docker-entrypoint.sh @@ -0,0 +1,36 @@ +#!/bin/sh +# ------------------------------------------------------------------------ +# Copyright 2021 WSO2, Inc. (http://wso2.com) +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License +# ------------------------------------------------------------------------ + +set -e + +# volume mounts +config_volume=${WORKING_DIRECTORY}/wso2-config-volume +artifact_volume=${WORKING_DIRECTORY}/wso2-artifact-volume + +# check if the WSO2 non-root user home exists +test ! -d ${WORKING_DIRECTORY} && echo "WSO2 Docker non-root user home does not exist" && exit 1 + +# check if the WSO2 product home exists +test ! -d ${WSO2_SERVER_HOME} && echo "WSO2 Docker product home does not exist" && exit 1 + +# copy any configuration changes mounted to config_volume +test -d ${config_volume} && [ "$(ls -A ${config_volume})" ] && cp -RL ${config_volume}/* ${WSO2_SERVER_HOME}/ +# copy any artifact changes mounted to artifact_volume +test -d ${artifact_volume} && [ "$(ls -A ${artifact_volume})" ] && cp -RL ${artifact_volume}/* ${WSO2_SERVER_HOME}/ + +# start WSO2 Carbon server +sh ${WSO2_SERVER_HOME}/bin/wso2server.sh "$@"