| 1 |
# apiserver |
| 2 |
|
| 3 |
Generic library for building a Kubernetes aggregated API server. |
| 4 |
|
| 5 |
|
| 6 |
## Purpose |
| 7 |
|
| 8 |
This library contains code to create Kubernetes aggregation server complete with delegated authentication and authorization, |
| 9 |
`kubectl` compatible discovery information, optional admission chain, and versioned types. It's first consumers are |
| 10 |
`k8s.io/kubernetes`, `k8s.io/kube-aggregator`, and `github.com/kubernetes-incubator/service-catalog`. |
| 11 |
|
| 12 |
|
| 13 |
## Compatibility |
| 14 |
|
| 15 |
There are *NO compatibility guarantees* for this repository, yet. It is in direct support of Kubernetes, so branches |
| 16 |
will track Kubernetes and be compatible with that repo. As we more cleanly separate the layers, we will review the |
| 17 |
compatibility guarantee. We have a goal to make this easier to use in the future. |
| 18 |
|
| 19 |
|
| 20 |
## Where does it come from? |
| 21 |
|
| 22 |
`apiserver` is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apiserver. |
| 23 |
Code changes are made in that location, merged into `k8s.io/kubernetes` and later synced here. |
| 24 |
|
| 25 |
|
| 26 |
## Things you should *NOT* do |
| 27 |
|
| 28 |
1. Directly modify any files under `pkg` in this repo. Those are driven from `k8s.io/kubernetes/staging/src/k8s.io/apiserver`. |
| 29 |
2. Expect compatibility. This repo is changing quickly in direct support of |
| 30 |
Kubernetes and the API isn't yet stable enough for API guarantees. |
| 31 |
|