User module: parameterize UID, USER, GECOS

jmtd · jmtd · commit b994c40b2f68 · 2023-11-09T11:45:36.000Z
Define environment variables capturing the values for the user's name
(USER), uid (UID) and user-name/comment/gecos (GECOS, see passwd(5))
in the jboss.container.user module.

Replace hard-coded references to those values in scripts across all the
other modules. For those modules which now use these variables, add an
explicit dependency on jboss.container.user if it wasn't already
present.

The primary reason for this change is to reduce the delta between the
ubi8 and ubi9 branches, which will avoid merge conflicts for future
backports from ubi9 to ubi8. The secondary reason is to reduce the
risk of a discrepancy for the values across the scripts.

Signed-off-by: Jonathan Dowland &lt;jdowland@redhat.com&gt;
diff --git a/modules/jdk/11/configure.sh b/modules/jdk/11/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/openjdk/jdk/*
 
diff --git a/modules/jdk/17/configure.sh b/modules/jdk/17/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/openjdk/jdk/*
 
diff --git a/modules/jdk/8/configure.sh b/modules/jdk/8/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/openjdk/jdk/*
 
diff --git a/modules/jre/11/configure.sh b/modules/jre/11/configure.sh
@@ -7,7 +7,7 @@ echo $SCRIPT_DIR
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 echo $ARTIFACTS_DIR
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/openjdk/jre/*
 
diff --git a/modules/jre/17/configure.sh b/modules/jre/17/configure.sh
@@ -7,7 +7,7 @@ echo $SCRIPT_DIR
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 echo $ARTIFACTS_DIR
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/openjdk/jre/*
 
diff --git a/modules/jre/8/configure.sh b/modules/jre/8/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/openjdk/jre/*
 
diff --git a/modules/jvm/bash/backward_compatibility.sh b/modules/jvm/bash/backward_compatibility.sh
@@ -6,4 +6,4 @@ set -e
 mkdir -p /opt/run-java
 ln -s /opt/jboss/container/java/jvm/* /opt/run-java
 
-chown -R jboss:root /opt/run-java
+chown -R $USER:root /opt/run-java
diff --git a/modules/jvm/bash/configure.sh b/modules/jvm/bash/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/java/jvm/*
 
diff --git a/modules/jvm/bash/module.yaml b/modules/jvm/bash/module.yaml
@@ -15,5 +15,6 @@ execute:
 
 modules:
   install:
+  - name: jboss.container.user
   - name: jboss.container.java.jvm.api
   - name: jboss.container.java.proxy.bash
diff --git a/modules/maven/default/configure.sh b/modules/maven/default/configure.sh
@@ -6,7 +6,7 @@ SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
 # configure artifact permissions
-chown -R jboss:root $ARTIFACTS_DIR
+chown -R $USER:root $ARTIFACTS_DIR
 chmod -R ug+rwX $ARTIFACTS_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/maven/default/maven.sh
 
@@ -19,11 +19,11 @@ MAVEN_VERSION_SQUASHED=${MAVEN_VERSION/./}
 
 # pull in specific maven version to serve as default
 ln -s /opt/jboss/container/maven/${MAVEN_VERSION_SQUASHED}/* /opt/jboss/container/maven/default
-chown -h jboss:root /opt/jboss/container/maven/default/*
+chown -h $USER:root /opt/jboss/container/maven/default/*
 
 # install default settings.xml file in user home
 mkdir -p $HOME/.m2
 ln -s /opt/jboss/container/maven/default/jboss-settings.xml $HOME/.m2/settings.xml
 
-chown -R jboss:root $HOME/.m2
+chown -R $USER:root $HOME/.m2
 chmod -R ug+rwX $HOME/.m2
diff --git a/modules/maven/default/module.yaml b/modules/maven/default/module.yaml
@@ -16,6 +16,7 @@ execute:
 
 modules:
   install:
+  - name: jboss.container.user
   - name: jboss.container.maven.api
   - name: jboss.container.java.jvm.bash
   - name: jboss.container.maven
diff --git a/modules/maven/s2i/configure.sh b/modules/maven/s2i/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/maven/s2i/*
 chmod ug+x ${ARTIFACTS_DIR}/usr/local/s2i/*
diff --git a/modules/maven/s2i/module.yaml b/modules/maven/s2i/module.yaml
@@ -32,6 +32,7 @@ execute:
 
 modules:
   install:
+  - name: jboss.container.user
   - name: jboss.container.s2i.core.api
   - name: jboss.container.s2i.core.bash
   - name: jboss.container.maven.default
diff --git a/modules/proxy/bash/backward_compatibility.sh b/modules/proxy/bash/backward_compatibility.sh
@@ -6,4 +6,4 @@ set -e
 mkdir -p /opt/run-java
 ln -s /opt/jboss/container/java/proxy/* /opt/run-java
 
-chown -R jboss:root /opt/run-java
+chown -R $USER:root /opt/run-java
diff --git a/modules/proxy/bash/configure.sh b/modules/proxy/bash/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/java/proxy*
 
diff --git a/modules/proxy/bash/module.yaml b/modules/proxy/bash/module.yaml
@@ -16,4 +16,5 @@ execute:
 
 modules:
   install:
-  - name: jboss.container.proxy.api
+  - name: jboss.container.user
+  - name: jboss.container.proxy.api
diff --git a/modules/run/configure.sh b/modules/run/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/java/run/*
 
@@ -15,7 +15,7 @@ popd
 
 mkdir -p /deployments/data \
  && chmod -R "ug+rwX" /deployments/data \
- && chown -R jboss:root /deployments/data
+ && chown -R $USER:root /deployments/data
 
 # OPENJDK-100: turn off negative DNS caching
 if [ -w ${JAVA_HOME}/jre/lib/security/java.security ]; then
diff --git a/modules/run/module.yaml b/modules/run/module.yaml
@@ -57,5 +57,6 @@ execute:
 
 modules:
   install:
+  - name: jboss.container.user
   - name: jboss.container.java.jvm.bash
   - name: jboss.container.util.logging.bash
diff --git a/modules/s2i/bash/configure.sh b/modules/s2i/bash/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/java/s2i/*
 chmod ug+x ${ARTIFACTS_DIR}/usr/local/s2i/*
diff --git a/modules/s2i/bash/module.yaml b/modules/s2i/bash/module.yaml
@@ -20,6 +20,7 @@ execute:
 
 modules:
   install:
+  - name: jboss.container.user
   - name: jboss.container.maven.s2i
   - name: jboss.container.java.run
   - name: jboss.container.util.logging.bash
diff --git a/modules/s2i/core/api/module.yaml b/modules/s2i/core/api/module.yaml
@@ -119,3 +119,7 @@ envs:
 run:
   cmd:
   - "/usr/local/s2i/run"
+
+modules:
+  install:
+    - name: jboss.container.user
diff --git a/modules/s2i/core/bash/configure.sh b/modules/s2i/core/bash/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/s2i/core/*
 
@@ -15,8 +15,8 @@ popd
 
 mkdir -p /usr/local/s2i \
  && chmod 775 /usr/local/s2i \
- && chown -R jboss:root /usr/local/s2i
+ && chown -R $USER:root /usr/local/s2i
 
 mkdir -p /deployments \
  && chmod -R "ug+rwX" /deployments \
- && chown -R jboss:root /deployments
+ && chown -R $USER:root /deployments
diff --git a/modules/user/configure.sh b/modules/user/configure.sh
@@ -5,7 +5,7 @@ set -e
 # We use the ID 185 for the group as well as for the user.
 # This ID is registered static ID for the JBoss EAP product
 # on RHEL which makes it safe to use.
-groupadd -r jboss -g 185 && useradd -u 185 -r -g root -G jboss -m -d /home/jboss -s /sbin/nologin -c "JBoss user" jboss
+groupadd -r $USER -g $UID && useradd -u $UID -r -g root -G $USER -m -d $HOME -s /sbin/nologin -c "$GECOS" $USER
 
 # OPENJDK-533, OPENJDK-556: correct permissions for OpenShift etc
-chmod 0770 /home/jboss
+chmod 0770 $HOME
diff --git a/modules/user/module.yaml b/modules/user/module.yaml
@@ -4,8 +4,14 @@ version: '1.0'
 description: "Configures the jboss user and permissions.  This module should be included by all images."
 
 envs:
+- name: "USER"
+  value: "jboss"
+- name: "UID"
+  value: &uid 185
 - name: "HOME"
-  value: "/home/jboss"
+  value: &home "/home/jboss"
+- name: "GECOS"
+  value: "JBoss user"
 
 packages:
   install:
@@ -15,5 +21,5 @@ execute:
 - script: configure.sh
 
 run:
-  user: 185
-  workdir: "/home/jboss"
+  user: *uid
+  workdir: *home
diff --git a/modules/util/logging/bash/configure.sh b/modules/util/logging/bash/configure.sh
@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=$(dirname $0)
 ARTIFACTS_DIR=${SCRIPT_DIR}/artifacts
 
-chown -R jboss:root $SCRIPT_DIR
+chown -R $USER:root $SCRIPT_DIR
 chmod -R ug+rwX $SCRIPT_DIR
 chmod ug+x ${ARTIFACTS_DIR}/opt/jboss/container/util/logging/*
 
diff --git a/modules/util/logging/bash/module.yaml b/modules/util/logging/bash/module.yaml
@@ -10,6 +10,10 @@ envs:
   description: Set to true to enable script debugging.  Deprecates SCRIPT_DEBUG.
   example: true
 
+modules:
+  install:
+  - name: jboss.container.user
+
 execute:
 - script: configure.sh
 - script: backward_compatibility.sh
