apimachinery/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

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 pkg in this repo. Those are driven from k8s.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/equality
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/meta/table
api/resource Package resource is a generated protocol buffer package.	Package resource is a generated protocol buffer package.
api/testing
api/testing/fuzzer
api/testing/roundtrip
api/validation Package validation contains generic api type validation functions.	Package validation contains generic api type validation functions.
api/validation/path
apimachinery Package apimachinery contains the generic API machinery code that is common to both server and clients.	Package apimachinery contains the generic API machinery code that is common to both server and clients.
apimachinery/announced Package announced contains tools for announcing API group factories.	Package announced contains tools for announcing API group factories.
apimachinery/registered Package to keep track of API Versions that can be registered and are enabled in a Scheme.	Package to keep track of API Versions that can be registered and are enabled in a Scheme.
apis/meta/fuzzer
apis/meta/internalversion
apis/meta/v1 +groupName=meta.k8s.io Package v1 is a generated protocol buffer package.	+groupName=meta.k8s.io Package v1 is a generated protocol buffer package.
apis/meta/v1/unstructured
apis/meta/v1/validation
apis/meta/v1beta1 +groupName=meta.k8s.io Package v1beta1 is a generated protocol buffer package.	+groupName=meta.k8s.io Package v1beta1 is a generated protocol buffer package.
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/fuzzer
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.
apis/testapigroup/v1 +groupName=testapigroup.apimachinery.k8s.io Package v1 is a generated protocol buffer package.	+groupName=testapigroup.apimachinery.k8s.io Package v1 is a generated protocol buffer package.
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 Defines conversions between generic types and structs to map query strings to struct objects.	Defines conversions between generic types and structs to map query strings to struct objects.
runtime/schema Package schema is a generated protocol buffer package.	Package schema is a generated protocol buffer package.
runtime/serializer
runtime/serializer/json
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/recognizer
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.
runtime/serializer/testing
runtime/serializer/versioning
runtime/serializer/yaml
runtime/testing
selection
test
types Package types implements various generic types used throughout kubernetes.	Package types implements various generic types used throughout kubernetes.
util/cache
util/clock
util/diff
util/duration
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/httpstream/spdy
util/initialization
util/intstr Package intstr is a generated protocol buffer package.	Package intstr is a generated protocol buffer package.
util/json
util/jsonmergepatch
util/mergepatch
util/net
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/remotecommand
util/runtime
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/strategicpatch
util/strategicpatch/testing
util/uuid
util/validation
util/validation/field
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.
util/yaml
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/netutil
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.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL