A library for creating a Kubernetes Operator
Switch branches/tags
Nothing to show
Clone or download
galexrt Merge pull request #31 from christopherhein/feature/1-10-support
Local Kubeconfig for easier development
Latest commit 3a90049 Oct 7, 2018

README.md

Kubernetes Operator Kit

FOSSA Status

A Kubernetes Operator is a controller for custom resources. The purpose of the operator kit is to provide a common library for implementing operators.

The library originated from the Rook operator but is independent. Much more thought needs to be put into API design, but at least provides the basis for the library with working code.

Features

The operator kit is a simple collection of features that will be useful for operators.

  • CRD handling: creating, retrieving, and watching CRDs on K8s 1.7+
  • TPR handling: creating, retrieving, and watching TPRs on versions prior to 1.7
  • Timing: helpers to timeout when taking too long or retry when when working with kubernetes resources

Roadmap

The operator kit is still in its infancy and needs plenty of work before it is considered stable.

  • Community collaboration on the requirements and design
  • Leader election for HA
  • Tests

The conversation has been started here.

Sample Code

To help you get started, a simple operator with a single custom resource is provided here.

Contributing

Contributions are welcome! See Contributing to get started.

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, help out by opening an issue.

Licensing

The operator kit is under the Apache 2.0 license.

FOSSA Status