README.md
1# apimachinery
2
3Scheme, typing, encoding, decoding, and conversion packages for Kubernetes and Kubernetes-like API objects.
4
5
6## Purpose
7
8This library is a shared dependency for servers and clients to work with Kubernetes API infrastructure without direct
9type dependencies. Its first consumers are `k8s.io/kubernetes`, `k8s.io/client-go`, and `k8s.io/apiserver`.
10
11
12## Compatibility
13
14There are *NO compatibility guarantees* for this repository. It is in direct support of Kubernetes, so branches
15will track Kubernetes and be compatible with that repo. As we more cleanly separate the layers, we will review the
16compatibility guarantee.
17
18
19## Where does it come from?
20
21`apimachinery` is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery.
22Code changes are made in that location, merged into `k8s.io/kubernetes` and later synced here.
23
24
25## Things you should *NOT* do
26
27 1. Add API types to this repo. This is for the machinery, not for the types.
28 2. Directly modify any files under `pkg` in this repo. Those are driven from `k8s.io/kubernetes/staging/src/k8s.io/apimachinery`.
29 3. Expect compatibility. This repo is direct support of Kubernetes and the API isn't yet stable enough for API guarantees.
30