Skip to content
Kubebuilder - SDK for building Kubernetes APIs using CRDs
Branch: master
Clone or download
Latest commit 88c65c8 Jun 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Add issue templates Apr 8, 2019
build Merge pull request #703 from DirectXMan12/feature/default-to-scaffold-v2 May 16, 2019
cmd remove paths for yes/no questions in api cmd May 22, 2019
designs scaffold/v2/group: fix comment capitalization for golint May 19, 2019
docs Update cronjob-tutorial.md Jun 17, 2019
pkg/scaffold fix: golangci-lint passes against a new project Jun 13, 2019
scripts 🏃 enable travis e2e tests Jun 4, 2019
test 🏃 add e2e tests for v2 Jun 10, 2019
testdata fix: golangci-lint passes against a new project Jun 13, 2019
.gitattributes Actually move test projects to testdata May 10, 2019
.gitignore New Book May 14, 2019
.travis.yml 🏃 enable travis e2e tests Jun 4, 2019
BUILD.bazel change import path to use vanity URL sigs.k8s.io Oct 10, 2018
CONTRIBUTING.md 🏃 added vendor tgz for test projects using git-lfs Apr 12, 2019
DESIGN.md 📖 Elaborate on the design pricipals of KB Feb 26, 2019
LICENSE Fork [apiserver-builder](https://github.com/kubernetes-incubator/apis… Mar 15, 2018
Makefile Merge pull request #704 from droot/running/switch-to-go-modules May 16, 2019
OWNERS Update kubebuilder OWNERS Jun 7, 2018
OWNERS_ALIASES change github handle Jun 21, 2018
README.md README: Update broken book links May 17, 2019
RELEASE.md Update RELEASE.md to point to HEAD binaries Mar 16, 2018
SECURITY_CONTACTS Add SECURITY_CONTACTS file May 31, 2018
WORKSPACE Fork [apiserver-builder](https://github.com/kubernetes-incubator/apis… Mar 15, 2018
code-of-conduct.md Fork [apiserver-builder](https://github.com/kubernetes-incubator/apis… Mar 15, 2018
common.sh 🏃 enable travis e2e tests Jun 4, 2019
generate_vendor.sh 🏃 enable travis e2e tests Jun 4, 2019
generated_golden.sh fix: golangci-lint passes against a new project Jun 13, 2019
go.mod 🏃 enable travis e2e tests Jun 4, 2019
go.sum 🏃 enable travis e2e tests Jun 4, 2019
netlify.toml Go links for kustomize and snapshot builds May 16, 2019
test.sh 🏃 use vendor tarball from GCS bucket Jun 18, 2019
test_e2e.sh 🏃 enable travis e2e tests Jun 4, 2019

README.md

Build Status Go Report Card

Kubebuilder

Kubebuilder is a framework for building Kubernetes APIs using custom resource definitions (CRDs).

Note: 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.

Installation

It is strongly recommended that you use a released version. Release binaries are available on the releases page. Follow the instructions to install Kubebuilder.

Getting Started

See the Getting Started documentation.

Quick Start

Documentation

Check out the Kubebuilder book.

Resources

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 for the guiding principals 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

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. 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 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 for more details. Before starting any work, please either comment on an existing issue, or file a new one.

You can’t perform that action at this time.