cli-runtime/

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 ¶

cli-runtime

Set of helpers for creating kubectl commands, as well as kubectl plugins.

Purpose

This library is a shared dependency for clients to work with Kubernetes API infrastructure which allows to maintain kubectl compatible behavior. Its first consumer is k8s.io/kubectl.

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?

cli-runtime is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/cli-runtime. 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 helpers, not for the types.
Directly modify any files under pkg in this repo. Those are driven from k8s.io/kubernetes/staging/src/k8s.io/cli-runtime.
Expect compatibility. This repo is direct support of Kubernetes and the API isn't yet stable enough for API guarantees.
Add any type that only makes sense only for kubectl.

Directories ¶

Path	Synopsis
pkg
genericclioptions Package genericclioptions contains flags which can be added to you command, bound, completed, and produce useful helper functions.	Package genericclioptions contains flags which can be added to you command, bound, completed, and produce useful helper functions.
kustomize
kustomize/k8sdeps Package k8sdeps provides kustomize factory with k8s dependencies	Package k8sdeps provides kustomize factory with k8s dependencies
kustomize/k8sdeps/configmapandsecret Package configmapandsecret generates configmaps and secrets per generator rules.	Package configmapandsecret generates configmaps and secrets per generator rules.
kustomize/k8sdeps/kunstruct Package kunstruct provides unstructured from api machinery and factory for creating unstructured Package kunstruct provides unstructured from api machinery and factory for creating unstructured	Package kunstruct provides unstructured from api machinery and factory for creating unstructured Package kunstruct provides unstructured from api machinery and factory for creating unstructured
kustomize/k8sdeps/kv
kustomize/k8sdeps/transformer Package transformer provides transformer factory	Package transformer provides transformer factory
kustomize/k8sdeps/transformer/hash
kustomize/k8sdeps/transformer/patch
kustomize/k8sdeps/validator Package validator provides functions to validate labels, annotations, namespace using apimachinery	Package validator provides functions to validate labels, annotations, namespace using apimachinery
printers Package printers is helper for formatting and printing runtime objects into primitives io.writer.	Package printers is helper for formatting and printing runtime objects into primitives io.writer.
resource Package resource assists clients in dealing with RESTful objects that match the Kubernetes API conventions.	Package resource assists clients in dealing with RESTful objects that match the Kubernetes API conventions.

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