You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-42Lines changed: 17 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -3,42 +3,17 @@
3
3
4
4
Build Kubernetes Operators in Java without hassle. Inspired by [operator-sdk](https://github.com/operator-framework/operator-sdk).
5
5
6
-
<table>
7
-
<tr>
8
-
<th>S.No.</th>
9
-
<th>Content</th>
10
-
</tr>
11
-
<tr>
12
-
<td><a href="#1">1.</a></td>
13
-
<td><a href="#Features">Features</a></td>
14
-
</tr>
15
-
<tr>
16
-
<td><a href="#2">2.</a></td>
17
-
<td><a href="#Operator">Why build your own Operator</a></td>
18
-
</tr>
19
-
<tr>
20
-
<td><a href="#3">3.</a></td>
21
-
<td><a href="#Roadmap">Roadmap</a></td>
22
-
</tr>
23
-
<tr>
24
-
<td><a href="#4">4.</a></td>
25
-
<td><a href="#Discord">Join us on Discord!</a></td>
26
-
</tr>
27
-
<tr>
28
-
<td><a href="#5">5.</a></td>
29
-
<td><a href="#Guide">User Guide</a></td>
30
-
</tr>
31
-
<tr>
32
-
<td><a href="#6">6.</a></td>
33
-
<td><a href="#Usage">Usage</a></td>
34
-
</tr>
35
-
<tr>
36
-
<td><a href="#7">7.</a></td>
37
-
<td><a href="#Boot">Spring Boot</a></td>
38
-
</tr>
39
-
</table>
40
-
41
-
#### <aid="Features"><aid="1">Features</a></a>
6
+
| S.No. | Contents |
7
+
| ----- | -------- |
8
+
| 1. | Features |
9
+
| 2. | Why build your own Operator? |
10
+
| 3. | Roadmap |
11
+
| 4. | Join us on Discord! |
12
+
| 5. | User Guide |
13
+
| 6. | Usage |
14
+
| 7. | Spring Boot |
15
+
16
+
#### Features
42
17
* Framework for handling Kubernetes API events
43
18
* Registering Custom Resource watches
44
19
* Retry action on failure
@@ -47,29 +22,29 @@ Build Kubernetes Operators in Java without hassle. Inspired by [operator-sdk](ht
47
22
Check out this [blog post](https://blog.container-solutions.com/a-deep-dive-into-the-java-operator-sdk)
48
23
about the non-trivial yet common problems needs to be solved for every operator.
49
24
50
-
#### <aid="Operator"><aid="2">Why build your own Operator?</a></a>
25
+
#### Why build your own Operator?
51
26
* Infrastructure automation using the power and flexibility of Java. See [blog post](https://blog.container-solutions.com/cloud-native-java-infrastructure-automation-with-kubernetes-operators).
52
27
* Provisioning of complex applications - avoiding Helm chart hell
53
28
* Integration with Cloud services - e.g. Secret stores
54
29
* Safer deployment of applications - only expose cluster to users by Custom Resources
55
30
56
-
#### <aid="Roadmap"><aid="3">Roadmap</a></a>
31
+
#### Roadmap
57
32
* Testing of the framework and all samples while running on a real cluster.
58
33
* Generate a project skeleton
59
34
* Generate Java classes from CRD definion (and/or the other way around)
60
35
* Integrate with Quarkus (including native image build)
61
36
* Integrate with OLM (Operator Lifecycle Manager)
62
37
63
-
#### <aid="Discord"><aid="4">Join us on Discord!</a></a>
38
+
#### Join us on Discord!
64
39
65
40
[Discord Invite Link](https://discord.gg/DacEhAy)
66
41
67
-
#### <aid="Guide"><aid="5">User Guide</a></a>
42
+
#### User Guide
68
43
69
44
You can (will) find detailed documentation [here](docs/DOCS.md).
70
45
Note that these docs are currently in progress.
71
46
72
-
#### <aid="Usage"><aid="6">Usage</a></a>
47
+
#### Usage
73
48
74
49
We have several sample Operators under the samples directory:
75
50
**basic*: Minimal Operator implementation which only parses the Custom Resource and prints to stdout.
@@ -162,7 +137,7 @@ public class WebServerSpec {
162
137
}
163
138
```
164
139
165
-
#### <aid="Boot"><aid="7">Spring Boot</a></a>
140
+
#### Spring Boot
166
141
167
142
You can also let Spring Boot wire your application together and automatically register the controllers.
0 commit comments