Skip to content

docs: readme improvements #1825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 20, 2023
Merged

docs: readme improvements #1825

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2681191
docs: readme improvements, add jenvtest
csviri Mar 20, 2023
2ef7872
wip
csviri Mar 20, 2023
7c7a1ce
improvements
csviri Mar 20, 2023
cc0414e
wording
csviri Mar 20, 2023
00259d5
Update README.md
csviri Mar 20, 2023
58c2242
Update README.md
csviri Mar 20, 2023
2780ce5
description improvements
csviri Mar 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,19 @@

# Build Kubernetes Operators in Java Without Hassle

Java Operator SDK is a production-ready framework that makes implementing Kubernetes Operators in Java easy.

It provides a controller runtime, support for testing operators, and related tooling. In addition to that implementing
conversion hooks and dynamic admission controllers are supported as a separate project
(and much more, see related projects section).

Under the hood it uses the excellent [Fabric8 Kubernetes Client](https://github.com/fabric8io/kubernetes-client),
which provides additional facilities, like generating CRD from source code (and vice versa).

## Documentation

Documentation can be found on the **[JOSDK WebSite](https://javaoperatorsdk.io/)**.

It's getting better every day! :)

## Contact us

Join us on [Discord](https://discord.gg/DacEhAy) or feel free to ask any question on
Expand Down Expand Up @@ -40,13 +47,13 @@ For all features and their usage see the [related section on the website](https:

## Related Projects

Operator SDK plugin: https://github.com/operator-framework/java-operator-plugins

Quarkus Extension: https://github.com/quarkiverse/quarkus-operator-sdk

Spring Boot Starter: https://github.com/java-operator-sdk/operator-framework-spring-boot-starter

Framework to implement Admission Controllers and Conversion Hooks: https://github.com/java-operator-sdk/kubernetes-webooks-framework
* Quarkus Extension: https://github.com/quarkiverse/quarkus-operator-sdk
* Spring Boot Starter: https://github.com/java-operator-sdk/operator-framework-spring-boot-starter
* jenvtest: https://github.com/java-operator-sdk/jenvtest
Support for integration testing against Kubernetes API Server in a lightweight manner
* Kubernetes Webhooks Framework: https://github.com/java-operator-sdk/kubernetes-webooks-framework
Framework to implement Admission Controllers and Conversion Hooks.
* Operator SDK plugin: https://github.com/operator-framework/java-operator-plugins

## Projects using JOSDK

Expand Down