Skip to content

Commit ae916dd

Browse files
Update README.md
1 parent 9bd3c6c commit ae916dd

File tree

1 file changed

+17
-42
lines changed

1 file changed

+17
-42
lines changed

README.md

Lines changed: 17 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -3,42 +3,17 @@
33

44
Build Kubernetes Operators in Java without hassle. Inspired by [operator-sdk](https://github.com/operator-framework/operator-sdk).
55

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-
#### <a id="Features"><a id="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
4217
* Framework for handling Kubernetes API events
4318
* Registering Custom Resource watches
4419
* Retry action on failure
@@ -47,29 +22,29 @@ Build Kubernetes Operators in Java without hassle. Inspired by [operator-sdk](ht
4722
Check out this [blog post](https://blog.container-solutions.com/a-deep-dive-into-the-java-operator-sdk)
4823
about the non-trivial yet common problems needs to be solved for every operator.
4924

50-
#### <a id="Operator"><a id="2">Why build your own Operator?</a></a>
25+
#### Why build your own Operator?
5126
* 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).
5227
* Provisioning of complex applications - avoiding Helm chart hell
5328
* Integration with Cloud services - e.g. Secret stores
5429
* Safer deployment of applications - only expose cluster to users by Custom Resources
5530

56-
#### <a id="Roadmap"><a id="3">Roadmap</a></a>
31+
#### Roadmap
5732
* Testing of the framework and all samples while running on a real cluster.
5833
* Generate a project skeleton
5934
* Generate Java classes from CRD definion (and/or the other way around)
6035
* Integrate with Quarkus (including native image build)
6136
* Integrate with OLM (Operator Lifecycle Manager)
6237

63-
#### <a id="Discord"><a id="4">Join us on Discord!</a></a>
38+
#### Join us on Discord!
6439

6540
[Discord Invite Link](https://discord.gg/DacEhAy)
6641

67-
#### <a id="Guide"><a id="5">User Guide</a></a>
42+
#### User Guide
6843

6944
You can (will) find detailed documentation [here](docs/DOCS.md).
7045
Note that these docs are currently in progress.
7146

72-
#### <a id="Usage"><a id="6">Usage</a></a>
47+
#### Usage
7348

7449
We have several sample Operators under the samples directory:
7550
* *basic*: Minimal Operator implementation which only parses the Custom Resource and prints to stdout.
@@ -162,7 +137,7 @@ public class WebServerSpec {
162137
}
163138
```
164139

165-
#### <a id="Boot"><a id="7">Spring Boot</a></a>
140+
#### Spring Boot
166141

167142
You can also let Spring Boot wire your application together and automatically register the controllers.
168143

0 commit comments

Comments
 (0)