README
¶
apimachinery
Scheme, typing, encoding, decoding, and conversion packages for Kubernetes and Kubernetes-like API objects.
Purpose
This library is a shared dependency for servers and clients to work with Kubernetes API infrastructure without direct
type dependencies. Its first consumers are k8s.io/kubernetes, k8s.io/client-go, and k8s.io/apiserver.
Compatibility
There are NO compatibility guarantees for this repository. It is in direct support of Kubernetes, so branches will track Kubernetes and be compatible with that repo. As we more cleanly separate the layers, we will review the compatibility guarantee.
Where does it come from?
apimachinery is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery.
Code changes are made in that location, merged into k8s.io/kubernetes and later synced here.
Things you should NOT do
- Add API types to this repo. This is for the machinery, not for the types.
- Directly modify any files under
pkgin this repo. Those are driven fromk8s.io/kubernetes/staging/src/k8s.io/apimachinery. - Expect compatibility. This repo is direct support of Kubernetes and the API isn't yet stable enough for API guarantees.
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
api/errors
Package errors provides detailed error types for api field validation.
|
Package errors provides detailed error types for api field validation. |
|
api/meta
Package meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API TODO: move everything in this file to pkg/api/rest
|
Package meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API TODO: move everything in this file to pkg/api/rest |
|
api/validation
Package validation contains generic api type validation functions.
|
Package validation contains generic api type validation functions. |
|
apis/meta/v1
Package v1 contains API types that are common to all versions.
|
Package v1 contains API types that are common to all versions. |
|
apis/meta/v1beta1
package v1beta1 is alpha objects from meta that will be introduced.
|
package v1beta1 is alpha objects from meta that will be introduced. |
|
apis/testapigroup
+k8s:deepcopy-gen=package +groupName=testapigroup.apimachinery.k8s.io package testapigroup contains an testapigroup API used to demonstrate how to create api groups.
|
+k8s:deepcopy-gen=package +groupName=testapigroup.apimachinery.k8s.io package testapigroup contains an testapigroup API used to demonstrate how to create api groups. |
|
apis/testapigroup/install
Package install installs the certificates API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the certificates API group, making it available as an option to all of the API encoding/decoding machinery. |
|
conversion
Package conversion provides go object versioning.
|
Package conversion provides go object versioning. |
|
conversion/queryparams
Package queryparams provides conversion from versioned runtime objects to URL query values
|
Package queryparams provides conversion from versioned runtime objects to URL query values |
|
fields
Package fields implements a simple field system, parsing and matching selectors with sets of fields.
|
Package fields implements a simple field system, parsing and matching selectors with sets of fields. |
|
labels
Package labels implements a simple label system, parsing and matching selectors with sets of labels.
|
Package labels implements a simple label system, parsing and matching selectors with sets of labels. |
|
runtime
Package runtime defines conversions between generic types and structs to map query strings to struct objects.
|
Package runtime defines conversions between generic types and structs to map query strings to struct objects. |
|
runtime/serializer/protobuf
Package protobuf provides a Kubernetes serializer for the protobuf format.
|
Package protobuf provides a Kubernetes serializer for the protobuf format. |
|
runtime/serializer/streaming
Package streaming implements encoder and decoder for streams of runtime.Objects over io.Writer/Readers.
|
Package streaming implements encoder and decoder for streams of runtime.Objects over io.Writer/Readers. |
|
types
Package types implements various generic types used throughout kubernetes.
|
Package types implements various generic types used throughout kubernetes. |
|
util/errors
Package errors implements various utility functions and types around errors.
|
Package errors implements various utility functions and types around errors. |
|
util/framer
Package framer implements simple frame decoding techniques for an io.ReadCloser
|
Package framer implements simple frame decoding techniques for an io.ReadCloser |
|
util/httpstream
Package httpstream adds multiplexed streaming support to HTTP requests and responses via connection upgrades.
|
Package httpstream adds multiplexed streaming support to HTTP requests and responses via connection upgrades. |
|
util/proxy
Package proxy provides transport and upgrade support for proxies.
|
Package proxy provides transport and upgrade support for proxies. |
|
util/rand
Package rand provides utilities related to randomization.
|
Package rand provides utilities related to randomization. |
|
util/sets
Package sets has auto-generated set types.
|
Package sets has auto-generated set types. |
|
util/sets/types
Package types just provides input types to the set generator.
|
Package types just provides input types to the set generator. |
|
util/version
Package version provides utilities for version number comparisons
|
Package version provides utilities for version number comparisons |
|
util/wait
Package wait provides tools for polling or listening for changes to a condition.
|
Package wait provides tools for polling or listening for changes to a condition. |
|
util/waitgroup
Package waitgroup implements SafeWaitGroup wrap of sync.WaitGroup.
|
Package waitgroup implements SafeWaitGroup wrap of sync.WaitGroup. |
|
version
Package version supplies the type for version information collected at build time.
|
Package version supplies the type for version information collected at build time. |
|
watch
Package watch contains a generic watchable interface, and a fake for testing code that uses the watch interface.
|
Package watch contains a generic watchable interface, and a fake for testing code that uses the watch interface. |
|
third_party
|
|
|
forked/golang/json
Package json is forked from the Go standard library to enable us to find the field of a struct that a given JSON key maps to.
|
Package json is forked from the Go standard library to enable us to find the field of a struct that a given JSON key maps to. |
|
forked/golang/reflect
Package reflect is a fork of go's standard library reflection package, which allows for deep equal with equality functions defined.
|
Package reflect is a fork of go's standard library reflection package, which allows for deep equal with equality functions defined. |
Click to show internal directories.
Click to hide internal directories.