Skip to content

Commit a95514a

Browse files
committed
started docs
1 parent d180565 commit a95514a

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

docs/DOCS.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Java Operator SDK - Documentation
2+
3+
## Introduction & Resources on Operators
4+
5+
Operators are easy and simple way to manage resource on Kubernetes clusters but
6+
also outside of the cluster. The goal of this SDK is to allow writing operators in Java by
7+
providing a nice API and handling common issues regarding the operators on framework level.
8+
9+
For an introduction, what is an operator see this [blog post](https://blog.container-solutions.com/kubernetes-operators-explained).
10+
11+
You can read about the common problems what is this operator framework is solving for you [here](https://blog.container-solutions.com/a-deep-dive-into-the-java-operator-sdk).
12+
13+
## Getting Started
14+
15+
The easiest way to get started with SDK is start [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) and
16+
execute one of our [examples](https://github.com/ContainerSolutions/java-operator-sdk/tree/master/samples/webserver)
17+
18+
Note that you don't have to deploy the operator to a Kubernetes clusters as a pod (however you have to apply the CRD).
19+
If you run this example from you favorite IDE, it will pick up the kubeconfig (prepared by minikube) and will start
20+
processing events of custom resources immediately.
21+
22+
<!-- todo add Adam's blogpost here -->
23+
24+
## Controllers
25+
26+
Controllers are where you implement you logic for you operator.
27+
28+
29+
## Spring Boot Support
30+
31+
## Automatic Retries
32+
33+
## Event Processing Details
34+
### Handling Finalizers
35+
### Managing Consistency
36+
### Generation Awareness
37+
### Event Scheduling
38+
### Event Dispatching
39+
40+
## Running The Operator
41+
42+

0 commit comments

Comments
 (0)