History

github-actions 778acb5cad Update dependencies		2024-04-12 06:04:18 +00:00
..
pkg	Update dependencies	2024-04-12 06:04:18 +00:00
.gitignore	Use latest master for controller-runtime	2022-12-10 09:09:56 +02:00
.golangci.yml	Update dependencies	2024-02-04 10:18:19 +02:00
CONTRIBUTING.md	Update vendor	2020-04-11 14:45:29 -04:00
FAQ.md	Update controller-runtime to v0.12.0	2022-05-15 14:33:30 +03:00
LICENSE	Fill out kops controller functionality	2019-09-25 12:04:34 -04:00
Makefile	Update dependencies	2023-08-31 13:53:46 +03:00
OWNERS	Update vendor	2020-04-11 14:45:29 -04:00
OWNERS_ALIASES	Update dependencies	2023-05-20 08:52:18 +03:00
README.md	Hide s2a flags from --help output	2023-05-08 07:35:36 +03:00
RELEASE.md	Update dependencies	2024-02-04 10:18:19 +02:00
SECURITY_CONTACTS	Update dependencies	2023-05-20 08:52:18 +03:00
TMP-LOGGING.md	Use latest master for controller-runtime	2022-12-10 09:09:56 +02:00
VERSIONING.md	Update dependencies	2023-08-31 13:53:46 +03:00
alias.go	Update dependencies	2023-08-31 13:53:46 +03:00
code-of-conduct.md	Fill out kops controller functionality	2019-09-25 12:04:34 -04:00
doc.go	Hide s2a flags from --help output	2023-05-08 07:35:36 +03:00

README.md

Kubernetes controller-runtime Project

The Kubernetes controller-runtime Project is a set of go libraries for building Controllers. It is leveraged by Kubebuilder and Operator SDK. Both are a great place to start for new projects. See Kubebuilder's Quick Start to see how it can be used.

Documentation:

Versioning, Maintenance, and Compatibility

The full documentation can be found at VERSIONING.md, but TL;DR:

Users:

We follow Semantic Versioning (semver)
Use releases with your dependency management to ensure that you get compatible code
The main branch contains all the latest code, some of which may break compatibility (so "normal" go get is not recommended)

Contributors:

All code PR must be labeled with 🐛 (patch fixes), ✨ (backwards-compatible features), or ⚠️ (breaking changes)
Breaking changes will find their way into the next major release, other changes will go into an semi-immediate patch or minor release
For a quick PR template suggesting the right information, use one of these PR templates:

FAQ

See FAQ.md

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: #controller-runtime
Google Group: kubebuilder@googlegroups.com

Contributing

Contributions are greatly appreciated. The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers. The project follows the typical GitHub pull request model. See CONTRIBUTING.md for more details. Before starting any work, please either comment on an existing issue, or file a new one.

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.