ibazhitov / apiserver-builder Goto Github PK

Note: This project is still only a proof of concept, and is not production ready.

Apiserver Builder is a collection of libraries and tools to build native Kubernetes extensions using Kubernetes apiserver code.

Addon apiservers are a Kubernetes extension point allowing fully featured Kubernetes APIs to be developed on the same api-machinery used to build the core Kubernetes APIS, but with the flexibility of being distributed and installed separately from the Kubernetes project. This allows APIs to be developed outside of the Kubernetes repo and installed separately as a package.

Building addon apiservers directly on the raw api-machinery libraries requires non-trivial code that must be maintained and rebased as the raw libraries change. The goal of this project is to make building apiservers in Go simple and accessible to everyone in the Kubernetes community.

apiserver-builder provides libraries, code generators, and tooling to make it possible to build and run a basic apiserver in an afternoon, while providing all of the hooks to offer the same capabilities when building from scratch.

Note: The guides are presented roughly in the order of recommended progression.

Download the latest release and install on your PATH.

installation guide

Instructions on how to use the tools packaged with apiserver-builder to build and run a new apiserver.

tools guide

Instructions for how to implement custom APIs on top of the apiserver-builder libraries.

libraries guide

Conceptual information on addon apiservers, such as how auth works and how they interact with the main Kubernetes API server and API aggregator.

Concepts

Instructions on how to run an apiserver using delegated auth with a minikube cluster

Details here