Add defaultServer name change feature

README.md

@@ -39,6 +39,9 @@ Your application image template should follow a pattern similar to:
 ```dockerfile
 FROM icr.io/appcafe/open-liberty:kernel-slim-java8-openj9-ubi
 
+# Modify the server name (optional)
+ENV SERVER_NAME=liberty1
+
 # Add Liberty server configuration including all necessary features
 COPY --chown=1001:0  server.xml /config/
 
@@ -78,14 +81,20 @@ Refer to [Repository and proxy modifications](https://openliberty.io/docs/ref/co
 
 ## Enterprise Functionality
 
-This section describes the optional enterprise functionality that can be enabled via the Dockerfile during `build` time, by setting particular build-arguments (`ARG`) and calling `RUN configure.sh`.  Each of these options trigger the inclusion of specific configuration via XML snippets (except for `VERBOSE`), described below:
+This section describes the optional enterprise functionality that can be enabled via the Dockerfile during `build` time, by setting particular build-arguments (`ARG`) and calling `RUN configure.sh`.  Each of these options trigger the inclusion of specific configuration via XML snippets (except for `SERVER_NAME` and `VERBOSE`), described below:
 
 * `TLS` (`SSL` is deprecated)
   *  Description: Enable Transport Security in Liberty by adding the `transportSecurity-1.0` feature (includes support for SSL).
   *  XML Snippet Location:  [keystore.xml](/releases/latest/kernel-slim/helpers/build/configuration_snippets/keystore.xml).
 * `HZ_SESSION_CACHE`
   *  Description: Enable the persistence of HTTP sessions using JCache by adding the `sessionCache-1.0` feature.
   *  XML Snippet Location: [hazelcast-sessioncache.xml](/releases/latest/kernel-slim/helpers/build/configuration_snippets/hazelcast-sessioncache.xml)
+* `SERVER_NAME`
+  * Description: A name for the server. If no server is specified, a server called `defaultServer` is automatically created.
+  * Naming constraints:
+    * Use only Unicode alphanumeric (e.g. 0-9, a-z, A-Z), underscore (_), dash (-), plus (+), and period (.) characters.
+    * Do not begin the name with a dash (-) or a period (.).
+    * Be aware that your file system, operating system, or compressed file directory might impose more restrictions.
 * `VERBOSE`
   *  Description: When set to `true` it outputs the commands and results to stdout from `configure.sh`. Otherwise, default setting is `false` and `configure.sh` is silenced.
 

docs/README.md

@@ -6,3 +6,4 @@ This directory contains a number of useful guides.
 
 * [Where to get Open Liberty container images](./icr-images.md)
 * [How to Create a Multi-Arch Image](./multi-arch-images.md)
+* [How to customize your Liberty server](./liberty-server-customization.md)

docs/liberty-server-customization.md

@@ -0,0 +1,90 @@
+
+# How to customize your Liberty Server
+
+## Provide a custom server name
+
+You can provide a custom name for your Liberty server by specifying the `SERVER_NAME` environment variable at container image **build-time**.
+
+### Building from a new image
+
+Specifying the `ENV SERVER_NAME=<your-server-name>` variable allows you to run a Liberty server with a custom name, as in the Dockerfile below.
+```Dockerfile
+FROM openliberty/open-liberty:kernel-slim-java17-openj9-ubi
+
+ENV SERVER_NAME=liberty1
+
+RUN features.sh
+
+RUN configure.sh
+```
+Running this container will produce output similar to:
+```
+Launching liberty1 (Open Liberty 23.0.0.5/wlp-1.0.77.cl230520230514-1901) on Eclipse OpenJ9 VM, version 17.0.7+7 (en_US)
+[AUDIT   ] CWWKE0001I: The server liberty1 has been launched.
+[AUDIT   ] CWWKG0093A: Processing configuration drop-ins resource: /opt/ol/wlp/usr/servers/liberty1/configDropins/defaults/keystore.xml
+[AUDIT   ] CWWKG0093A: Processing configuration drop-ins resource: /opt/ol/wlp/usr/servers/liberty1/configDropins/defaults/open-default-port.xml
+[AUDIT   ] CWWKZ0058I: Monitoring dropins for applications.
+[AUDIT   ] CWWKF0012I: The server installed the following features: [el-3.0, jsp-2.3, servlet-3.1].
+[AUDIT   ] CWWKF0011I: The liberty1 server is ready to run a smarter planet. The liberty1 server started in 0.730 seconds.
+```
+
+### Renaming an existing Liberty server
+
+Liberty server configurations and existing output data under `/config` and `/output`, respectively, will be relocated to the server with new name, allowing you to **rename** servers `FROM` any Liberty image.
+
+```Dockerfile
+FROM openliberty/open-liberty:kernel-slim-java17-openj9-ubi as staging
+
+ENV SERVER_NAME=liberty1
+
+# Initialize server configuration
+COPY --chown=1001:0  server.xml /config/
+
+RUN features.sh
+
+RUN configure.sh
+
+# From an existing Liberty server
+FROM staging
+
+# Rename liberty1 to liberty2, retaining /config/server.xml from above
+ENV SERVER_NAME=liberty2
+
+RUN features.sh
+
+RUN configure.sh
+```
+
+### Renaming a Liberty server using Liberty InstantOn
+
+To rename a Liberty server using Liberty InstantOn, include the `SERVER_NAME` environment variable before configuring the image.
+
+```Dockerfile
+FROM icr.io/appcafe/open-liberty:beta-instanton
+
+ENV SERVER_NAME=liberty-instanton
+
+COPY --chown=1001:0 src/main/liberty/config/ /config/
+COPY --chown=1001:0 target/*.war /config/apps/
+
+RUN configure.sh
+RUN checkpoint.sh applications
+```
+Running this container will produce output similar to:
+```
+[AUDIT   ] Launching liberty-instanton (Open Liberty 23.0.0.6-beta/wlp-1.0.77.cl230520230514-1901) on Eclipse OpenJ9 VM, version 17.0.7+7 (en_US)
+[AUDIT   ] CWWKC0452I: The Liberty server process resumed operation from a checkpoint in 0.126 seconds.
+[AUDIT   ] CWWKF0012I: The server installed the following features: [checkpoint-1.0].
+[AUDIT   ] CWWKF0011I: The liberty-instanton server is ready to run a smarter planet. The liberty-instanton server started in 0.130 seconds.
+```
+
+### Notes
+
+The new server name changes the directory of stored configurations and server output. For example, for a custom server name `liberty1`.
+- `/config -> /opt/ol/wlp/usr/servers/liberty1`
+- `/output -> /opt/ol/wlp/output/liberty1`
+
+By using the symbolic links `/config` and `/output`, you can always ensure a correct mapping to the Liberty server's directories. 
+
+
+

releases/23.0.0.3/full/Dockerfile.ubi.ibmjava8

@@ -9,6 +9,8 @@ ARG LIBERTY_DOWNLOAD_URL=https://repo1.maven.org/maven2/io/openliberty/openliber
 ARG OPENJ9_SCC=true
 ARG VERBOSE=false
 
+ENV SERVER_NAME=defaultServer
+
 LABEL org.opencontainers.image.authors="Arthur De Magalhaes, Chris Potter, Leo Christy Jesuraj" \
       org.opencontainers.image.vendor="Open Liberty" \
       org.opencontainers.image.url="https://openliberty.io/" \
@@ -56,17 +58,8 @@ RUN /opt/ol/wlp/bin/server create --template=javaee8 \
 RUN mkdir /logs \
     && mkdir -p /opt/ol/wlp/usr/shared/resources/lib.index.cache \
     && ln -s /opt/ol/wlp/usr/shared/resources/lib.index.cache /lib.index.cache \
-    && mkdir -p $WLP_OUTPUT_DIR/defaultServer \
-    && ln -s $WLP_OUTPUT_DIR/defaultServer /output \
-    && ln -s /opt/ol/wlp/usr/servers/defaultServer /config \
-    && mkdir -p /config/configDropins/defaults \
-    && mkdir -p /config/configDropins/overrides \
-    && mkdir -p /config/dropins \
-    && mkdir -p /config/apps \
     && ln -s /opt/ol/wlp /liberty \
     && ln -s /opt/ol/fixes /fixes \
-    && chown -R 1001:0 /config \
-    && chmod -R g+rw /config \
     && chown -R 1001:0 /logs \
     && chmod -R g+rw /logs \
     && chown -R 1001:0 /opt/ol/wlp/usr \
@@ -80,15 +73,43 @@ RUN mkdir /logs \
     && mkdir /etc/wlp \
     && chown -R 1001:0 /etc/wlp \
     && chmod -R g+rw /etc/wlp \
-    && echo "<server description=\"Default Server\"><httpEndpoint id=\"defaultHttpEndpoint\" host=\"*\" /></server>" > /config/configDropins/defaults/open-default-port.xml
+    && mkdir -p /opt/ol/links \
+    && chown -R 1001:0 /opt/ol/links \
+    && chmod -R g+rw /opt/ol/links
+
+# Create second-level symlinks as non-root user
+USER 1001
+
+RUN mkdir -p $WLP_OUTPUT_DIR/defaultServer \
+    && ln -s $WLP_OUTPUT_DIR/defaultServer /opt/ol/links/output \
+    && ln -s /opt/ol/wlp/usr/servers/defaultServer /opt/ol/links/config \
+    && mkdir -p /opt/ol/links/config/configDropins/defaults \
+    && mkdir -p /opt/ol/links/config/configDropins/overrides \
+    && mkdir -p /opt/ol/links/config/dropins \
+    && mkdir -p /opt/ol/links/config/apps \
+    && echo "<server description=\"Default Server\"><httpEndpoint id=\"defaultHttpEndpoint\" host=\"*\" /></server>" > /opt/ol/links/config/configDropins/defaults/open-default-port.xml
+
+# Create first-level symlinks as root user
+USER root
+
+RUN ln -s /opt/ol/links/output /output \
+    && ln -s /opt/ol/links/config /config \
+    && chown -R 1001:0 /opt/ol/links/output \
+    && chmod -R g+rw /opt/ol/links/output \
+    && chown -R 1001:0 /opt/ol/links/config \
+    && chmod -R g+rw /opt/ol/links/config \
+    && chown -R 1001:0 /config \
+    && chmod -R g+rw /config \
+    && chown -R 1001:0 /output \
+    && chmod -R g+rw /output
 
 # Create a new SCC layer
 RUN if [ "$OPENJ9_SCC" = "true" ]; then populate_scc.sh; fi \
     && rm -rf /output/messaging /output/resources/security /logs/* $WLP_OUTPUT_DIR/.classCache \
     && chown -R 1001:0 /opt/ol/wlp/output \
     && chmod -R g+rwx /opt/ol/wlp/output
 
-#These settings are needed so that we can run as a different user than 1001 after server warmup
+# These settings are needed so that we can run as a different user than 1001 after server warmup
 ENV RANDFILE=/tmp/.rnd \
     IBM_JAVA_OPTIONS="-Xshareclasses:name=liberty,readonly,nonfatal,cacheDir=/output/.classCache/ -Dosgi.checkConfiguration=false ${IBM_JAVA_OPTIONS}"
 
@@ -97,4 +118,4 @@ USER 1001
 EXPOSE 9080 9443
 
 ENTRYPOINT ["/opt/ol/helpers/runtime/docker-server.sh"]
-CMD ["/opt/ol/wlp/bin/server", "run", "defaultServer"]
+CMD ["/opt/ol/wlp/bin/server", "run"]

releases/23.0.0.3/full/Dockerfile.ubi.openjdk11

@@ -9,6 +9,8 @@ ARG LIBERTY_DOWNLOAD_URL=https://repo1.maven.org/maven2/io/openliberty/openliber
 ARG OPENJ9_SCC=true
 ARG VERBOSE=false
 
+ENV SERVER_NAME=defaultServer
+
 LABEL org.opencontainers.image.authors="Arthur De Magalhaes, Chris Potter, Leo Christy Jesuraj" \
       org.opencontainers.image.vendor="Open Liberty" \
       org.opencontainers.image.url="https://openliberty.io/" \
@@ -56,17 +58,8 @@ RUN /opt/ol/wlp/bin/server create --template=javaee8 \
 RUN mkdir /logs \
     && mkdir -p /opt/ol/wlp/usr/shared/resources/lib.index.cache \
     && ln -s /opt/ol/wlp/usr/shared/resources/lib.index.cache /lib.index.cache \
-    && mkdir -p $WLP_OUTPUT_DIR/defaultServer \
-    && ln -s $WLP_OUTPUT_DIR/defaultServer /output \
-    && ln -s /opt/ol/wlp/usr/servers/defaultServer /config \
-    && mkdir -p /config/configDropins/defaults \
-    && mkdir -p /config/configDropins/overrides \
-    && mkdir -p /config/dropins \
-    && mkdir -p /config/apps \
     && ln -s /opt/ol/wlp /liberty \
     && ln -s /opt/ol/fixes /fixes \
-    && chown -R 1001:0 /config \
-    && chmod -R g+rw /config \
     && chown -R 1001:0 /logs \
     && chmod -R g+rw /logs \
     && chown -R 1001:0 /opt/ol/wlp/usr \
@@ -80,15 +73,43 @@ RUN mkdir /logs \
     && mkdir /etc/wlp \
     && chown -R 1001:0 /etc/wlp \
     && chmod -R g+rw /etc/wlp \
-    && echo "<server description=\"Default Server\"><httpEndpoint id=\"defaultHttpEndpoint\" host=\"*\" /></server>" > /config/configDropins/defaults/open-default-port.xml
+    && mkdir -p /opt/ol/links \
+    && chown -R 1001:0 /opt/ol/links \
+    && chmod -R g+rw /opt/ol/links
+
+# Create second-level symlinks as non-root user
+USER 1001
+
+RUN mkdir -p $WLP_OUTPUT_DIR/defaultServer \
+    && ln -s $WLP_OUTPUT_DIR/defaultServer /opt/ol/links/output \
+    && ln -s /opt/ol/wlp/usr/servers/defaultServer /opt/ol/links/config \
+    && mkdir -p /opt/ol/links/config/configDropins/defaults \
+    && mkdir -p /opt/ol/links/config/configDropins/overrides \
+    && mkdir -p /opt/ol/links/config/dropins \
+    && mkdir -p /opt/ol/links/config/apps \
+    && echo "<server description=\"Default Server\"><httpEndpoint id=\"defaultHttpEndpoint\" host=\"*\" /></server>" > /opt/ol/links/config/configDropins/defaults/open-default-port.xml
+
+# Create first-level symlinks as root user
+USER root
+
+RUN ln -s /opt/ol/links/output /output \
+    && ln -s /opt/ol/links/config /config \
+    && chown -R 1001:0 /opt/ol/links/output \
+    && chmod -R g+rw /opt/ol/links/output \
+    && chown -R 1001:0 /opt/ol/links/config \
+    && chmod -R g+rw /opt/ol/links/config \
+    && chown -R 1001:0 /config \
+    && chmod -R g+rw /config \
+    && chown -R 1001:0 /output \
+    && chmod -R g+rw /output
 
 # Create a new SCC layer
 RUN if [ "$OPENJ9_SCC" = "true" ]; then populate_scc.sh; fi \
     && rm -rf /output/messaging /output/resources/security /logs/* $WLP_OUTPUT_DIR/.classCache \
     && chown -R 1001:0 /opt/ol/wlp/output \
     && chmod -R g+rwx /opt/ol/wlp/output
 
-#These settings are needed so that we can run as a different user than 1001 after server warmup
+# These settings are needed so that we can run as a different user than 1001 after server warmup
 ENV RANDFILE=/tmp/.rnd \
     OPENJ9_JAVA_OPTIONS="-XX:+IgnoreUnrecognizedVMOptions -XX:+IdleTuningGcOnIdle -Xshareclasses:name=openj9_system_scc,cacheDir=/opt/java/.scc,readonly,nonFatal -Dosgi.checkConfiguration=false"
 
@@ -97,4 +118,4 @@ USER 1001
 EXPOSE 9080 9443
 
 ENTRYPOINT ["/opt/ol/helpers/runtime/docker-server.sh"]
-CMD ["/opt/ol/wlp/bin/server", "run", "defaultServer"]
+CMD ["/opt/ol/wlp/bin/server", "run"]

releases/23.0.0.3/full/Dockerfile.ubi.openjdk17

@@ -9,6 +9,8 @@ ARG LIBERTY_DOWNLOAD_URL=https://repo1.maven.org/maven2/io/openliberty/openliber
 ARG OPENJ9_SCC=true
 ARG VERBOSE=false
 
+ENV SERVER_NAME=defaultServer
+
 LABEL org.opencontainers.image.authors="Chris Potter, Leo Christy Jesuraj, Melissa Lee" \
       org.opencontainers.image.vendor="Open Liberty" \
       org.opencontainers.image.url="https://openliberty.io/" \
@@ -56,17 +58,8 @@ RUN /opt/ol/wlp/bin/server create --template=javaee8 \
 RUN mkdir /logs \
     && mkdir -p /opt/ol/wlp/usr/shared/resources/lib.index.cache \
     && ln -s /opt/ol/wlp/usr/shared/resources/lib.index.cache /lib.index.cache \
-    && mkdir -p $WLP_OUTPUT_DIR/defaultServer \
-    && ln -s $WLP_OUTPUT_DIR/defaultServer /output \
-    && ln -s /opt/ol/wlp/usr/servers/defaultServer /config \
-    && mkdir -p /config/configDropins/defaults \
-    && mkdir -p /config/configDropins/overrides \
-    && mkdir -p /config/dropins \
-    && mkdir -p /config/apps \
     && ln -s /opt/ol/wlp /liberty \
     && ln -s /opt/ol/fixes /fixes \
-    && chown -R 1001:0 /config \
-    && chmod -R g+rw /config \
     && chown -R 1001:0 /logs \
     && chmod -R g+rw /logs \
     && chown -R 1001:0 /opt/ol/wlp/usr \
@@ -80,15 +73,43 @@ RUN mkdir /logs \
     && mkdir /etc/wlp \
     && chown -R 1001:0 /etc/wlp \
     && chmod -R g+rw /etc/wlp \
-    && echo "<server description=\"Default Server\"><httpEndpoint id=\"defaultHttpEndpoint\" host=\"*\" /></server>" > /config/configDropins/defaults/open-default-port.xml
+    && mkdir -p /opt/ol/links \
+    && chown -R 1001:0 /opt/ol/links \
+    && chmod -R g+rw /opt/ol/links
+
+# Create second-level symlinks as non-root user
+USER 1001
+
+RUN mkdir -p $WLP_OUTPUT_DIR/defaultServer \
+    && ln -s $WLP_OUTPUT_DIR/defaultServer /opt/ol/links/output \
+    && ln -s /opt/ol/wlp/usr/servers/defaultServer /opt/ol/links/config \
+    && mkdir -p /opt/ol/links/config/configDropins/defaults \
+    && mkdir -p /opt/ol/links/config/configDropins/overrides \
+    && mkdir -p /opt/ol/links/config/dropins \
+    && mkdir -p /opt/ol/links/config/apps \
+    && echo "<server description=\"Default Server\"><httpEndpoint id=\"defaultHttpEndpoint\" host=\"*\" /></server>" > /opt/ol/links/config/configDropins/defaults/open-default-port.xml
+
+# Create first-level symlinks as root user
+USER root
+
+RUN ln -s /opt/ol/links/output /output \
+    && ln -s /opt/ol/links/config /config \
+    && chown -R 1001:0 /opt/ol/links/output \
+    && chmod -R g+rw /opt/ol/links/output \
+    && chown -R 1001:0 /opt/ol/links/config \
+    && chmod -R g+rw /opt/ol/links/config \
+    && chown -R 1001:0 /config \
+    && chmod -R g+rw /config \
+    && chown -R 1001:0 /output \
+    && chmod -R g+rw /output
 
 # Create a new SCC layer
 RUN if [ "$OPENJ9_SCC" = "true" ]; then populate_scc.sh; fi \
     && rm -rf /output/messaging /output/resources/security /logs/* $WLP_OUTPUT_DIR/.classCache \
     && chown -R 1001:0 /opt/ol/wlp/output \
     && chmod -R g+rwx /opt/ol/wlp/output
 
-#These settings are needed so that we can run as a different user than 1001 after server warmup
+# These settings are needed so that we can run as a different user than 1001 after server warmup
 ENV RANDFILE=/tmp/.rnd \
     OPENJ9_JAVA_OPTIONS="-XX:+IgnoreUnrecognizedVMOptions -XX:+IdleTuningGcOnIdle -Xshareclasses:name=openj9_system_scc,cacheDir=/opt/java/.scc,readonly,nonFatal -Dosgi.checkConfiguration=false"
 
@@ -97,4 +118,4 @@ USER 1001
 EXPOSE 9080 9443
 
 ENTRYPOINT ["/opt/ol/helpers/runtime/docker-server.sh"]
-CMD ["/opt/ol/wlp/bin/server", "run", "defaultServer"]
+CMD ["/opt/ol/wlp/bin/server", "run"]