Build Kubernetes Operators in Java without hassle. Inspired by operator-sdk.
| S.No. | Contents |
|---|---|
| 1. | Features |
| 2. | Why build your own Operator? |
| 3. | Roadmap |
| 4. | Join us on Discord! |
| 5. | User Guide |
| 6. | Usage |
| 7. | Spring Boot |
- Framework for handling Kubernetes API events
- Automatic registration of Custom Resource watches
- Retry action on failure
- Smart event scheduling (only handle the latest event for the same resource)
Check out this blog post about the non-trivial yet common problems needed to be solved for every operator. In case you are interested how to handle more complex scenarios take a look on event sources.
- Infrastructure automation using the power and flexibility of Java. See blog post.
- Provisioning of complex applications - avoiding Helm chart hell
- Integration with Cloud services - e.g. Secret stores
- Safer deployment of applications - only expose cluster to users by Custom Resources
- Testing of the framework and all samples while running on a real cluster.
- Generate a project skeleton
- Generate Java classes from CRD
- Integrate with Quarkus (including native image build)
- Integrate with OLM (Operator Lifecycle Manager)
You can (will) find detailed documentation here. Note that these docs are currently in progress.
⚠️ 1.7.0 Upgrade The 1.7.0 upgrade comes with big changes due to the update to the 5.0.0 version of the fabric8 Kubernetes client. While this should improve the user experience quite nicely, there are a couple of things to be aware of when upgrading from a previous version as detailed below.
- The quarkus extension has been moved to the quarkiverse and is now found at https://github.com/quarkiverse/quarkus-operator-sdk
Doneableclasses have been removed along with all the involved complexityControllerannotation has been simplified: thecrdNamefield has been removed as that value is computed from the associated custom resource implementation- Custom Resource implementation classes now need to be annotated with
GroupandVersionannotations so that they can be identified properly. Optionally, they can also be annotated withKind(if the name of the implementation class doesn't match the desired kind) andPluralif the plural version cannot be automatically computed (or the default computed version doesn't match your expectations). - The
CustomResourceclass that needs to be extended is now parameterized with spec and status types, so you can have an empty default implementation that does what you'd expect. If you don't need a status, usingVoidfor the associated type should work. - Custom Resources that are namespace-scoped need to implement the
Namespacedinterface so that the client can generate the proper URLs. This means, in particular, thatCustomResourceimplementations that do not implementNamespacedare considered cluster-scoped. As a consequence, theisClusterScopedmethod/field has been removed from the appropriate classes (Controllerannotation, in particular) as this is now inferred from theCustomResourcetype associated with yourController.
Many of these changes might not be immediately apparent but will result in 404 errors when
connecting to the cluster. Please check that the Custom Resource implementations are properly
annotated and that the value corresponds to your CRD manifest. If the namespace appear to be missing
in your request URL, don't forget that namespace-scoped Custom Resources need to implement
the Namescaped interface.
We have several sample Operators under the samples directory:
- pure-java: Minimal Operator implementation which only parses the Custom Resource and prints to stdout. Implemented with and without Spring Boot support. The two samples share the common module.
- spring-boot-plain/auto-config: Samples showing integration with Spring Boot.
- quarkus: Minimal application showing automatic configuration / injection of Operator / Controllers.
And there are more samples in the standalone samples repo:
- webserver: Simple example creating an NGINX webserver from a Custom Resource containing HTML code.
- mysql-schema: Operator managing schemas in a MySQL database.
- tomcat: Operator with two controllers, managing Tomcat instances and Webapps for these.
Add dependency to your project with Maven:
<dependency>
<groupId>io.javaoperatorsdk</groupId>
<artifactId>operator-framework</artifactId>
<version>{see https://search.maven.org/search?q=a:operator-framework for latest version}</version>
</dependency>Or alternatively with Gradle, which also requires declaring the SDK as an annotation processor to generate the mappings between controllers and custom resource classes:
dependencies {
implementation "io.javaoperatorsdk:operator-framework:${javaOperatorVersion}"
annotationProcessor "io.javaoperatorsdk:operator-framework:${javaOperatorVersion}"
}Once you've added the dependency, define a main method initializing the Operator and registering a controller.
public class Runner {
public static void main(String[] args) {
Operator operator = new Operator(new DefaultKubernetesClient(),
DefaultConfigurationService.instance());
operator.register(new WebServerController());
}
}The Controller implements the business logic and describes all the classes needed to handle the CRD.
@Controller
public class WebServerController implements ResourceController<WebServer> {
@Override
public DeleteControl deleteResource(CustomService resource, Context<WebServer> context) {
// ... your logic ...
return DeleteControl.DEFAULT_DELETE;
}
// Return the changed resource, so it gets updated. See javadoc for details.
@Override
public UpdateControl<CustomService> createOrUpdateResource(CustomService resource, Context<WebServer> context) {
// ... your logic ...
return UpdateControl.updateStatusSubResource(resource);
}
}A sample custom resource POJO representation
@Group("sample.javaoperatorsdk")
@Version("v1")
public class WebServer extends CustomResource<WebServerSpec, WebServerStatus> implements Namespaced {}
public class WebServerSpec {
private String html;
public String getHtml() {
return html;
}
public void setHtml(String html) {
this.html = html;
}
}The operator will, by default, query the deployed CRDs to check that the CustomResource
implementations match what is known to the cluster. This requires an additional query to the cluster
and, sometimes, elevated privileges for the operator to be able to read the CRDs from the cluster.
This validation is mostly meant to help users new to operator development get started and avoid
common mistakes. Advanced users or production deployments might want to skip this step. This is done
by setting
the CHECK_CRD_ENV_KEY environment variable to false. Quarkus users can also add
quarkus.operator-sdk.check-crd-and-validate-local-model=false to their application.properties for the
same purpose. Spring Boot users can set the property javaoperatorsdk.check-crd-and-validate-local-model
to false.
To automatically generate CRD manifests from your annotated Custom Resource classes, you only need to add the following dependencies to your project:
<dependency>
<groupId>io.fabric8</groupId>
<artifactId>crd-generator</artifactId>
<scope>compile</scope>
</dependency>
<!-- This dependency will not be needed anymore in a future release of the kubernetes-client -->
<dependency>
<groupId>io.fabric8</groupId>
<artifactId>kubernetes-model-common</artifactId>
</dependency>The CRD will be generated in target/classes/META-INF/fabric8 (or
in target/test-classes/META-INF/fabric8, if you use the test scope) with the CRD name suffixed
by the generated spec version. For example, a CR using the java-operator-sdk.io group with
a mycrs plural form will result in 2 files:
mycrs.java-operator-sdk.io-v1.ymlmycrs.java-operator-sdk.io-v1beta1.yml
A Quarkus extension is also provided to ease the development of Quarkus-based operators.
Add this dependency to your project:
<dependency>
<groupId>io.quarkiverse.operatorsdk</groupId>
<artifactId>quarkus-operator-sdk</artifactId>
<version>{see https://search.maven.org/search?q=a:quarkus-operator-sdk for latest version}</version>
</dependency>Create an Application, Quarkus will automatically create and inject a KubernetesClient (or OpenShiftClient), Operator, ConfigurationService and ResourceController instances that your application can use. Below, you can see the minimal code you need to write to get your operator and controllers up and running:
@QuarkusMain
public class QuarkusOperator implements QuarkusApplication {
@Inject Operator operator;
public static void main(String... args) {
Quarkus.run(QuarkusOperator.class, args);
}
@Override
public int run(String... args) throws Exception {
operator.start();
Quarkus.waitForExit();
return 0;
}
}You can also let Spring Boot wire your application together and automatically register the controllers.
Add this dependency to your project:
<dependency>
<groupId>io.javaoperatorsdk</groupId>
<artifactId>operator-framework-spring-boot-starter</artifactId>
<version>{see https://search.maven.org/search?q=a:operator-framework-spring-boot-starter for latest version}</version>
</dependency>Create an Application
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}Adding the following dependency would let you mock the operator for the tests where loading the spring container is necessary, but it doesn't need real access to a Kubernetes cluster.
<dependency>
<groupId>io.javaoperatorsdk</groupId>
<artifactId>operator-framework-spring-boot-starter-test</artifactId>
<version>{see https://search.maven.org/search?q=a:operator-framework-spring-boot-starter for latest version}</version>
</dependency>Mock the operator:
@SpringBootTest
@EnableMockOperator
public class SpringBootStarterSampleApplicationTest {
@Test
void contextLoads() {}
}