README
¶
Kubernetes controller-runtime Project
The Kubernetes controller-runtime Project is a set of go libraries for building Controllers.
Documentation:
- Package overview
- Basic controller using builder
- Creating a manager
- Creating a controller
- Example
main.go
Community, discussion, contribution, and support
Learn how to engage with the Kubernetes community on the community page.
controller-runtime is a subproject of the kubebuilder project in sig apimachinery.
You can reach the maintainers of this project at:
- Slack channel: #kubebuilder
- Google Group: kubebuilder@googlegroups.com
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package pkg provides libraries for building Controllers.
|
Package pkg provides libraries for building Controllers. |
|
admission
Package admission provides functions to manage webhooks certificates.
|
Package admission provides functions to manage webhooks certificates. |
|
admission/cert/generator
Package generator provides an interface and implementation to provision certificates.
|
Package generator provides an interface and implementation to provision certificates. |
|
admission/cert/writer
Package writer provides method to ensure each webhook has a working certificate and private key in the right place for consuming.
|
Package writer provides method to ensure each webhook has a working certificate and private key in the right place for consuming. |
|
builder
Package builder provides wraps other controller-runtime libraries and exposes simple patterns for building common Controllers.
|
Package builder provides wraps other controller-runtime libraries and exposes simple patterns for building common Controllers. |
|
client/config
Package config contains libraries for initializing rest configs for talking to the Kubernetes API
|
Package config contains libraries for initializing rest configs for talking to the Kubernetes API |
|
client/fake
Package fake provides a fake client for testing.
|
Package fake provides a fake client for testing. |
|
controller
Package controller provides types and functions for building Controllers.
|
Package controller provides types and functions for building Controllers. |
|
controller/controllertest
Package controllertest contains fake informers for testing controllers
|
Package controllertest contains fake informers for testing controllers |
|
controller/controllerutil
Package controllerutil contains utility functions for working with and implementing Controllers.
|
Package controllerutil contains utility functions for working with and implementing Controllers. |
|
envtest
Package envtest provides libraries for integration testing by starting a local control plane
|
Package envtest provides libraries for integration testing by starting a local control plane |
|
event
Package event contains the definitions for the Event types produced by source.Sources and transformed into reconcile.Requests by handler.EventHandler.
|
Package event contains the definitions for the Event types produced by source.Sources and transformed into reconcile.Requests by handler.EventHandler. |
|
handler
Package handler defines EventHandlers that enqueue reconcile.Requests in response to Create, Update, Deletion Events observed from Watching Kubernetes APIs.
|
Package handler defines EventHandlers that enqueue reconcile.Requests in response to Create, Update, Deletion Events observed from Watching Kubernetes APIs. |
|
internal/admission
Package admission provides libraries for creating admission webhooks.
|
Package admission provides libraries for creating admission webhooks. |
|
manager
Package manager is required to create Controllers and provides shared dependencies such as clients, caches, schemes, etc.
|
Package manager is required to create Controllers and provides shared dependencies such as clients, caches, schemes, etc. |
|
patterns/application
Package application documents patterns for building Controllers to manage specific applications.
|
Package application documents patterns for building Controllers to manage specific applications. |
|
patterns/operator
Package operator serves to redirect users to the application package.
|
Package operator serves to redirect users to the application package. |
|
predicate
Package predicate defines Predicates used by Controllers to filter Events before they are provided to EventHandlers.
|
Package predicate defines Predicates used by Controllers to filter Events before they are provided to EventHandlers. |
|
reconcile
Package reconcile defines the Reconciler interface to implement Kubernetes APIs.
|
Package reconcile defines the Reconciler interface to implement Kubernetes APIs. |
|
runtime/inject
Package inject defines interfaces and functions for propagating dependencies from a ControllerManager to the components registered with it.
|
Package inject defines interfaces and functions for propagating dependencies from a ControllerManager to the components registered with it. |
|
runtime/log
Package log contains utilities for fetching a new logger when one is not already available.
|
Package log contains utilities for fetching a new logger when one is not already available. |
|
runtime/signals
Package signals contains libraries for handling signals to shutdown the system.
|
Package signals contains libraries for handling signals to shutdown the system. |
|
source
Package source provides event streams provided to Controllers through Controller.Watch.
|
Package source provides event streams provided to Controllers through Controller.Watch. |
Click to show internal directories.
Click to hide internal directories.