Skip to content

Commit 63f1dc7

Browse files
adam-sandormetacosmcsviri
authored
Add tomcat operator sample (#659)
 Co-authored-by: Chris Laprun <metacosm@users.noreply.github.com> Co-authored-by: Attila Mészáros <csviri@gmail.com>
1 parent cd3850d commit 63f1dc7

File tree

43 files changed

+1277
-17
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1277
-17
lines changed

‎.github/workflows/end-to-end-tests.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# End to end integration test which deploys the Tomcat operator to a Kubernetes
2+
# (Kind) cluster and creates custom resources to verify the operator's functionality
3+
name: TomcatOperator End to End test
4+
on:
5+
push:
6+
branches:
7+
- "*"
8+
jobs:
9+
tomcat_e2e_test:
10+
runs-on: ubuntu-latest
11+
env:
12+
KIND_CL_NAME: e2e-test
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v2
16+
17+
- name: clean resident local docker
18+
if: ${{ env.ACT }}
19+
continue-on-error: true
20+
run: |
21+
for DIMG in "$KIND_CL_NAME-control-plane "; do
22+
docker stop $DIMG ; docker rm $DIMG ;
23+
done ;
24+
sleep 1
25+
26+
- name: Create Kubernetes KinD Cluster
27+
uses: container-tools/kind-action@v1.5.0
28+
with:
29+
cluster_name: e2e-test
30+
registry: false
31+
32+
- name: Set up Java and Maven
33+
uses: actions/setup-java@v2
34+
with:
35+
java-version: 11
36+
distribution: adopt-hotspot
37+
cache: 'maven'
38+
39+
- name: Build SDK
40+
run: mvn install -DskipTests
41+
42+
- name: build jib
43+
working-directory: sample-operators/tomcat-operator
44+
run: |
45+
mvn --version
46+
mvn -B package jib:dockerBuild jib:buildTar -Djib-maven-image=tomcat-operator -DskipTests
47+
kind load image-archive target/jib-image.tar --name=${{ env.KIND_CL_NAME }}
48+
49+
- name: Apply CRDs
50+
working-directory: sample-operators/tomcat-operator
51+
run: |
52+
kubectl apply -f target/classes/META-INF/fabric8/tomcats.tomcatoperator.io-v1.yml
53+
kubectl apply -f target/classes/META-INF/fabric8/webapps.tomcatoperator.io-v1.yml
54+
55+
- name: Deploy Tomcat Operator
56+
working-directory: sample-operators/tomcat-operator
57+
run: |
58+
kubectl apply -f k8s/operator.yaml
59+
60+
- name: Run E2E Tests
61+
working-directory: sample-operators/tomcat-operator
62+
run: mvn -B test -P end-to-end-tests
63+
64+
- name: Dump state
65+
if: ${{ failure() }}
66+
run: |
67+
set +e
68+
echo "All namespaces"
69+
kubectl get ns
70+
echo "All objects in tomcat-operator"
71+
kubectl get all -n tomcat-operator -o yaml
72+
echo "Output of tomcat-operator pod"
73+
kubectl logs -l app=tomcat-operator -n tomcat-operator
74+
echo "All objects in tomcat-test"
75+
kubectl get deployment,pod,tomcat,webapp -n tomcat-test -o yaml
76+
echo "Output of curl command"
77+
kubectl logs curl -n tomcat-test

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/CustomResourceCache.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public Optional<T> getLatestResource(String uuid) {
7676
return Optional.ofNullable(resources.get(uuid)).map(this::clone);
7777
}
7878

79-
public List<T> getLatestResources(Predicate<CustomResource> selector) {
79+
public List<T> getLatestResources(Predicate<T> selector) {
8080
try {
8181
lock.lock();
8282
return resources.values().stream()
@@ -88,7 +88,7 @@ public List<T> getLatestResources(Predicate<CustomResource> selector) {
8888
}
8989
}
9090

91-
public Set<String> getLatestResourcesUids(Predicate<CustomResource> selector) {
91+
public Set<String> getLatestResourcesUids(Predicate<T> selector) {
9292
try {
9393
lock.lock();
9494
return resources.values().stream()
@@ -113,4 +113,5 @@ private T clone(CustomResource customResource) {
113113
public T cleanup(String customResourceUid) {
114114
return resources.remove(customResourceUid);
115115
}
116+
116117
}

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/DefaultEventSourceManager.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
public class DefaultEventSourceManager<R extends CustomResource<?, ?>>
2727
implements EventSourceManager {
2828

29+
public static final String CUSTOM_RESOURCE_EVENT_SOURCE_NAME = "custom-resource-event-source";
2930
public static final String RETRY_TIMER_EVENT_SOURCE_NAME = "retry-timer-event-source";
30-
private static final String CUSTOM_RESOURCE_EVENT_SOURCE_NAME = "custom-resource-event-source";
3131
private static final Logger log = LoggerFactory.getLogger(DefaultEventSourceManager.class);
3232

3333
private final ReentrantLock lock = new ReentrantLock();

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/CustomResourceEventSource.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,6 @@ public void onClose(WatcherException e) {
159159
}
160160
}
161161

162-
// todo: remove
163162
public CustomResourceCache<T> getCache() {
164163
return customResourceCache;
165164
}

‎operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/InformerEventSource.java‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
import java.util.Set;
66
import java.util.function.Function;
77

8+
import org.slf4j.Logger;
9+
import org.slf4j.LoggerFactory;
10+
811
import io.fabric8.kubernetes.api.model.HasMetadata;
912
import io.fabric8.kubernetes.client.KubernetesClient;
1013
import io.fabric8.kubernetes.client.informers.ResourceEventHandler;
@@ -15,6 +18,8 @@
1518

1619
public class InformerEventSource<T extends HasMetadata> extends AbstractEventSource {
1720

21+
private static final Logger log = LoggerFactory.getLogger(InformerEventSource.class);
22+
1823
private final SharedInformer<T> sharedInformer;
1924
private final Function<T, Set<String>> resourceToUIDs;
2025
private final Function<HasMetadata, T> associatedWith;
@@ -41,6 +46,11 @@ public InformerEventSource(SharedInformer<T> sharedInformer,
4146
Function<T, Set<String>> resourceToUIDs,
4247
Function<HasMetadata, T> associatedWith,
4348
boolean skipUpdateEventPropagationIfNoChange) {
49+
if (sharedInformer.isRunning()) {
50+
log.warn(
51+
"Informer is already running on event source creation, this is not desirable and may " +
52+
"lead to non deterministic behavior.");
53+
}
4454
this.sharedInformer = sharedInformer;
4555
this.resourceToUIDs = resourceToUIDs;
4656
this.skipUpdateEventPropagationIfNoChange = skipUpdateEventPropagationIfNoChange;
@@ -81,7 +91,10 @@ private void propagateEvent(InformerEvent.Action action, T object, T oldObject)
8191
}
8292
uids.forEach(uid -> {
8393
InformerEvent event = new InformerEvent(uid, this, action, object, oldObject);
84-
this.eventHandler.handleEvent(event);
94+
// In case user passes an already running informer this would fail.
95+
if (this.eventHandler != null) {
96+
this.eventHandler.handleEvent(event);
97+
}
8598
});
8699
}
87100

‎pom.xml‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,9 @@
7676
<module>operator-framework-core</module>
7777
<module>operator-framework-junit5</module>
7878
<module>operator-framework</module>
79-
<module>samples</module>
80-
<module>micrometer-support</module>
79+
<module>smoke-test-samples</module>
80+
<module>micrometer-support</module>
81+
<module>sample-operators</module>
8182
</modules>
8283

8384

@@ -272,6 +273,7 @@
272273
</includes>
273274
<excludes>
274275
<exclude>**/*IT.java</exclude>
276+
<exclude>**/*E2E.java</exclude>
275277
</excludes>
276278
</configuration>
277279
</plugin>
@@ -316,6 +318,7 @@
316318
<includes>
317319
<include>**/*Test.java</include>
318320
<include>**/*IT.java</include>
321+
<include>**/*E2E.java</include>
319322
</includes>
320323
</configuration>
321324
</plugin>
@@ -335,6 +338,27 @@
335338
</includes>
336339
<excludes>
337340
<exclude>**/*Test.java</exclude>
341+
<exclude>**/*E2E.java</exclude>
342+
</excludes>
343+
</configuration>
344+
</plugin>
345+
</plugins>
346+
</build>
347+
</profile>
348+
<profile>
349+
<id>end-to-end-tests</id>
350+
<build>
351+
<plugins>
352+
<plugin>
353+
<groupId>org.apache.maven.plugins</groupId>
354+
<artifactId>maven-surefire-plugin</artifactId>
355+
<configuration>
356+
<includes>
357+
<include>**/*E2E.java</include>
358+
</includes>
359+
<excludes>
360+
<exclude>**/*Test.java</exclude>
361+
<exclude>**/*IT.java</exclude>
338362
</excludes>
339363
</configuration>
340364
</plugin>
@@ -351,6 +375,7 @@
351375
<configuration>
352376
<excludes>
353377
<exclude>**/*IT.java</exclude>
378+
<exclude>**/*E2E.java</exclude>
354379
</excludes>
355380
</configuration>
356381
</plugin>

‎sample-operators/pom.xml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5+
<modelVersion>4.0.0</modelVersion>
6+
7+
<parent>
8+
<groupId>io.javaoperatorsdk</groupId>
9+
<artifactId>java-operator-sdk</artifactId>
10+
<version>1.9.12-SNAPSHOT</version>
11+
</parent>
12+
13+
<artifactId>sample-operators</artifactId>
14+
<name>Operator SDK - Samples</name>
15+
<packaging>pom</packaging>
16+
17+
<properties>
18+
<jib-maven-plugin.version>3.1.4</jib-maven-plugin.version>
19+
</properties>
20+
21+
<modules>
22+
<module>tomcat-operator</module>
23+
</modules>
24+
25+
<dependencies>
26+
<dependency>
27+
<groupId>io.javaoperatorsdk</groupId>
28+
<artifactId>operator-framework</artifactId>
29+
<version>1.9.2</version>
30+
</dependency>
31+
<dependency>
32+
<groupId>org.apache.logging.log4j</groupId>
33+
<artifactId>log4j-slf4j-impl</artifactId>
34+
<version>2.13.3</version>
35+
</dependency>
36+
<dependency>
37+
<groupId>org.takes</groupId>
38+
<artifactId>takes</artifactId>
39+
<version>1.19</version>
40+
</dependency>
41+
<dependency>
42+
<groupId>junit</groupId>
43+
<artifactId>junit</artifactId>
44+
<version>4.13.1</version>
45+
<scope>test</scope>
46+
</dependency>
47+
<dependency>
48+
<groupId>org.awaitility</groupId>
49+
<artifactId>awaitility</artifactId>
50+
<version>4.1.0</version>
51+
<scope>test</scope>
52+
</dependency>
53+
</dependencies>
54+
55+
<build>
56+
<plugins>
57+
<plugin>
58+
<groupId>com.google.cloud.tools</groupId>
59+
<artifactId>jib-maven-plugin</artifactId>
60+
<version>${jib-maven-plugin.version}</version>
61+
<configuration>
62+
<from>
63+
<image>gcr.io/distroless/java:11</image>
64+
</from>
65+
<to>
66+
<image>tomcat-operator</image>
67+
</to>
68+
</configuration>
69+
</plugin>
70+
<plugin>
71+
<groupId>org.apache.maven.plugins</groupId>
72+
<artifactId>maven-compiler-plugin</artifactId>
73+
<version>3.8.1</version>
74+
</plugin>
75+
</plugins>
76+
</build>
77+
78+
</project>

‎sample-operators/tomcat-operator/README.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Tomcat Operator
2+
3+
Creates a Tomcat deployment from a Custom Resource, while keeping the WAR separated with another Custom Resource.
4+
5+
This sample demonstrates the following capabilities of the Java Operator SDK:
6+
* Multiple Controllers in a single Operator. The Tomcat resource is managed by the TomcatController while the Webapp
7+
resource is managed by the WebappController.
8+
* Reacting to events about resources created by the controller. The TomcatController will receive events about the
9+
Deployment resources it created. See EventSource section below for more detail.
10+
11+
## Example input for creating a Tomcat instance
12+
```
13+
apiVersion: "tomcatoperator.io/v1"
14+
kind: Tomcat
15+
metadata:
16+
name: test-tomcat1
17+
spec:
18+
version: 9.0
19+
replicas: 2
20+
```
21+
22+
## Example input for the Webapp
23+
```
24+
apiVersion: "tomcatoperator.io/v1"
25+
kind: Webapp
26+
metadata:
27+
name: sample-webapp1
28+
spec:
29+
tomcat: test-tomcat1
30+
url: http://tomcat.apache.org/tomcat-7.0-doc/appdev/sample/sample.war
31+
contextPath: mysample
32+
```
33+
34+
## Getting started / Testing
35+
36+
The quickest way to try the operator is to run it on your local machine, while it connects to a
37+
local or remote Kubernetes cluster. When you start it, it will use the current kubectl context on
38+
your machine to connect to the cluster.
39+
40+
Before you run it you have to install the CRDs on your cluster by running:
41+
- `kubectl apply -f target/classes/META-INF/fabric8/tomcats.tomcatoperator.io-v1.yml`
42+
- `kubectl apply -f target/classes/META-INF/fabric8/webapps.tomcatoperator.io-v1.yml`
43+
44+
The CRDs are generated automatically from your code by simply adding the `crd-generator-apt`
45+
dependency to your `pom.xml` file.
46+
47+
When the Operator is running you can create some Tomcat Custom Resources. You can find a sample
48+
custom resources in the k8s folder.
49+
50+
If you want the Operator to be running as a deployment in your cluster, follow the below steps.
51+
52+
## Build
53+
54+
You can build the sample using `mvn install jib:dockerBuild` this will produce a Docker image you
55+
can push to the registry of your choice. The JAR file is built using your local Maven and JDK and
56+
then copied into the Docker image.
57+
58+
## Install Operator into cluster
59+
60+
Install the CRDs as shown above if you haven't already, then
61+
run `kubectl apply -f k8s/operator.yaml`. Now you can create Tomcat instances with CRs (see examples
62+
above).
63+
64+
## EventSources
65+
The TomcatController is listening to events about Deployments created by the TomcatOperator by registering a
66+
InformerEventSource with the EventSourceManager. The InformerEventSource will in turn register a watch on
67+
all Deployments managed by the Controller (identified by the `app.kubernetes.io/managed-by` label).
68+
When an event from a Deployment is received we have to identify which Tomcat object does the Deployment
69+
belong to. This is done when the InformerEventSource creates the event.
70+
71+
The TomcatController has to take care of setting the `app.kubernetes.io/managed-by` label on the Deployment so the
72+
InformerEventSource can watch the right Deployments.
73+
The TomcatController also has to set `ownerReference` on the Deployment so later the InformerEventSource can
74+
identify which Tomcat does the Deployment belong to. This is necessary so the frameowork can call the Controller
75+
`createOrUpdate` method correctly.
76+

0 commit comments

Comments
 (0)