# kubebuilder **Repository Path**: kcdevops/kubebuilder ## Basic Information - **Project Name**: kubebuilder - **Description**: Kubebuilder 是一个使用自定义资源定义 （CRD） 构建 Kubernetes API 的框架。 类似于 Ruby on Rails 和 SpringBoot 等 Web 开发框架， 它提高了速度并降低了管理的复杂性在 Go 中快速构建和发布 Kubernetes API 的开发人员。https://cloudnative.to/kubebuilder/ - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: https://kubebuilder.io/ - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2023-03-06 - **Last Updated**: 2024-03-23 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README [![Lint](https://github.com/kubernetes-sigs/kubebuilder/actions/workflows/lint.yml/badge.svg)](https://github.com/kubernetes-sigs/kubebuilder/actions/workflows/lint.yml) [![Unit tests](https://github.com/kubernetes-sigs/kubebuilder/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/kubernetes-sigs/kubebuilder/actions/workflows/unit-tests.yml) [![Go Report Card](https://goreportcard.com/badge/sigs.k8s.io/kubebuilder)](https://goreportcard.com/report/sigs.k8s.io/kubebuilder) [![Coverage Status](https://coveralls.io/repos/github/kubernetes-sigs/kubebuilder/badge.svg?branch=master)](https://coveralls.io/github/kubernetes-sigs/kubebuilder?branch=master) [![Latest release](https://badgen.net/github/release/kubernetes-sigs/kubebuilder)](https://github.com/kubernetes-sigs/kubebuilder/lreleases) ## Kubebuilder Kubebuilder is a framework for building Kubernetes APIs using [custom resource definitions (CRDs)](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions). Similar to web development frameworks such as *Ruby on Rails* and *SpringBoot*, Kubebuilder increases velocity and reduces the complexity managed by developers for rapidly building and publishing Kubernetes APIs in Go. It builds on top of the canonical techniques used to build the core Kubernetes APIs to provide simple abstractions that reduce boilerplate and toil. Kubebuilder does **not** exist as an example to *copy-paste*, but instead provides powerful libraries and tools to simplify building and publishing Kubernetes APIs from scratch. It provides a plugin architecture allowing users to take advantage of optional helpers and features. To learn more about this see the [Plugin section][plugin-section]. Kubebuilder is developed on top of the [controller-runtime][controller-runtime] and [controller-tools][controller-tools] libraries. ### Kubebuilder is also a library Kubebuilder is extensible and can be used as a library in other projects. [Operator-SDK][operator-sdk] is a good example of a project that uses Kubebuilder as a library. [Operator-SDK][operator-sdk] uses the plugin feature to include non-Go operators _e.g. operator-sdk's Ansible and Helm-based language Operators_. To learn more see [how to create your own plugins][your-own-plugins]. ### Installation It is strongly recommended that you use a released version. Release binaries are available on the [releases](https://github.com/kubernetes-sigs/kubebuilder/releases) page. Follow the [instructions](https://book.kubebuilder.io/quick-start.html#installation) to install Kubebuilder. ## Getting Started See the [Getting Started](https://book.kubebuilder.io/quick-start.html) documentation. ![Quick Start](docs/gif/kb-demo.v3.11.1.svg) Also, ensure that you check out the [Deploy Image](https://book.kubebuilder.io/plugins/deploy-image-plugin-v1-alpha.html) Plugin. This plugin allows users to scaffold API/Controllers to deploy and manage an Operand (image) on the cluster following the guidelines and best practices. It abstracts the complexities of achieving this goal while allowing users to customize the generated code. ## Documentation Check out the Kubebuilder [book](https://book.kubebuilder.io). ## Resources - Kubebuilder Book: [book.kubebuilder.io](https://book.kubebuilder.io) - GitHub Repo: [kubernetes-sigs/kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) - Slack channel: [#kubebuilder](https://slack.k8s.io/#kubebuilder) - Google Group: [kubebuilder@googlegroups.com](https://groups.google.com/forum/#!forum/kubebuilder) - Design Documents: [designs](designs/) - Plugin: [plugins][plugin-section] ## Motivation Building Kubernetes tools and APIs involves making a lot of decisions and writing a lot of boilerplate. In order to facilitate easily building Kubernetes APIs and tools using the canonical approach, this framework provides a collection of Kubernetes development tools to minimize toil. Kubebuilder attempts to facilitate the following developer workflow for building APIs 1. Create a new project directory 2. Create one or more resource APIs as CRDs and then add fields to the resources 3. Implement reconcile loops in controllers and watch additional resources 4. Test by running against a cluster (self-installs CRDs and starts controllers automatically) 5. Update bootstrapped integration tests to test new fields and business logic 6. Build and publish a container from the provided Dockerfile ## Scope Building APIs using CRDs, Controllers and Admission Webhooks. ## Philosophy See [DESIGN.md](DESIGN.md) for the guiding principles of the various Kubebuilder projects. TL;DR: Provide clean library abstractions with clear and well exampled godocs. - Prefer using go *interfaces* and *libraries* over relying on *code generation* - Prefer using *code generation* over *1 time init* of stubs - Prefer *1 time init* of stubs over forked and modified boilerplate - Never fork and modify boilerplate ## Techniques - Provide higher level libraries on top of low level client libraries - Protect developers from breaking changes in low level libraries - Start minimal and provide progressive discovery of functionality - Provide sane defaults and allow users to override when they exist - Provide code generators to maintain common boilerplate that can't be addressed by interfaces - Driven off of `//+` comments - Provide bootstrapping commands to initialize new packages ## Versioning and Releasing See [VERSIONING.md](VERSIONING.md). ## Troubleshooting - ### Bugs and Feature Requests: If you have what looks like a bug, or you would like to make a feature request, please use the [Github issue tracking system.](https://github.com/kubernetes-sigs/kubebuilder/issues) Before you file an issue, please search existing issues to see if your issue is already covered. - ### Slack For realtime discussion, you can join the [#kubebuilder](https://slack.k8s.io/#kubebuilder) slack channel. Slack requires registration, but the Kubernetes team is open invitation to anyone to register here. Feel free to come and ask any questions. ## 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](CONTRIBUTING.md) for more details. Before starting any work, please either comment on an existing issue, or file a new one. ## Supportability Currently, Kubebuilder officially supports OSX and Linux platforms. So, if you are using a Windows OS you may find issues. Contributions towards supporting Windows are welcome. ### Apple Silicon Apple Silicon (`darwin/arm64`) support begins with the `go/v4` plugin. ## Community Meetings The following meetings happen biweekly: - Kubebuilder Meeting You are more than welcome to attend. For further info join to [kubebuilder@googlegroups.com](https://groups.google.com/g/kubebuilder). Every month, our team meets on the first Thursday at 11:00 PT (Pacific Time) to discuss our progress and plan for the upcoming weeks. [operator-sdk]: https://github.com/operator-framework/operator-sdk [plugin-section]: https://book.kubebuilder.io/plugins/plugins.html [controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime [your-own-plugins]: https://book.kubebuilder.io/plugins/creating-plugins.html [controller-tools]: https://github.com/kubernetes-sigs/controller-tools