Repository files navigation

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 implementingconversion hooks and dynamic admission controllers are supported as a separate project(and much more, see related projects section).

Under the hood it uses the excellentFabric8 Kubernetes Client,which provides additional facilities, like generating CRD from source code (and vice versa).

Java Operator SDK is a CNCF project as part ofOperator Framework.

Documentation can be found on theJOSDK WebSite.

Join us onDiscord or feel free to ask any question onKubernetes Slack Operator Channel

Meet us every other Tuesday 15:00 CEST (from 29.10.2024) at ourcommunity meeting onZoom(Password in the Discord channel, or just ask for it there!)

See thecontribution guide on the website.

Java Operator SDK is a higher level framework and related tooling to support writing Kubernetes Operators in Java.It makes it easy to implement best practices and patterns for an Operator. Features include:

• Optimal handling Kubernetes API events
• Handling dependent resources, related events, and caching.
• Automatic Retries
• Smart event scheduling
• Easy to use Error Handling
• ... and everything that a batteries included framework needs

For all features and their usage see therelated section on the website.

• Quarkus Extension:https://github.com/quarkiverse/quarkus-operator-sdk
• Spring Boot Starter:https://github.com/java-operator-sdk/operator-framework-spring-boot-starter
• Kubernetes Glue Operator:https://github.com/java-operator-sdk/kubernetes-glue-operatorMeta-operator that builds upon to use JOSDK Workflows and Dependent Resources features andallows to create operators by simply applying a custom resource, thus, is a language independent way.
• Kubernetes Webhooks Framework:https://github.com/java-operator-sdk/kubernetes-webooks-frameworkFramework to implement Admission Controllers and Conversion Hooks.
• Operator SDK plugin:https://github.com/operator-framework/java-operator-plugins

While we know of multiple projects using JOSDK in production, we don't want to presume theseprojects want to advertise that fact here. For this reason, we ask that if you'd like your projectto be featured in this section, please open a PR, adding a link to and short description of yourproject, as shown below:

• kroxylicious Kafka proxy operator
• ExposedApp operator: a sample operatorwritten to illustrate JOSDK concepts and its Quarkus extension in the"Write KubernetesOperators in Java with the Java Operator SDK" blog series.
• Keycloak operator: the officialKeycloak operator, built with Quarkus and JOSDK.
• Apache Flink Kubernetes operator is the market leader among Flink operators.
• Apache Spark Kubernetes Operator emerging operator for Spark.
• Strimzi Access operator. While the core Strimzi operator development predates
  JOSDK, but new components like the Access operator is using the framework.
• EureKubeOperator: integrates service discovery of Eureka and Kubernetes using the framework - developed by 11street. It is not released as an open source yet but is very interesting to read about this problem and how it is solved by an operator written with JOSDK.
• Locust k8s operator: Cloud native solution to run performance tests on any Kubernetes cluster.
• Strimzi Schema Registry Operator: A Schema Registry Operator based on JOSDK for running the Confluent Schema Registry with a Strimzi-based Kafka cluster.
• Airflow Dag Operator: Use JOSDK(Quarkus Extension) to replace Airflow Git Sync strategy. The main idea of the project is to start a synchronization container on each airflow pod to synchronize the DAG/files into the DAG folder.
• Glasskube Operator: simplifies the deployment, maintenance and upgrade of popular open source business tools. It is written in Kotlin and uses the JOSDK and fabric8 Kubernetes client with Kotlin-based DSL.
• Debezium Operator: Debezium Operator adds Change-Data-Capture capabilities to your Kubernetes or Openshift cluster by providing an easy way to run and manageDebezium Server instances.