Separate operator default implementation from library

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [0.11.0] - estimated 2024-07
 
 - [common] Add option field to CRDs and increase version to `Session.v1beta8`, `Workspace.v1beta5` and `AppDefinition.v1beta10` [#293](https://github.com/eclipsesource/theia-cloud/pull/293) | [#55](https://github.com/eclipsesource/theia-cloud-helm/pull/55)
+- [java] Separate operator default implementation from library to allow for easier customization [#303](https://github.com/eclipsesource/theia-cloud/pull/303)
 
 ## [0.10.0] - 2024-04-02
 

dockerfiles/operator/Dockerfile

@@ -8,14 +8,16 @@ RUN cd /operator/common/maven-conf && \
     cd /operator/common/org.eclipse.theia.cloud.common && \
     mvn clean install --no-transfer-progress && \
     cd /operator/operator/org.eclipse.theia.cloud.operator && \
+    mvn clean install --no-transfer-progress && \
+    cd /operator/operator/org.eclipse.theia.cloud.defaultoperator && \
     mvn clean verify --no-transfer-progress
 
 FROM eclipse-temurin:17-jre-alpine
 RUN mkdir /templates
 WORKDIR /log-config
-COPY java/operator/org.eclipse.theia.cloud.operator/log4j2.xml .
+COPY java/operator/org.eclipse.theia.cloud.defaultoperator/log4j2.xml .
 WORKDIR /operator
-COPY --from=builder /operator/operator/org.eclipse.theia.cloud.operator/target/operator-0.11.0-SNAPSHOT-jar-with-dependencies.jar .
+COPY --from=builder /operator/operator/org.eclipse.theia.cloud.defaultoperator/target/defaultoperator-0.11.0-SNAPSHOT-jar-with-dependencies.jar .
 # to get more debug information from the kubernetes client itself, add -Dorg.slf4j.simpleLogger.defaultLogLevel=DEBUG below
-ENTRYPOINT [ "java", "-Dlog4j2.configurationFile=/log-config/log4j2.xml", "-jar", "./operator-0.11.0-SNAPSHOT-jar-with-dependencies.jar" ]
+ENTRYPOINT [ "java", "-Dlog4j2.configurationFile=/log-config/log4j2.xml", "-jar", "./defaultoperator-0.11.0-SNAPSHOT-jar-with-dependencies.jar" ]
 CMD [ "" ]

dockerfiles/operator/Dockerfile.withcache

@@ -9,14 +9,16 @@ RUN --mount=type=cache,target=/root/.m2 \
     cd /operator/common/org.eclipse.theia.cloud.common && \
     mvn clean install && \
     cd /operator/operator/org.eclipse.theia.cloud.operator && \
+    mvn clean install && \
+    cd /operator/operator/org.eclipse.theia.cloud.defaultoperator && \
     mvn clean verify
 
 FROM eclipse-temurin:17-jre-alpine
 RUN mkdir /templates
 WORKDIR /log-config
-COPY java/operator/org.eclipse.theia.cloud.operator/log4j2.xml .
+COPY java/operator/org.eclipse.theia.cloud.defaultoperator/log4j2.xml .
 WORKDIR /operator
-COPY --from=builder /operator/operator/org.eclipse.theia.cloud.operator/target/operator-0.11.0-SNAPSHOT-jar-with-dependencies.jar .
+COPY --from=builder /operator/operator/org.eclipse.theia.cloud.defaultoperator/target/defaultoperator-0.11.0-SNAPSHOT-jar-with-dependencies.jar .
 # to get more debug information from the kubernetes client itself, add -Dorg.slf4j.simpleLogger.defaultLogLevel=DEBUG below
-ENTRYPOINT [ "java", "-Dlog4j2.configurationFile=/log-config/log4j2.xml", "-jar", "./operator-0.11.0-SNAPSHOT-jar-with-dependencies.jar" ]
+ENTRYPOINT [ "java", "-Dlog4j2.configurationFile=/log-config/log4j2.xml", "-jar", "./defaultoperator-0.11.0-SNAPSHOT-jar-with-dependencies.jar" ]
 CMD [ "" ]

documentation/Architecture.md

@@ -7,13 +7,15 @@ The Theia Cloud Operator listens for changes to custom resources inside the clus
 ## Operator Java Overview
 
 The Java operator is created via a dependency injection module.
-In the future the operator will be provided as a library with defined interfaces end users may exchange to customize the operator based on their needs.
+We provide a library (`org.eclipse.theia.cloud.operator`), as well as a default implementation (`org.eclipse.theia.cloud.defaultoperator`) for the operator.
+The library can be used to create a operator customized to your use cases.
+The default implementation is meant as an example for basic deployment use cases and is used in our demos.
 
 The following diagram sketches the basic idea.
 
 ![Operator Diagram](operator.png "Operator")
 
-## Operator configuration options
+### Operator configuration options
 
 |Option|Type|Used for|
 |---|---|---|

java/operator/org.eclipse.theia.cloud.defaultoperator/.classpath

@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" output="target/classes" path="src/main/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
+		<attributes>
+			<attribute name="test" value="true"/>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-17">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" path=".apt_generated">
+		<attributes>
+			<attribute name="optional" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="target/test-classes" path=".apt_generated_tests">
+		<attributes>
+			<attribute name="test" value="true"/>
+			<attribute name="optional" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
+		<attributes>
+			<attribute name="test" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="optional" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" path="target/generated-sources/annotations">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="ignore_optional_problems" value="true"/>
+			<attribute name="m2e-apt" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="optional" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="target/test-classes" path="target/generated-test-sources/test-annotations">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="ignore_optional_problems" value="true"/>
+			<attribute name="m2e-apt" value="true"/>
+			<attribute name="test" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="output" path="target/classes"/>
+</classpath>

java/operator/org.eclipse.theia.cloud.defaultoperator/.gitignore

@@ -0,0 +1,4 @@
+/target/
+/.apt_generated/
+/.apt_generated_tests/
+

java/operator/org.eclipse.theia.cloud.defaultoperator/.project

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>defaultoperator</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.m2e.core.maven2Builder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+		<nature>org.eclipse.m2e.core.maven2Nature</nature>
+	</natures>
+	<filteredResources>
+		<filter>
+			<id>1665669047196</id>
+			<name></name>
+			<type>30</type>
+			<matcher>
+				<id>org.eclipse.core.resources.regexFilterMatcher</id>
+				<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments>
+			</matcher>
+		</filter>
+	</filteredResources>
+</projectDescription>

java/operator/org.eclipse.theia.cloud.defaultoperator/.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,4 @@
+eclipse.preferences.version=1
+encoding//src/main/java=UTF-8
+encoding//src/test/java=UTF-8
+encoding/<project>=UTF-8

java/operator/org.eclipse.theia.cloud.defaultoperator/.settings/org.eclipse.jdt.apt.core.prefs

@@ -0,0 +1,4 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.apt.aptEnabled=true
+org.eclipse.jdt.apt.genSrcDir=target/generated-sources/annotations
+org.eclipse.jdt.apt.genTestSrcDir=target/generated-test-sources/test-annotations