Skip to content

About

Tools to use with the controller-runtime libraries

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

867 stars

Watchers

12 watching

Forks

Go Reference Go Report Card

Kubernetes controller-tools Project

The Kubernetes controller-tools Project is a set of go libraries for building Controllers.

Development

Clone this project, and iterate on changes by running ./test.sh.

Releasing and Versioning

See VERSIONING.md.

Compatibility

Every minor version of controller-tools (CT) has been tested with a specific minor version of client-go. A controller-tools minor version may be compatible with other client-go minor versions, but this is by chance and neither supported nor tested. In general, we create one minor version of controller-tools for each minor version of client-go and other k8s.io/* dependencies.

The minimum Go version of controller-tools is the highest minimum Go version of our Go dependencies. Usually, this will be identical to the minimum Go version of the corresponding k8s.io/* dependencies.

Compatible k8s.io/*, client-go and minimum Go versions can be looked up in our go.mod file.

k8s.io/*, client-go minimum Go version
CT v0.21 v0.36 1.26
CT v0.20 v0.35 1.25
CT v0.19 v0.34 1.24

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

controller-tools is a subproject of sig apimachinery.

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.

AI Guidance

This project follows the Kubernetes AI guidance:

Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. If you used AI tools in preparing your PR, you must disclose this in the description of your PR. For example, including “This PR was written in part with the assistance of generative AI,” in the PR description is sufficient.

Listing AI tooling as a co-author, co-signing commits using an AI tool, or using the assisted-by, co-developed or similar commit trailer is not allowed.

All contributions must follow the contributions policies and use commit messages that align with the policy.

Large AI generated PRs and AI generated commit messages are not allowed.

Do not leave the first review of AI generated changes to the reviewers. Verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed.

When responding to review comments, you must do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you do not engage directly with reviewers, the PR will be closed.

About

Tools to use with the controller-runtime libraries

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

867 stars

Watchers

12 watching

Forks

Releases

Packages

Used by

Contributors

Languages