README
¶
kubebuilder-declarative-pattern
kubebuilder-declarative-pattern provides a set of tools for building declarative cluster operators with kubebuilder. Declarative operators provide a fast path to orchestrating Kubernetes deployments to enable domain experts to focus their component instead of re-answering questions like 'how do I get this YAML into the cluster?' or 'how do I update it?'.
Development
Running Smoke Tests
Smoke tests are provided to ensure basic functinality of the framework against example operators. They should be ran as part of significant code changes. The tests require a running Kubernetes cluster to be targeted from the local machine and write access to a GCR bucket.
cd hack
IMG=<a writeable image path, eg, gcr.io/my-project/controller:latest> go run smoketest.go
Documentation
- Building an Operator (walkthrough)
- Pattern Documentation
- Managing Addons with Operators (Video, KubeCon'18)
Community, discussion, contribution, and support
Learn how to engage with the Kubernetes community on the community page.
You can reach the maintainers of this project at:
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Documentation
¶
Overview ¶
Package kubebuilderdeclarativepattern provides tools to construct declarative Kubernetes operators to manage the lifecycle of a deployment.
Getting Started ¶
Follow the project documentation for a getting started guide: - https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/tree/master/docs
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
patterns
The patterns package contains tools for building operators with http://sigs.k8s.io/controller-runtime/ See the subpackages for specific pattern implementations.
|
The patterns package contains tools for building operators with http://sigs.k8s.io/controller-runtime/ See the subpackages for specific pattern implementations. |
|
patterns/addon
The addon package contains tools opinionated for managing Kubernetes cluster addons.
|
The addon package contains tools opinionated for managing Kubernetes cluster addons. |
|
patterns/addon/pkg/apis/v1alpha1
The v1alpha1 API provides a set of common fields for addon objects.
|
The v1alpha1 API provides a set of common fields for addon objects. |
|
patterns/addon/pkg/loaders
The loaders package implements loading of raw kubernetes manifests based off of the CommonSpec of an Addon object.
|
The loaders package implements loading of raw kubernetes manifests based off of the CommonSpec of an Addon object. |
|
patterns/addon/pkg/status
The status package provides implementations for discovering and updating the CommonStatus on an Addon.
|
The status package provides implementations for discovering and updating the CommonStatus on an Addon. |
|
patterns/declarative
application.go manages an Application[1] [1] https://github.com/kubernetes-sigs/application The declarative package contains tools and a controller compatible with http://sigs.k8s.io/controller-runtime to manage a Kubernetes deployment based off of a instance of a CustomResource in the cluster.
|
application.go manages an Application[1] [1] https://github.com/kubernetes-sigs/application The declarative package contains tools and a controller compatible with http://sigs.k8s.io/controller-runtime to manage a Kubernetes deployment based off of a instance of a CustomResource in the cluster. |