README
¶
Documentation
Docs can be found on the Operator SDK website.
Overview
This project is a component of the Operator Framework, an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the introduction blog post.
Operators make it easy to manage complex stateful applications on top of Kubernetes. However writing an operator today can be difficult because of challenges such as using low level APIs, writing boilerplate, and a lack of modularity which leads to duplication.
The Operator SDK is a framework that uses the controller-runtime library to make writing operators easier by providing:
- High level APIs and abstractions to write the operational logic more intuitively
- Tools for scaffolding and code generation to bootstrap a new project fast
- Extensions to cover common operator use cases
License
Operator SDK is under Apache 2.0 license. See the LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
hack
|
|
|
images
|
|
|
internal
|
|
|
generate/gen
Code adapted from: https://github.com/kubernetes-sigs/controller-tools/blob/6eef398/cmd/controller-gen/main.go
|
Code adapted from: https://github.com/kubernetes-sigs/controller-tools/blob/6eef398/cmd/controller-gen/main.go |
|
olm
Package olm provides an API to install, uninstall, and check the status of an Operator Lifecycle Manager installation.
|
Package olm provides an API to install, uninstall, and check the status of an Operator Lifecycle Manager installation. |
|
olm/client
Package olm provides an API to install, uninstall, and check the status of an Operator Lifecycle Manager installation.
|
Package olm provides an API to install, uninstall, and check the status of an Operator Lifecycle Manager installation. |
|
pkg
|
|
|
ansible/watches
Package watches provides the structures and functions for mapping a GroupVersionKind to an Ansible playbook or role.
|
Package watches provides the structures and functions for mapping a GroupVersionKind to an Ansible playbook or role. |
|
apis/scorecard/v1alpha2
Package v1alpha2 contains API Schema definitions for the cache v1alpha2 API group +k8s:deepcopy-gen=package,register +groupName=osdk.openshift.io
|
Package v1alpha2 contains API Schema definitions for the cache v1alpha2 API group +k8s:deepcopy-gen=package,register +groupName=osdk.openshift.io |
|
apis/scorecard/v1alpha3
Package v1alpha3 contains API Schema definitions for the cache v1alpha3 API group
|
Package v1alpha3 contains API Schema definitions for the cache v1alpha3 API group |
|
helm/client
Package client provides helper functions for API clients used by the helm operator.
|
Package client provides helper functions for API clients used by the helm operator. |
|
helm/controller
Package controller provides functions for creating and registering a Helm controller with a `controller-runtime` manager.
|
Package controller provides functions for creating and registering a Helm controller with a `controller-runtime` manager. |
|
helm/internal/types
Package types contains types used by various components of the Helm operator
|
Package types contains types used by various components of the Helm operator |
|
helm/release
Package release provides interfaces and default implementations for a Helm release manager, which is used by the Helm controller and reconciler to manage Helm releases in a cluster based on watched custom resources.
|
Package release provides interfaces and default implementations for a Helm release manager, which is used by the Helm controller and reconciler to manage Helm releases in a cluster based on watched custom resources. |
|
leader
Package leader implements Leader For Life, a simple alternative to lease-based leader election.
|
Package leader implements Leader For Life, a simple alternative to lease-based leader election. |
|
test
|
|
|
test-framework
Module
|
|
Click to show internal directories.
Click to hide internal directories.