https://github.com/rook/operator-kit

A library for creating a Kubernetes Operator
https://github.com/rook/operator-kit

cncf kubernetes kubernetes-controller kubernetes-operator

Last synced: 3 months ago
JSON representation

A library for creating a Kubernetes Operator

• Host: GitHub
• URL: https://github.com/rook/operator-kit
• Owner: rook
• License: apache-2.0
• Archived: true
• Created: 2017-06-28T18:15:05.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-10-05T21:53:26.000Z (over 3 years ago)
• Last Synced: 2024-08-02T01:25:54.268Z (6 months ago)
• Topics: cncf, kubernetes, kubernetes-controller, kubernetes-operator
• Language: Go
• Size: 110 KB
• Stars: 278
• Watchers: 61
• Forks: 51
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - rook/operator-kit - A library for creating a Kubernetes Operator (Go)
• awesome-cloud-native - operator-kit - A library for creating a Kubernetes Operator. (Framework)

README

        

## Kubernetes Operator Kit

> **This repo is deprecated in favor of other libraries and tools such as the [Controller Runtime](https://github.com/kubernetes-sigs/controller-runtime) or [Operator SDK](https://sdk.operatorframework.io/)**.

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](https://docs.google.com/document/d/1NJhFcNezJyLM952eaYVcdfIQFQYWsAx4oTaA82-Frdk).

## Sample Code

To help you get started, a simple operator with a single custom resource is provided [here](sample-operator/README.md).

## Contributing

Contributions are welcome! See [Contributing](CONTRIBUTING.md) to get started.

## Report a Bug

For filing bugs, suggesting improvements, or requesting new features, help out by opening an [issue](https://github.com/rook/operator-kit/issues).

## Licensing

The operator kit is under the Apache 2.0 license.

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Frook%2Foperator-kit.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Frook%2Foperator-kit?ref=badge_large)