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
 

demo/dockerfiles/demo-theia-monitor-vscode/Dockerfile

@@ -1,3 +1,10 @@
+FROM node:18-bullseye-slim as build-stage
+
+# Copy and unzip the vsix file
+RUN apt-get update && apt-get install -y unzip && rm -rf /var/lib/apt/lists/*
+COPY theiacloud-monitor-0.11.0-next.vsix /tmp/theiacloud-monitor.vsix
+RUN mkdir /tmp/extracted && unzip /tmp/theiacloud-monitor.vsix -d /tmp/extracted
+
 FROM theiacloud/theia-cloud-demo:0.11.0-next as production-stage
 
-COPY --chown=theia:theia theiacloud-monitor-0.11.0-next.vsix /home/theia/plugins
+COPY --chown=theia:theia --from=build-stage /tmp/extracted /home/theia/plugins

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

@@ -2,18 +2,21 @@
 
 The Theia Cloud Operator listens for changes to custom resources inside the cluster. With those custom resources clients may trigger the creation/deletion/handling of workspaces and sessions. The Operator is responsible for handling all things that are related to the Kubernetes-Resources for workspaces and sessions. All access is authenticated via an Authenticator.
 
-![Theia Cloud Diagram](theia.cloud.png "Theia Cloud")
+![Theia Cloud Diagram](theiacloud.png "Theia Cloud")
 
 ## 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 an operator customized to your use cases.
+The default implementation is a production-ready operator that handles most use cases on most cloud providers out of the box and is used in our demos.
+If customization is needed, it also serves as an example of how to utilize the operator library.
 
 The following diagram sketches the basic idea.
 
 ![Operator Diagram](operator.png "Operator")
 
-## Operator configuration options
+### Operator configuration options
 
 |Option|Type|Used for|
 |---|---|---|

documentation/OpenAPI.md

@@ -2,7 +2,7 @@
 
 ## Generate and Update
 
-Start Theia.cloud service from IDE (which starts quarkus in dev mode).
+Start Theia Cloud service from IDE (which starts quarkus in dev mode).
 
 Access generated specs at <http://localhost:8081/q/openapi?format=json>
 

documentation/platforms/Minikube.md

@@ -1,8 +1,8 @@
 # Getting started with Minikube
 
 Minikube is a local Kubernetes that allows you to test and develop for Kubernetes.\
-In this guide we will show you how to install minikube and helm 3 as well as cert-manager, the cloud native certificate management, the NginX Ingress Controller and Keycloak. We will use existing installation methods for all of the Theia.Cloud preqrequisites.\
-Finally we will install and try Theia.Cloud using helm.
+In this guide we will show you how to install minikube and helm 3 as well as cert-manager, the cloud native certificate management, the NginX Ingress Controller and Keycloak. We will use existing installation methods for all of the Theia Cloud preqrequisites.\
+Finally we will install and try Theia Cloud using helm.
 
 If you have no experience with Kubernetes/Minikube yet, we encourage you to check out some basic tutorials first, e.g. <https://kubernetes.io/docs/tutorials/hello-minikube/> and <https://kubernetes.io/docs/tutorials/kubernetes-basics/>
 

documentation/platforms/global-certificate.yaml

@@ -42,7 +42,7 @@ metadata:
   annotations:
     cert-manager.io/cluster-issuer: letsencrypt-prod
     acme.cert-manager.io/http01-edit-in-place: "true"
-    # cert-manager.io/common-name: "Theia.Cloud"
+    # cert-manager.io/common-name: "Theia Cloud"
 spec:
   ingressClassName: nginx
   tls:

java/common/maven-conf/pom.xml

@@ -7,7 +7,7 @@
 	<artifactId>conf</artifactId>
 	<version>0.11.0-SNAPSHOT</version>
 	<packaging>pom</packaging>
-	<name>Theia.Cloud Maven Configuration</name>
+	<name>Theia Cloud Maven Configuration</name>
 	<description>Common properties and configuration</description>
 
 	<properties>

java/common/org.eclipse.theia.cloud.common/pom.xml

@@ -5,8 +5,8 @@
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>common</artifactId>
 	<packaging>jar</packaging>
-	<name>Theia.Cloud Common</name>
-	<description>Common components of Theia.Cloud</description>
+	<name>Theia Cloud Common</name>
+	<description>Common components of Theia Cloud</description>
 
 	<parent>
 		<groupId>org.eclipse.theia.cloud</groupId>

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