Documentation
¶
Overview ¶
Package kubectl is a set of libraries that are used by the kubectl command line tool. They are separated out into a library to support unit testing. Most functionality should be included in this package, and the main kubectl should really just be an entry point.
A set of common functions needed by cmd/kubectl and pkg/kubectl packages.
Index ¶
- Variables
- func GetApiVersions(w io.Writer, kubeClient client.Interface)
- func GetClientVersion(w io.Writer)
- func GetVersion(w io.Writer, kubeClient client.Interface)
- func MakeLabels(labels map[string]string) string
- func MakeParams(cmd *cobra.Command, params []GeneratorParam) map[string]string
- func ParseLabels(labelString string) map[string]string
- func ResizeCondition(r Resizer, precondition *ResizePrecondition, namespace, name string, ...) wait.ConditionFunc
- func ValidateParams(paramSpec []GeneratorParam, params map[string]string) error
- func WatchLoop(w watch.Interface, fn func(watch.Event) error)
- type BasicReplicationController
- type ControllerResizeError
- type ControllerResizeErrorType
- type Describer
- type Describers
- type ErrNoDescriber
- type Generator
- type GeneratorParam
- type HumanReadablePrinter
- type JSONPrinter
- type LimitRangeDescriber
- type NamespaceInfo
- type NodeDescriber
- type ObjectDescriber
- type OutputVersionMapper
- type PodDescriber
- type PodReaper
- type PreconditionError
- type ProxyServer
- type RESTClient
- type Reaper
- type ReplicationControllerDescriber
- type ReplicationControllerReaper
- type ReplicationControllerResizer
- type ResizePrecondition
- type Resizer
- type ResourcePrinter
- type ResourcePrinterFunc
- type ResourceQuotaDescriber
- type RollingUpdater
- type ServiceDescriber
- type ServiceGenerator
- type ServiceReaper
- type ShortcutExpander
- type SortableEvents
- type SortableResourceNames
- type TemplatePrinter
- type VersionedPrinter
- type YAMLPrinter
Constants ¶
This section is empty.
Variables ¶
var Generators map[string]Generator = map[string]Generator{ "run-container/v1": BasicReplicationController{}, "service/v1": ServiceGenerator{}, }
Generators is a global list of known generators. TODO: Dynamically create this from a list of template files?
Functions ¶
func GetApiVersions ¶ added in v0.14.0
func GetClientVersion ¶
func MakeLabels ¶ added in v0.11.0
func MakeParams ¶ added in v0.9.0
func MakeParams(cmd *cobra.Command, params []GeneratorParam) map[string]string
MakeParams is a utility that creates generator parameters from a command line
func ParseLabels ¶ added in v0.9.0
ParseLabels turns a string representation of a label set into a map[string]string
func ResizeCondition ¶ added in v0.13.0
func ResizeCondition(r Resizer, precondition *ResizePrecondition, namespace, name string, count uint) wait.ConditionFunc
ResizeCondition is a closure around Resize that facilitates retries via util.wait
func ValidateParams ¶ added in v0.9.0
func ValidateParams(paramSpec []GeneratorParam, params map[string]string) error
ValidateParams ensures that all required params are present in the params map
Types ¶
type BasicReplicationController ¶ added in v0.9.0
type BasicReplicationController struct{}
func (BasicReplicationController) ParamNames ¶ added in v0.9.0
func (BasicReplicationController) ParamNames() []GeneratorParam
type ControllerResizeError ¶ added in v0.13.0
type ControllerResizeError struct { FailureType ControllerResizeErrorType ResourceVersion string ActualError error }
A ControllerResizeError is returned when a the resize request passes preconditions but fails to actually resize the controller.
func (ControllerResizeError) Error ¶ added in v0.13.0
func (c ControllerResizeError) Error() string
type ControllerResizeErrorType ¶ added in v0.13.0
type ControllerResizeErrorType int
const ( ControllerResizeGetFailure ControllerResizeErrorType = iota ControllerResizeUpdateFailure )
type Describer ¶
Describer generates output for the named resource or an error if the output could not be generated. Implementors typically abstract the retrieval of the named object from a remote server.
type Describers ¶ added in v0.13.1
type Describers struct {
// contains filtered or unexported fields
}
Describers implements ObjectDescriber against functions registered via Add. Those functions can be strongly typed. Types are exactly matched (no conversion or assignable checks).
func (*Describers) Add ¶ added in v0.13.1
func (d *Describers) Add(fns ...interface{}) error
Add adds one or more describer functions to the Describer. The passed function must match the signature:
func(...) (string, error)
Any number of arguments may be provided.
func (*Describers) DescribeObject ¶ added in v0.13.1
func (d *Describers) DescribeObject(exact interface{}, extra ...interface{}) (string, error)
DescribeObject implements ObjectDescriber and will attempt to print the provided object to a string, if at least one describer function has been registered with the exact types passed, or if any describer can print the exact object in its first argument (the remainder will be provided empty values). If no function registered with Add can satisfy the passed objects, an ErrNoDescriber will be returned TODO: reorder and partial match extra.
type ErrNoDescriber ¶ added in v0.13.1
type ErrNoDescriber struct {
Types []string
}
ErrNoDescriber is a structured error indicating the provided object or objects cannot be described.
func (ErrNoDescriber) Error ¶ added in v0.13.1
func (e ErrNoDescriber) Error() string
Error implements the error interface.
type Generator ¶ added in v0.9.0
type Generator interface { // Generate creates an API object given a set of parameters Generate(params map[string]string) (runtime.Object, error) // ParamNames returns the list of parameters that this generator uses ParamNames() []GeneratorParam }
Generator is an interface for things that can generate API objects from input parameters.
type GeneratorParam ¶ added in v0.9.0
GeneratorParam is a parameter for a generator TODO: facilitate structured json generator input schemes
type HumanReadablePrinter ¶
type HumanReadablePrinter struct {
// contains filtered or unexported fields
}
HumanReadablePrinter is an implementation of ResourcePrinter which attempts to provide more elegant output. It is not threadsafe, but you may call PrintObj repeatedly; headers will only be printed if the object type changes. This makes it useful for printing items recieved from watches.
func NewHumanReadablePrinter ¶
func NewHumanReadablePrinter(noHeaders bool) *HumanReadablePrinter
NewHumanReadablePrinter creates a HumanReadablePrinter.
func (*HumanReadablePrinter) Handler ¶
func (h *HumanReadablePrinter) Handler(columns []string, printFunc interface{}) error
Handler adds a print handler with a given set of columns to HumanReadablePrinter instance. printFunc is the function that will be called to print an object. It must be of the following type:
func printFunc(object ObjectType, w io.Writer) error
where ObjectType is the type of the object that will be printed.
type JSONPrinter ¶
type JSONPrinter struct { }
JSONPrinter is an implementation of ResourcePrinter which outputs an object as JSON.
type LimitRangeDescriber ¶ added in v0.10.0
LimitRangeDescriber generates information about a limit range
type NamespaceInfo ¶
type NamespaceInfo struct {
Namespace string
}
type NodeDescriber ¶ added in v0.13.0
NodeDescriber generates information about a node.
type ObjectDescriber ¶ added in v0.13.1
type ObjectDescriber interface {
DescribeObject(object interface{}, extra ...interface{}) (output string, err error)
}
ObjectDescriber is an interface for displaying arbitrary objects with extra information. Use when an object is in hand (on disk, or already retrieved). Implementors may ignore the additional information passed on extra, or use it by default. ObjectDescribers may return ErrNoDescriber if no suitable describer is found.
var DefaultObjectDescriber ObjectDescriber
DefaultObjectDescriber can describe the default Kubernetes objects.
type OutputVersionMapper ¶ added in v0.9.0
type OutputVersionMapper struct { meta.RESTMapper OutputVersion string }
OutputVersionMapper is a RESTMapper that will prefer mappings that correspond to a preferred output version (if feasible)
func (OutputVersionMapper) RESTMapping ¶ added in v0.9.0
func (m OutputVersionMapper) RESTMapping(kind string, versions ...string) (*meta.RESTMapping, error)
RESTMapping implements meta.RESTMapper by prepending the output version to the preferred version list.
type PodDescriber ¶
PodDescriber generates information about a pod and the replication controllers that create it.
type PreconditionError ¶ added in v0.9.0
A PreconditionError is returned when a replication controller fails to match the resize preconditions passed to kubectl.
func (PreconditionError) Error ¶ added in v0.9.0
func (pe PreconditionError) Error() string
type ProxyServer ¶
type ProxyServer struct {
httputil.ReverseProxy
}
ProxyServer is a http.Handler which proxies Kubernetes APIs to remote API server.
func NewProxyServer ¶
func NewProxyServer(filebase string, apiProxyPrefix string, staticPrefix string, cfg *client.Config) (*ProxyServer, error)
NewProxyServer creates and installs a new ProxyServer. It automatically registers the created ProxyServer to http.DefaultServeMux.
func (*ProxyServer) Serve ¶
func (s *ProxyServer) Serve(port int) error
Serve starts the server (http.DefaultServeMux) on given port, loops forever.
type RESTClient ¶
type RESTClient interface { Get() *client.Request Post() *client.Request Delete() *client.Request Put() *client.Request }
RESTClient is a client helper for dealing with RESTful resources in a generic way.
type ReplicationControllerDescriber ¶
ReplicationControllerDescriber generates information about a replication controller and the pods it has created.
type ReplicationControllerReaper ¶ added in v0.9.1
type ReplicationControllerResizer ¶ added in v0.9.0
func (*ReplicationControllerResizer) Resize ¶ added in v0.9.0
func (resize *ReplicationControllerResizer) Resize(namespace, name string, preconditions *ResizePrecondition, newSize uint) (string, error)
type ResizePrecondition ¶ added in v0.9.0
ResizePrecondition describes a condition that must be true for the resize to take place If CurrentSize == -1, it is ignored. If CurrentResourceVersion is the empty string, it is ignored. Otherwise they must equal the values in the replication controller for it to be valid.
func (*ResizePrecondition) Validate ¶ added in v0.9.0
func (precondition *ResizePrecondition) Validate(controller *api.ReplicationController) error
Validate ensures that the preconditions match. Returns nil if they are valid, an error otherwise
type Resizer ¶ added in v0.9.0
type Resizer interface {
Resize(namespace, name string, preconditions *ResizePrecondition, newSize uint) (string, error)
}
type ResourcePrinter ¶
type ResourcePrinter interface { // Print receives a runtime object, formats it and prints it to a writer. PrintObj(runtime.Object, io.Writer) error }
ResourcePrinter is an interface that knows how to print runtime objects.
func GetPrinter ¶
func GetPrinter(format, formatArgument string) (ResourcePrinter, bool, error)
GetPrinter takes a format type, an optional format argument. It will return true if the format is generic (untyped), otherwise it will return false. The printer is agnostic to schema versions, so you must send arguments to PrintObj in the version you wish them to be shown using a VersionedPrinter (typically when generic is true).
func NewVersionedPrinter ¶ added in v0.9.0
func NewVersionedPrinter(printer ResourcePrinter, convertor runtime.ObjectConvertor, version ...string) ResourcePrinter
NewVersionedPrinter wraps a printer to convert objects to a known API version prior to printing.
type ResourcePrinterFunc ¶ added in v0.9.0
ResourcePrinterFunc is a function that can print objects
type ResourceQuotaDescriber ¶ added in v0.10.0
ResourceQuotaDescriber generates information about a resource quota
type RollingUpdater ¶ added in v0.9.0
type RollingUpdater struct {
// contains filtered or unexported fields
}
RollingUpdater provides methods for updating replicated pods in a predictable, fault-tolerant way.
func NewRollingUpdater ¶ added in v0.9.0
func NewRollingUpdater(namespace string, c client.Interface) *RollingUpdater
NewRollingUpdater creates a RollingUpdater from a client
func (*RollingUpdater) Update ¶ added in v0.9.0
func (r *RollingUpdater) Update(out io.Writer, oldRc, newRc *api.ReplicationController, updatePeriod, interval, timeout time.Duration) error
Update all pods for a ReplicationController (oldRc) by creating a new controller (newRc) with 0 replicas, and synchronously resizing oldRc,newRc by 1 until oldRc has 0 replicas and newRc has the original # of desired replicas. oldRc is then deleted. If an update from newRc to oldRc is already in progress, we attempt to drive it to completion. If an error occurs at any step of the update, the error will be returned.
'out' writer for progress output 'oldRc' existing controller to be replaced 'newRc' controller that will take ownership of updated pods (will be created if needed) 'updatePeriod' time to wait between individual pod updates 'interval' time to wait between polling controller status after update 'timeout' time to wait for controller updates before giving up
TODO: make this handle performing a rollback of a partially completed rollout.
type ServiceDescriber ¶
ServiceDescriber generates information about a service.
type ServiceGenerator ¶ added in v0.11.0
type ServiceGenerator struct{}
func (ServiceGenerator) ParamNames ¶ added in v0.11.0
func (ServiceGenerator) ParamNames() []GeneratorParam
type ServiceReaper ¶ added in v0.9.1
type ShortcutExpander ¶ added in v0.9.0
type ShortcutExpander struct {
meta.RESTMapper
}
ShortcutExpander is a RESTMapper that can be used for Kubernetes resources.
func (ShortcutExpander) VersionAndKindForResource ¶ added in v0.9.0
func (e ShortcutExpander) VersionAndKindForResource(resource string) (defaultVersion, kind string, err error)
VersionAndKindForResource implements meta.RESTMapper. It expands the resource first, then invokes the wrapped mapper.
type SortableEvents ¶ added in v0.8.2
SortableEvents implements sort.Interface for []api.Event based on the Timestamp field
func (SortableEvents) Len ¶ added in v0.8.2
func (list SortableEvents) Len() int
func (SortableEvents) Less ¶ added in v0.8.2
func (list SortableEvents) Less(i, j int) bool
func (SortableEvents) Swap ¶ added in v0.8.2
func (list SortableEvents) Swap(i, j int)
type SortableResourceNames ¶ added in v0.10.0
type SortableResourceNames []api.ResourceName
func (SortableResourceNames) Len ¶ added in v0.10.0
func (list SortableResourceNames) Len() int
func (SortableResourceNames) Less ¶ added in v0.10.0
func (list SortableResourceNames) Less(i, j int) bool
func (SortableResourceNames) Swap ¶ added in v0.10.0
func (list SortableResourceNames) Swap(i, j int)
type TemplatePrinter ¶
type TemplatePrinter struct {
// contains filtered or unexported fields
}
TemplatePrinter is an implementation of ResourcePrinter which formats data with a Go Template.
func NewTemplatePrinter ¶
func NewTemplatePrinter(tmpl []byte) (*TemplatePrinter, error)
type VersionedPrinter ¶ added in v0.9.0
type VersionedPrinter struct {
// contains filtered or unexported fields
}
VersionedPrinter takes runtime objects and ensures they are converted to a given API version prior to being passed to a nested printer.
type YAMLPrinter ¶
type YAMLPrinter struct {
// contains filtered or unexported fields
}
YAMLPrinter is an implementation of ResourcePrinter which outputs an object as YAML. The input object is assumed to be in the internal version of an API and is converted to the given version first.