Merge branch 'develop' into develop-jbr17

Containerfile

@@ -0,0 +1,55 @@
+
+FROM docker.inteligr8.com/inteligr8/base:${base.image.version}
+
+# Configure standard JAVA parameters
+ENV JAVA_MEMORY_INIT=128m
+ENV JAVA_MEMORY_MAX=512m
+ENV JAVA_OPTS=
+ENV ENABLE_HOTSWAP=true
+ENV ENABLE_JDWP=true
+ENV DISABLE_HOTSWAP_PLUGINS=
+
+# these are effectively immutable; provided to be used by extending images
+# the entrypoint will re-set these in case they are changed
+ENV JAVA_HOME=/usr/local/lib/jvm/java-openjdk-jbr
+ENV JRE_HOME=/usr/local/lib/jvm/java-openjdk-jbr
+
+# Install essentials for Java
+RUN apt update && \
+        apt -y install libfreetype6 fontconfig fonts-dejavu ca-certificates-java
+
+# Download & Install JBR Java
+RUN mkdir -p /usr/local/lib/jvm && \
+        cd /usr/local/lib/jvm && \
+        curl -L https://cache-redirector.jetbrains.com/intellij-jbr/${jbr.filename} -o java-openjdk-jbr.tar.gz && \
+        tar xzvf java-openjdk-jbr.tar.gz && \
+        mv ${jbr.basename} java-openjdk-jbr && \
+        mkdir -p java-openjdk-jbr/lib/hotswap && \
+        rm java-openjdk-jbr.tar.gz && \
+        cd ../../bin && \
+        ln -s ../lib/jvm/java-openjdk-jbr/bin/java . && \
+        ln -s ../lib/jvm/java-openjdk-jbr/bin/keytool .
+
+# Configure `cacerts`
+RUN update-ca-certificates && \
+        cd /usr/local/lib/jvm/java-openjdk-jbr/lib/security && \
+        rm cacerts && \
+        ln -s /etc/ssl/certs/java/cacerts .
+
+# Download Hotswap Agent
+RUN curl -L https://github.com/HotswapProjects/HotswapAgent/releases/download/RELEASE-${hotswap.version}/hotswap-agent-${hotswap.version}.jar -o /usr/local/lib/jvm/java-openjdk-jbr/lib/hotswap/hotswap-agent.jar
+
+# Add directories for dynamic injection points
+RUN mkdir -p /var/lib/jvm && cd /var/lib/jvm && \
+        mkdir dev lib && cd dev && \
+        mkdir classes classes-extra1 classes-extra2 classes-extra3 classes-extra4 classes-extra5 classes-extra6 classes-extra7 && \
+        mkdir lib lib-extra1 lib-extra2 lib-extra3 lib-extra4 lib-extra5 lib-extra6 lib-extra7
+
+# Add our Docker container initialization scripts
+ADD --chmod=755 maven/setenv.sh ${CONTAINERD_ENTRYPOINT_PATH}/10-setenv-${artifactId}.sh
+
+# Add our default hotswap configuration; may be overwritten in dev/classes* volumes
+ADD --chmod=644 maven/hotswap-agent.properties /var/lib/jvm/lib
+
+# Listening for Java debugger traffic
+EXPOSE 8000

Dockerfile

@@ -1,42 +0,0 @@
-
-FROM ubuntu:${ubuntu.version}
-
-# Configure standard JAVA parameters
-ENV JAVA_MEMORY_INIT=128m
-ENV JAVA_MEMORY_MAX=512m
-ENV JAVA_OPTS=
-
-# Install curl
-RUN apt update && apt -y install curl
-
-# Download & Install DCEVM Java
-RUN mkdir -p /usr/local/lib/jvm && \
-        curl -L https://github.com/TravaOpenJDK/trava-jdk-${dcevm.majorVersion}-dcevm/releases/download/dcevm-${dcevm.version}/java${dcevm.majorVersion}-openjdk-dcevm-linux.tar.gz -o /usr/local/lib/jvm/java-openjdk-dcevm.tar.gz && \
-        cd /usr/local/lib/jvm && tar xzvf java-openjdk-dcevm.tar.gz && mv dcevm-${dcevm.version} java-openjdk-dcevm && rm java-openjdk-dcevm.tar.gz
-
-# Download Hotswap Agent
-RUN curl -L https://github.com/HotswapProjects/HotswapAgent/releases/download/RELEASE-${hotswap.version}/hotswap-agent-${hotswap.version}.jar -o /usr/local/lib/jvm/hotswap-agent.jar
-
-# Add directories for dynamic injection points
-RUN mkdir -p /var/lib/jvm && cd /var/lib/jvm && \
-        mkdir dev lib && cd dev && \
-        mkdir classes classes-extra1 classes-extra2 classes-extra3 classes-extra4 classes-extra5 classes-extra6 classes-extra7 && \
-        mkdir lib lib-extra1 lib-extra2 lib-extra3 lib-extra4 lib-extra5 lib-extra6 lib-extra7
-
-# Add our Docker container initialization script
-ADD docker-entrypoint.sh /usr/local/bin
-
-# Add our default hotswap configuration; may be overwritten
-ADD hotswap-agent.properties /var/lib/jvm/lib
-
-# Listening for Java debugger traffic
-EXPOSE 8000
-
-# Running as ROOT user for now
-#USER java
-
-# Execute the Docker container initialization script
-ENTRYPOINT [ "/usr/local/bin/docker-entrypoint.sh" ]
-
-# Do nothing meaningful; made to be overridden
-CMD [ "-version" ]

README.md

@@ -0,0 +1,38 @@
+
+# Java Application Container Image with Hot-Reloading
+
+This project creates a Docker image that has uses both the [Jetbrains JDK](https://github.com/JetBrains/JetBrainsRuntime) and [Hotswap Agent](http://hotswapagent.org/) and the Java JDWP debugger.  The combination of these utilities allows for the hot-reloading of Java resources and classes to enable rapid application development and debugging capabilties.  As a Docker image, containers can be started to facilitate development without requiring complicated installations on developer workstations.
+
+It is expected that containers are configured in Maven using the Fabric8 or Spotify Docker plugins.  These configurations should expose the 8000 (debugger) port and any other port that the application may open.  Most importantly, it should mount/bind the source code to the following possible paths.
+
+| Directory                         | Type      | Hot-Reloaded |
+| --------------------------------- |:---------:|:------------:|
+| `/var/lib/jvm/dev/classes`        | Classpath | Yes          |
+| `/var/lib/jvm/dev/classes-extra1` | Classpath | Yes          |
+| `/var/lib/jvm/dev/classes-extra2` | Classpath | Yes          |
+| `/var/lib/jvm/dev/classes-extra3` | Classpath | Yes          |
+| `/var/lib/jvm/dev/classes-extra4` | Classpath | Yes          |
+| `/var/lib/jvm/dev/classes-extra5` | Classpath | Yes          |
+| `/var/lib/jvm/dev/classes-extra6` | Classpath | Yes          |
+| `/var/lib/jvm/dev/classes-extra7` | Classpath | Yes          |
+| `/var/lib/jvm/dev/lib`            | JARs      | No           |
+| `/var/lib/jvm/dev/lib-extra1`     | JARs      | No           |
+| `/var/lib/jvm/dev/lib-extra2`     | JARs      | No           |
+| `/var/lib/jvm/dev/lib-extra3`     | JARs      | No           |
+| `/var/lib/jvm/dev/lib-extra4`     | JARs      | No           |
+| `/var/lib/jvm/dev/lib-extra5`     | JARs      | No           |
+| `/var/lib/jvm/dev/lib-extra6`     | JARs      | No           |
+| `/var/lib/jvm/dev/lib-extra7`     | JARs      | No           |
+
+You may include your own `hotswap-agent.properties` in any of the `classes` folders.  The one loaded by default is usually sufficient.
+
+You can specify the following environment variables when running the container.
+
+| Environment Variable      | Default Value | Description |
+| ------------------------- | ------------- | ----------- |
+| `JAVA_MEMORY_INIT`        | `128m`        | The initial and minimum JVM memory. |
+| `JAVA_MEMORY_MAX`         | `512m`        | The maximum JVM memory allowed. |
+| `ENABLE_HOTSWAP`          | `true`        | Set to `false` to disable the HotSwap agent. |
+| `DISABLE_HOTSWAP_PLUGINS` |               | Provide a comma-delimited list of HotSwap plugins to disable.  You can find a list of those plugins here: https://github.com/HotswapProjects/HotswapAgent/tree/master/plugin.  The name is only specified in the source, like [*Spring*](https://github.com/HotswapProjects/HotswapAgent/blob/master/plugin/hotswap-agent-spring-plugin/src/main/java/org/hotswap/agent/plugin/spring/SpringPlugin.java). |
+| `ENABLE_JDWP`             | `true`        | Set to `false` to disable the Java debugger. |
+| `JAVA_OPTS`               |               | Set to extend the standard `JAVA_OPTS` environment variable. |

docker-entrypoint.sh

@@ -1,4 +0,0 @@
-#!/bin/bash
-JAVA_OPTS="-Xms${JAVA_MEMORY_INIT} -Xmx${JAVA_MEMORY_MAX} -XX:HotswapAgent=external -javaagent:/usr/local/lib/jvm/hotswap-agent.jar -agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n $JAVA_OPTS"
-
-exec "/usr/local/lib/jvm/java-openjdk-dcevm/bin/java ${JAVA_OPTS} $@"

pom.xml

@@ -1,84 +1,160 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
-    <modelVersion>4.0.0</modelVersion>
-    <groupId>com.inteligr8</groupId>
-    <artifactId>java-dcevm-hotswap</artifactId>
-    <version>11.0.10-1.4.1</version>
-    <name>Java DCEVM for Rapid Application Development</name>
-    <packaging>pom</packaging>
+	<modelVersion>4.0.0</modelVersion>
+	<groupId>com.inteligr8</groupId>
+	<artifactId>jdk-hotswap</artifactId>
+	<version>${hotswap.version}-jbr-${jbr.version}</version>
+	<name>Java Hotswap Kit for Rapid Application Development</name>
+	<packaging>pom</packaging>
 
-    <properties>
-        <!-- The release version of Ubuntu to use as the base -->
-        <!-- See: https://hub.docker.com/_/ubuntu -->
-        <!-- This has very little impact and may be replaced -->
-        <ubuntu.version>20.04</ubuntu.version>
+	<properties>
+		<!-- See: https://git.inteligr8.com/inteligr8/base-image -->
+		<!-- See: https://repos.inteligr8.com/nexus/service/rest/repository/browse/inteligr8-docker-public/v2/inteligr8/base/tags/ -->
+		<base.image.version>1.0-deb12</base.image.version>
 
-        <!-- The version of Java DCEVM to use for executing Apache Tomcat -->
-        <!-- See: https://github.com/TravaOpenJDK/trava-jdk-11-dcevm/releases -->
-        <dcevm.version>11.0.10+4</dcevm.version>
-        <dcevm.majorVersion>11</dcevm.majorVersion>
+		<!-- The version of the Hotswap Agent to use -->
+		<!-- See: https://github.com/HotswapProjects/HotswapAgent/releases -->
+		<hotswap.version>2.0.3</hotswap.version>
 
-        <!-- The version of the Hotswap Agent to use -->
-        <!-- See: https://github.com/HotswapProjects/HotswapAgent/releases -->
-        <hotswap.version>1.4.1</hotswap.version>
+		<!-- The version of the JetBrains JDK -->
+		<!-- See: https://github.com/JetBrains/JetBrainsRuntime/releases -->
+		<jbr.version>17.0.14</jbr.version>
+		<jbr.buildNumber>1367.22</jbr.buildNumber>
+		<jbr.basename>jbr_jcef-${jbr.version}-linux-x64-b${jbr.buildNumber}</jbr.basename>
+		<jbr.filename>${jbr.basename}.tar.gz</jbr.filename>
 
-        <!-- The Docker image meta-data for pushing the build -->
-        <image.name>inteligr8/${project.artifactId}</image.name>
-        <image.tag>${project.version}</image.tag>
-        <image.registry>docker.inteligr8.com</image.registry>
-    </properties>
+		<!-- The Docker image meta-data for pushing the build -->
+		<image.name>inteligr8/${project.artifactId}</image.name>
+		<image.tag>${project.version}</image.tag>
+		<image.registry>docker.inteligr8.com</image.registry>
 
-    <build>
-        <plugins>
-            <!-- This plugin build and pushes the Docker image -->
-            <plugin>
-                <groupId>io.fabric8</groupId>
-                <artifactId>fabric8-maven-plugin</artifactId>
-                <version>4.4.0</version>
-                <configuration>
-                    <images>
-                        <image>
-                            <name>${image.name}:${image.tag}</name>
-                            <registry>${image.registry}</registry>
-                        </image>
-                    </images>
-                    <contextDir>${basedir}</contextDir>
-                    <buildStrategy>docker</buildStrategy>
-                    <verbose>true</verbose>
-                </configuration>
-                <executions>
-                    <!-- This execution builds the Docker image -->
-                    <execution>
-                        <id>docker-build</id>
-                        <phase>package</phase>
-                        <goals><goal>build</goal></goals>
-                    </execution>
-                    <!-- This execution pushes the built Docker image to the configured Docker Registry -->
-                    <execution>
-                        <id>docker-push</id>
-                        <phase>deploy</phase>
-                        <goals><goal>push</goal></goals>
-                    </execution>
-                </executions>
-            </plugin>
-            <!-- This plugin prevents the project from deploying to the Maven Repository, as it is pointless -->
-            <plugin>
-            	<artifactId>maven-deploy-plugin</artifactId>
-                <version>3.0.0-M1</version>
-            	<configuration>
-            		<skip>true</skip>
-            	</configuration>
-            </plugin>
-        </plugins>
-    </build>
+		<!-- using version properties so they can be overridden by child projects or Maven executions -->
+		<maven-resources-plugin.version>3.5.0</maven-resources-plugin.version>
+		<maven-deploy-plugin.version>3.1.4</maven-deploy-plugin.version>
+		<kubernetes-maven-plugin.version>1.19.0</kubernetes-maven-plugin.version>
+		<regex-maven-plugin.version>1.0.7</regex-maven-plugin.version>
+	</properties>
 
-    <profiles>
-        <profile>
-            <id>no-docker</id>
-            <properties>
-                <fabric8.build.jib>true</fabric8.build.jib>
-            </properties>
-        </profile>
-    </profiles>
-    
+	<build>
+		<resources>
+			<resource>
+				<directory>src/main/containerd</directory>
+				<filtering>true</filtering>
+				<targetPath>${project.build.directory}/resources</targetPath>
+			</resource>
+		</resources>
+		<pluginManagement>
+			<plugins>
+				<plugin>
+					<artifactId>maven-resources-plugin</artifactId>
+					<version>${maven-resources-plugin.version}</version>
+				</plugin>
+				<plugin>
+					<artifactId>maven-deploy-plugin</artifactId>
+					<version>${maven-deploy-plugin.version}</version>
+				</plugin>
+				<plugin>
+					<groupId>org.eclipse.jkube</groupId>
+					<artifactId>kubernetes-maven-plugin</artifactId>
+					<version>${kubernetes-maven-plugin.version}</version>
+				</plugin>
+				<plugin>
+					<groupId>com.inteligr8</groupId>
+					<artifactId>regex-maven-plugin</artifactId>
+					<version>${regex-maven-plugin.version}</version>
+				</plugin>
+			</plugins>
+		</pluginManagement>
+		<plugins>
+			<plugin>
+				<groupId>com.inteligr8</groupId>
+				<artifactId>regex-maven-plugin</artifactId>
+				<executions>
+					<execution>
+						<id>determine-jbr-major-version</id>
+						<phase>validate</phase>
+						<goals>
+							<goal>replace-property</goal>
+						</goals>
+						<configuration>
+							<property>jbr.version</property>
+							<newProperty>jbr.majorVersion</newProperty>
+							<regexes>
+								<regex>
+									<pattern>([^.]+).*</pattern>
+									<replacement>$1</replacement>
+								</regex>
+							</regexes>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<artifactId>maven-resources-plugin</artifactId>
+				<executions>
+					<execution>
+						<id>copy-resources</id>
+						<phase>process-resources</phase>
+						<goals><goal>resources</goal></goals>
+						<configuration>
+							<encoding>utf-8</encoding>
+							<propertiesEncoding>utf-8</propertiesEncoding>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+			<!-- This plugin build and pushes the Docker image -->
+			<plugin>
+				<groupId>org.eclipse.jkube</groupId>
+				<artifactId>kubernetes-maven-plugin</artifactId>
+				<configuration>
+					<images>
+						<image>
+							<name>${image.name}:${image.tag}</name>
+							<registry>${image.registry}</registry>
+							<build>
+								<contextDir>${project.build.directory}/resources</contextDir>
+								<dockerFile>${project.basedir}/Containerfile</dockerFile>
+								<tags>
+									<tag>${hotswap.version}-jbr${jbr.majorVersion}</tag>
+								</tags>
+							</build>
+						</image>
+					</images>
+					<verbose>true</verbose>
+				</configuration>
+				<executions>
+					<!-- This execution builds the Docker image -->
+					<execution>
+						<id>docker-build</id>
+						<phase>package</phase>
+						<goals><goal>build</goal></goals>
+					</execution>
+					<!-- This execution pushes the built Docker image to the configured Docker Registry -->
+					<execution>
+						<id>docker-push</id>
+						<phase>deploy</phase>
+						<goals><goal>push</goal></goals>
+					</execution>
+				</executions>
+			</plugin>
+			<!-- This plugin prevents the project from deploying to the Maven Repository, as it is pointless -->
+			<plugin>
+				<artifactId>maven-deploy-plugin</artifactId>
+				<configuration>
+					<skip>true</skip>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
+	<profiles>
+		<profile>
+			<id>no-docker</id>
+			<properties>
+				<jkube.build.strategy>jib</jkube.build.strategy>
+			</properties>
+		</profile>
+	</profiles>
+	
 </project>

src/main/containerd/hotswap-agent.properties

@@ -7,7 +7,14 @@
 # This may be useful for example in multi module maven project to load class changes from upstream project
 # classes. Set extraClasspath to upstream project compiler output and .class file will have precedence to
 # classes from built JAR file.
-extraClasspath=/tmp/java/classpath
+extraClasspath=/var/lib/jvm/dev/classes; \
+/var/lib/jvm/dev/classes-extra1; \
+/var/lib/jvm/dev/classes-extra2; \
+/var/lib/jvm/dev/classes-extra3; \
+/var/lib/jvm/dev/classes-extra4; \
+/var/lib/jvm/dev/classes-extra5; \
+/var/lib/jvm/dev/classes-extra6; \
+/var/lib/jvm/dev/classes-extra7
 
 # Watch for changes in a directory (resources only). If not set, changes of resources won't be observed.
 #
@@ -19,19 +26,26 @@ extraClasspath=/tmp/java/classpath
 # replacements of resources in a building step (maven filtering resource option).
 # This setting will leave i.e. src/target/classes as default source for resources, but after the resource is modified
 # in src/main/resources, the new changed resource is served instead.
-watchResources=/tmp/java/resources
+watchResources=/var/lib/jvm/dev/classes; \
+/var/lib/jvm/dev/classes-extra1; \
+/var/lib/jvm/dev/classes-extra2; \
+/var/lib/jvm/dev/classes-extra3; \
+/var/lib/jvm/dev/classes-extra4; \
+/var/lib/jvm/dev/classes-extra5; \
+/var/lib/jvm/dev/classes-extra6; \
+/var/lib/jvm/dev/classes-extra7
 
 # Load static web resources from different directory.
 #
 # This setting is dependent on application server plugin(Jetty, Tomcat, ...).
 # Jboss and Glassfish are not yet supported.
 # Use this setting to set to serve resources from source directory directly (e.g. src/main/webapp).
-webappDir=/var/java/web
+webappDir=
 
 
 # Comma separated list of disabled plugins
 # Use plugin name - e.g. Hibernate, Spring, ZK, Hotswapper, AnonymousClassPatch, Tomcat, Logback ....
-disabledPlugins=
+disabledPlugins=${hotswap.disablePlugins}
 
 # Watch for changed class files on watchResources path and reload class definition in the running application.
 #

src/main/containerd/setenv.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# immutable
+JAVA_HOME=/usr/local/lib/jvm/java-openjdk-jbr
+JRE_HOME=/usr/local/lib/jvm/java-openjdk-jbr
+JAVA_OPTS="${JAVA_OPTS} -Xms${JAVA_MEMORY_INIT} -Xmx${JAVA_MEMORY_MAX}"
+
+if [ "${ENABLE_HOTSWAP}" = "true" ]; then
+    JAVA_OPTS="${JAVA_OPTS} -XX:+AllowEnhancedClassRedefinition -XX:HotswapAgent=fatjar"
+    JAVA_OPTS="${JAVA_OPTS} -Dhotswap.disablePlugins=${DISABLE_HOTSWAP_PLUGINS}"
+fi
+
+if [ "${ENABLE_JDWP}" = "true" ]; then
+    JAVA_OPTS="${JAVA_OPTS} -agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n"
+fi