operatorkit

Package operatorkit implements an opinionated framework for developing Kubernetes operators. It emerged as we extracted common functionality from a number of the operators we developed at Giant Swarm. The goal of this library is to provide a common structure for operator projects and to encapsulate best practices we learned while running operators in production.

Features

• CRD primitives to reliably create, watch and delete custom resources, as well as any Kubernetes runtime object.
• Managing finalizers on reconciled objects, making sure the code is executed at least once for each create/delete/update event.
• Guarantees to perform at least one successful deletion event reconciliation to avoid unnecessary, possibly expensive interactions with third party systems.
• Resource wrapping to gain ability of composing resources like middlewares.
• Control Flow Primitives that allow cancellation and repetition of resource implementations.
• Independent packages. It is possible to use only certain parts of the library without being bound to all primitives it provides.
• Ability to change behaviour that is often specific to an organization like logging and error handling.
• Pause Reconciliation using pausing annotations on runtime objects to stop and resume reconciliation on demand.

Roadmap

For future planned features and breaking changes see the roadmap.

Docs

• Control Flow Primitives
• File Structure
• Keeping Reconciliation Loops Short
• Managing CR Status Sub Resources
• Metrics Provider
• Pause Reconciliation
• Troubleshooting
• Using Finalizers
• Using Kubernetes Events

Integration Tests

You can simply create a kind cluster to run the integration tests.

kind create cluster

The tests need to figure out how to connect to the Kubernetes cluster. Therefore we need to set an environment variable pointing to your local kube config.

export E2E_KUBECONFIG=~/.kube/config

Now you can easily run the integration tests.

go test -v -tags=k8srequired ./integration/test/<test-name>

Once you did your testing you may want to delete your local test cluster again.

kind delete cluster

Projects using operatorkit

Giant Swarm operators using operatorkit.

Example

For a detailed state of art implementation, please see giantswarm/aws-operator.

Contributing & Reporting Bugs

See CONTRIBUTING for details on submitting patches, the contribution workflow as well as reporting bugs.

License

operatorkit is under the Apache 2.0 license. See the LICENSE file for details.