Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kubernetes-sigs/apiserver-builder-alpha

apiserver-builder-alpha implements libraries and tools to quickly and easily build Kubernetes apiservers/controllers to support custom resource types based on APIServer Aggregation
https://github.com/kubernetes-sigs/apiserver-builder-alpha

apiserver-aggregation k8s-sig-api-machinery kubernetes server-sdk

Last synced: 3 months ago
JSON representation

apiserver-builder-alpha implements libraries and tools to quickly and easily build Kubernetes apiservers/controllers to support custom resource types based on APIServer Aggregation

Awesome Lists containing this project

README 

        
## `apiserver-builder-alpha`



![build](https://github.com/kubernetes-sigs/apiserver-builder-alpha/workflows/build/badge.svg)

[![Go Report Card](https://goreportcard.com/badge/sigs.k8s.io/apiserver-builder-alpha)](https://goreportcard.com/report/sigs.k8s.io/apiserver-builder-alpha)



Unless you absolutely need apiserver-aggregation, you are recommended to use [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) instead of apiserver-builder for

building Kubernetes APIs.  Kubebuilder builds APIs using CRDs and addresses limitations and feedback from

apiserver-builder.



Apiserver Builder is a collection of libraries and tools to build native

Kubernetes extensions using Kubernetes apiserver aggregation. Aggregated

apiserver empowers you to customize your apiserver to do following things

cannot achieved by CR\[D\]:

- Makes your apiserver adopt different storage APIs rather than ETCDv3

- Extends long-running subresources/endpoints like websocket for your own resources

- Integrates your apiserver with whatever other external systems



![DEMO](./docs/static_includes/demo.gif)



## Installation



```bash

go install sigs.k8s.io/apiserver-builder-alpha/cmd/[email protected]

```



or manual download from [release pages](https://github.com/kubernetes-sigs/apiserver-builder-alpha/releases).



## Motivation



*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.



## Highlights



- Tools to bootstrap type definitions, controllers (powered by [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) framework), tests and documentation for new resources

- Tools to build and run the extension control plane standalone and in minikube and remote clusters.

- Easily watch and update Kubernetes API types from your controller

- Easily add new resources and subresources

- Provides sane defaults for most values, but can be overridden



## Examples



- [BasicExample](https://sigs.k8s.io/apiserver-builder-alpha/example/basic): Various simple resource examples.

- [KineExample](https://sigs.k8s.io/apiserver-builder-alpha/example/kine): Plumbs aggregated apiserver over SQL-storages including sqlite, mysql, etc..

- [PodLogsExample](https://sigs.k8s.io/apiserver-builder-alpha/example/podlogs): Serves `pod/logs` in aggregation layer to offload kube-apiserver connections.

- [PodExecExample](https://sigs.k8s.io/apiserver-builder-alpha/example/podexec): Serves `pod/exec` in aggregation layer to offload kube-apiserver connections.



## Guides



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



#### Building APIs concept guide



Conceptual information on how APIs and the Kubernetes control plane is structure and how to

build new API extensions using apiserver-builder.



If you want to get straight to building something without knowing all the details of what is going on,

skip ahead to the tools guide and come back to this later.



[api building concept guide](docs/concepts/api_building_overview.md)



#### Tools user guide



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



[tools guide](docs/tools_user_guide.md)



#### Step by step example



List of commits showing `apiserver-boot` commands run and the corresponding changes:



https://github.com/kubernetes-sigs/apiserver-builder-alpha/commits/example-simple



#### Coding and libraries user guide



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



[libraries guide](docs/libraries_user_guide.md)



#### Concept guides



Conceptual information on addon apiservers, such as how auth works and how they interact

with the main Kubernetes API server and API aggregator.



[Concepts](docs/concepts/README.md)



## Additional material



##### Using delegated auth with minikube



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



Details [here](https://sigs.k8s.io/apiserver-builder-alpha/docs/using_minikube.md)



## Community, discussion, contribution, and support



Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).



You can reach the maintainers of this project at:



- [Slack channel](https://kubernetes.slack.com/messages/kubebuilder)

- [Mailing list](https://groups.google.com/forum/#!forum/kubebuilder)



### Code of conduct



Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).