kubectl

package
v1.1.1-beta.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 25, 2015 License: Apache-2.0 Imports: 50 Imported by: 0

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

Constants

View Source 
const (
	DefaultHostAcceptRE   = "^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$"
	DefaultPathAcceptRE   = "^/.*"
	DefaultPathRejectRE   = "^/api/.*/exec,^/api/.*/run"
	DefaultMethodRejectRE = "POST,PUT,PATCH"
)
View Source 
const (
	Interval = time.Second * 1
	Timeout  = time.Minute * 5
)
View Source 
const MaxRetries = 3

Variables

View Source 
var (
	// The reverse proxy will periodically flush the io writer at this frequency.
	// Only matters for long poll connections like the one used to watch. With an
	// interval of 0 the reverse proxy will buffer content sent on any connection
	// with transfer-encoding=chunked.
	// TODO: Flush after each chunk so the client doesn't suffer a 100ms latency per
	// watch event.
	ReverseProxyFlushInterval = 100 * time.Millisecond
)

Functions

func AbortRollingUpdate added in v0.17.1 

func AbortRollingUpdate(c *RollingUpdaterConfig)

func AddDeploymentKeyToReplicationController added in v0.17.1 

func AddDeploymentKeyToReplicationController(oldRc *api.ReplicationController, client client.Interface, deploymentKey, deploymentValue, namespace string, out io.Writer) (*api.ReplicationController, error)

func AddJsonFilenameFlag added in v0.16.2 

func AddJsonFilenameFlag(cmd *cobra.Command, value *[]string, usage string)

func CreateNewControllerFromCurrentController added in v0.17.1 

func CreateNewControllerFromCurrentController(c *client.Client, namespace, oldName, newName, image, deploymentKey string) (*api.ReplicationController, error)

func DescribableResources added in v0.16.2 

func DescribableResources() []string

List of all resource types we can describe

func DescribeEvents added in v0.16.2 

func DescribeEvents(el *api.EventList, w io.Writer)

func DescribeLimitRanges added in v0.20.0 

func DescribeLimitRanges(limitRanges *api.LimitRangeList, w io.Writer)

DescribeLimitRanges merges a set of limit range items into a single tabular description

func DescribeResourceQuotas added in v0.20.0 

func DescribeResourceQuotas(quotas *api.ResourceQuotaList, w io.Writer)

DescribeResourceQuotas merges a set of quota items into a single tabular description of all quotas

func FindSourceController added in v0.17.1 

func FindSourceController(r client.ReplicationControllersNamespacer, namespace, name string) (*api.ReplicationController, error)

func GetBool added in v1.1.1 

func GetBool(params map[string]string, key string, defValue bool) (bool, error)

func GetClientVersion 

func GetClientVersion(w io.Writer)

func GetNextControllerAnnotation added in v0.17.1 

func GetNextControllerAnnotation(rc *api.ReplicationController) (string, bool)

func GetServerVersion added in v1.1.1 

func GetServerVersion(w io.Writer, kubeClient client.Interface)

func HandleResourceRequirements added in v1.1.1 

func HandleResourceRequirements(params map[string]string) (api.ResourceRequirements, error)

HandleResourceRequirements parses the limits and requests parameters if specified

func IsNoSuchReaperError added in v0.16.2 

func IsNoSuchReaperError(err error) bool

func IsZero added in v1.1.1 

func IsZero(i interface{}) bool

func LoadExistingNextReplicationController added in v0.17.1 

func LoadExistingNextReplicationController(c client.ReplicationControllersNamespacer, namespace, newName string) (*api.ReplicationController, error)

func MakeLabels added in v0.11.0 

func MakeLabels(labels map[string]string) string

func MakeParams added in v0.9.0 

func MakeParams(cmd *cobra.Command, params []GeneratorParam) map[string]interface{}

MakeParams is a utility that creates generator parameters from a command line

func MakeRegexpArray added in v0.20.0 

func MakeRegexpArray(str string) ([]*regexp.Regexp, error)

Splits a comma separated list of regexps into a array of Regexp objects.

func MakeRegexpArrayOrDie added in v0.20.0 

func MakeRegexpArrayOrDie(str string) []*regexp.Regexp

func ParseLabels added in v0.9.0 

func ParseLabels(labelSpec interface{}) (map[string]string, error)

ParseLabels turns a string representation of a label set into a map[string]string

func Rename added in v0.17.1 

func Rename(c client.ReplicationControllersNamespacer, rc *api.ReplicationController, newName string) error

func ScaleCondition added in v0.18.0 

func ScaleCondition(r Scaler, precondition *ScalePrecondition, namespace, name string, count uint) wait.ConditionFunc

ScaleCondition is a closure around Scale that facilitates retries via util.wait

func SetNextControllerAnnotation added in v0.17.1 

func SetNextControllerAnnotation(rc *api.ReplicationController, name string)

func UpdateExistingReplicationController added in v0.17.1 

func UpdateExistingReplicationController(c client.Interface, oldRc *api.ReplicationController, namespace, newName, deploymentKey, deploymentValue string, out io.Writer) (*api.ReplicationController, error)

func ValidateParams added in v0.9.0 

func ValidateParams(paramSpec []GeneratorParam, params map[string]interface{}) error

ValidateParams ensures that all required params are present in the params map

func WatchLoop 

func WatchLoop(w watch.Interface, fn func(watch.Event) error)

WatchLoop loops, passing events in w to fn. If user sends interrupt signal, shut down cleanly. Otherwise, never return.

Types

type BasicPod added in v1.1.1 

type BasicPod struct{}

func (BasicPod) Generate added in v1.1.1 

func (BasicPod) Generate(genericParams map[string]interface{}) (runtime.Object, error)

func (BasicPod) ParamNames added in v1.1.1 

func (BasicPod) ParamNames() []GeneratorParam

type BasicReplicationController added in v0.9.0 

type BasicReplicationController struct{}

func (BasicReplicationController) Generate added in v0.9.0 

func (BasicReplicationController) Generate(genericParams map[string]interface{}) (runtime.Object, error)

func (BasicReplicationController) ParamNames added in v0.9.0 

func (BasicReplicationController) ParamNames() []GeneratorParam

type Column added in v1.1.1 

type Column struct {
	// The header to print above the column, general style is ALL_CAPS
	Header string
	// The pointer to the field in the object to print in JSONPath form
	// e.g. {.ObjectMeta.Name}, see pkg/util/jsonpath for more details.
	FieldSpec string
}

Column represents a user specified column

type ControllerScaleError added in v0.18.0 

type ControllerScaleError struct {
	FailureType     ControllerScaleErrorType
	ResourceVersion string
	ActualError     error
}

A ControllerScaleError is returned when a scale request passes preconditions but fails to actually scale the controller.

func (ControllerScaleError) Error added in v0.18.0 

func (c ControllerScaleError) Error() string

type ControllerScaleErrorType added in v0.18.0 

type ControllerScaleErrorType int
const (
	ControllerScaleGetFailure ControllerScaleErrorType = iota
	ControllerScaleUpdateFailure
	ControllerScaleUpdateInvalidFailure
)

type CustomColumnsPrinter added in v1.1.1 

type CustomColumnsPrinter struct {
	Columns []Column
}

CustomColumnPrinter is a printer that knows how to print arbitrary columns of data from templates specified in the `Columns` array

func NewCustomColumnsPrinterFromSpec added in v1.1.1 

func NewCustomColumnsPrinterFromSpec(spec string) (*CustomColumnsPrinter, error)

NewCustomColumnsPrinterFromSpec creates a custom columns printer from a comma separated list of <header>:<jsonpath-field-spec> pairs. e.g. NAME:metadata.name,API_VERSION:apiVersion creates a printer that prints: 

NAME               API_VERSION
foo                bar

func NewCustomColumnsPrinterFromTemplate added in v1.1.1 

func NewCustomColumnsPrinterFromTemplate(templateReader io.Reader) (*CustomColumnsPrinter, error)

NewCustomColumnsPrinterFromTemplate creates a custom columns printer from a template stream. The template is expected to consist of two lines, whitespace separated. The first line is the header line, the second line is the jsonpath field spec For example the template below: NAME API_VERSION {metadata.name} {apiVersion}

func (*CustomColumnsPrinter) HandledResources added in v1.1.1 

func (s *CustomColumnsPrinter) HandledResources() []string

func (*CustomColumnsPrinter) PrintObj added in v1.1.1 

func (s *CustomColumnsPrinter) PrintObj(obj runtime.Object, out io.Writer) error

type DaemonSetDescriber added in v1.1.1 

type DaemonSetDescriber struct {
	client.Interface
}

DaemonSetDescriber generates information about a daemon set and the pods it has created.

func (*DaemonSetDescriber) Describe added in v1.1.1 

func (d *DaemonSetDescriber) Describe(namespace, name string) (string, error)

type DaemonSetReaper added in v1.1.1 

type DaemonSetReaper struct {
	client.Interface
	// contains filtered or unexported fields
}

func (*DaemonSetReaper) Stop added in v1.1.1 

func (reaper *DaemonSetReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *api.DeleteOptions) (string, error)

type Describer 

type Describer interface {
	Describe(namespace, name string) (output string, err error)
}

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.

func DescriberFor 

func DescriberFor(group string, kind string, c *client.Client) (Describer, bool)

Describer returns the default describe functions for each of the standard Kubernetes types.

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 FilterServer added in v0.20.0 

type FilterServer struct {
	// Only paths that match this regexp will be accepted
	AcceptPaths []*regexp.Regexp
	// Paths that match this regexp will be rejected, even if they match the above
	RejectPaths []*regexp.Regexp
	// Hosts are required to match this list of regexp
	AcceptHosts []*regexp.Regexp
	// Methods that match this regexp are rejected
	RejectMethods []*regexp.Regexp
	// contains filtered or unexported fields
}

FilterServer rejects requests which don't match one of the specified regular expressions

func (*FilterServer) HandlerFor added in v0.20.0 

func (f *FilterServer) HandlerFor(delegate http.Handler) *FilterServer

Make a copy of f which passes requests along to the new delegate.

func (*FilterServer) ServeHTTP added in v0.20.0 

func (f *FilterServer) ServeHTTP(rw http.ResponseWriter, req *http.Request)

type Generator added in v0.9.0 

type Generator interface {
	// Generate creates an API object given a set of parameters
	Generate(params map[string]interface{}) (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 

type GeneratorParam struct {
	Name     string
	Required bool
}

GeneratorParam is a parameter for a generator TODO: facilitate structured json generator input schemes

type HorizontalPodAutoscalerDescriber added in v1.1.1 

type HorizontalPodAutoscalerDescriber struct {
	// contains filtered or unexported fields
}

HorizontalPodAutoscalerDescriber generates information about a horizontal pod autoscaler.

func (*HorizontalPodAutoscalerDescriber) Describe added in v1.1.1 

func (d *HorizontalPodAutoscalerDescriber) Describe(namespace, name string) (string, error)

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 received from watches.

func NewHumanReadablePrinter 

func NewHumanReadablePrinter(noHeaders, withNamespace bool, wide bool, showAll bool, columnLabels []string) *HumanReadablePrinter

NewHumanReadablePrinter creates a HumanReadablePrinter.

func (*HumanReadablePrinter) HandledResources added in v0.16.2 

func (h *HumanReadablePrinter) HandledResources() []string

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. See validatePrintHandlerFunc for required method signature.

func (*HumanReadablePrinter) PrintObj 

func (h *HumanReadablePrinter) PrintObj(obj runtime.Object, output io.Writer) error

PrintObj prints the obj in a human-friendly format according to the type of the obj.

type JSONPathPrinter added in v1.1.1 

type JSONPathPrinter struct {
	*jsonpath.JSONPath
	// contains filtered or unexported fields
}

JSONPathPrinter is an implementation of ResourcePrinter which formats data with jsonpath expression.

func NewJSONPathPrinter added in v1.1.1 

func NewJSONPathPrinter(tmpl string) (*JSONPathPrinter, error)

func (*JSONPathPrinter) HandledResources added in v1.1.1 

func (p *JSONPathPrinter) HandledResources() []string

TODO: implement HandledResources()

func (*JSONPathPrinter) PrintObj added in v1.1.1 

func (j *JSONPathPrinter) PrintObj(obj runtime.Object, w io.Writer) error

PrintObj formats the obj with the JSONPath Template.

type JSONPrinter 

type JSONPrinter struct {
}

JSONPrinter is an implementation of ResourcePrinter which outputs an object as JSON.

func (*JSONPrinter) HandledResources added in v1.1.1 

func (p *JSONPrinter) HandledResources() []string

TODO: implement HandledResources()

func (*JSONPrinter) PrintObj 

func (p *JSONPrinter) PrintObj(obj runtime.Object, w io.Writer) error

PrintObj is an implementation of ResourcePrinter.PrintObj which simply writes the object to the Writer.

type JobDescriber added in v1.1.1 

type JobDescriber struct {
	// contains filtered or unexported fields
}

JobDescriber generates information about a job and the pods it has created.

func (*JobDescriber) Describe added in v1.1.1 

func (d *JobDescriber) Describe(namespace, name string) (string, error)

type JobReaper added in v1.1.1 

type JobReaper struct {
	client.Interface
	// contains filtered or unexported fields
}

func (*JobReaper) Stop added in v1.1.1 

func (reaper *JobReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *api.DeleteOptions) (string, error)

type JobScaler added in v1.1.1 

type JobScaler struct {
	// contains filtered or unexported fields
}

func (*JobScaler) Scale added in v1.1.1 

func (scaler *JobScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, waitForReplicas *RetryParams) error

Scale updates a Job to a new size, with optional precondition check (if preconditions is not nil), optional retries (if retry is not nil), and then optionally waits for parallelism to reach desired number, which can be less than requested based on job's current progress.

func (*JobScaler) ScaleSimple added in v1.1.1 

func (scaler *JobScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) error

ScaleSimple is responsible for updating job's parallelism.

type LimitRangeDescriber added in v0.10.0 

type LimitRangeDescriber struct {
	client.Interface
}

LimitRangeDescriber generates information about a limit range

func (*LimitRangeDescriber) Describe added in v0.10.0 

func (d *LimitRangeDescriber) Describe(namespace, name string) (string, error)

type NamePrinter added in v1.1.1 

type NamePrinter struct {
}

NamePrinter is an implementation of ResourcePrinter which outputs "resource/name" pair of an object.

func (*NamePrinter) HandledResources added in v1.1.1 

func (p *NamePrinter) HandledResources() []string

TODO: implement HandledResources()

func (*NamePrinter) PrintObj added in v1.1.1 

func (p *NamePrinter) PrintObj(obj runtime.Object, w io.Writer) error

PrintObj is an implementation of ResourcePrinter.PrintObj which decodes the object and print "resource/name" pair. If the object is a List, print all items in it.

type NamespaceDescriber added in v0.20.0 

type NamespaceDescriber struct {
	client.Interface
}

NamespaceDescriber generates information about a namespace

func (*NamespaceDescriber) Describe added in v0.20.0 

func (d *NamespaceDescriber) Describe(namespace, name string) (string, error)

type NamespaceInfo 

type NamespaceInfo struct {
	Namespace string
}

type NoSuchReaperError added in v0.16.2 

type NoSuchReaperError struct {
	// contains filtered or unexported fields
}

func (*NoSuchReaperError) Error added in v0.16.2 

func (n *NoSuchReaperError) Error() string

type NodeDescriber added in v0.13.1 

type NodeDescriber struct {
	client.Interface
}

NodeDescriber generates information about a node.

func (*NodeDescriber) Describe added in v0.13.1 

func (d *NodeDescriber) Describe(namespace, name string) (string, error)

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 PersistentVolumeClaimDescriber added in v0.15.0 

type PersistentVolumeClaimDescriber struct {
	client.Interface
}

func (*PersistentVolumeClaimDescriber) Describe added in v0.15.0 

func (d *PersistentVolumeClaimDescriber) Describe(namespace, name string) (string, error)

type PersistentVolumeDescriber added in v0.15.0 

type PersistentVolumeDescriber struct {
	client.Interface
}

func (*PersistentVolumeDescriber) Describe added in v0.15.0 

func (d *PersistentVolumeDescriber) Describe(namespace, name string) (string, error)

type PodDescriber 

type PodDescriber struct {
	client.Interface
}

PodDescriber generates information about a pod and the replication controllers that create it.

func (*PodDescriber) Describe 

func (d *PodDescriber) Describe(namespace, name string) (string, error)

type PodReaper added in v0.9.1 

type PodReaper struct {
	client.Interface
}

func (*PodReaper) Stop added in v0.9.1 

func (reaper *PodReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *api.DeleteOptions) (string, error)

type PreconditionError added in v0.9.0 

type PreconditionError struct {
	Precondition  string
	ExpectedValue string
	ActualValue   string
}

A PreconditionError is returned when a replication controller fails to match the scale preconditions passed to kubectl.

func (PreconditionError) Error added in v0.9.0 

func (pe PreconditionError) Error() string

type ProxyServer 

type ProxyServer struct {
	// contains filtered or unexported fields
}

ProxyServer is a http.Handler which proxies Kubernetes APIs to remote API server.

func NewProxyServer 

func NewProxyServer(filebase string, apiProxyPrefix string, staticPrefix string, filter *FilterServer, cfg *client.Config) (*ProxyServer, error)

NewProxyServer creates and installs a new ProxyServer. It automatically registers the created ProxyServer to http.DefaultServeMux. 'filter', if non-nil, protects requests to the api only.

func (*ProxyServer) Listen added in v1.1.1 

func (s *ProxyServer) Listen(port int) (net.Listener, error)

Listen is a simple wrapper around net.Listen.

func (*ProxyServer) ListenUnix added in v1.1.1 

func (s *ProxyServer) ListenUnix(path string) (net.Listener, error)

ListenUnix does net.Listen for a unix socket

func (*ProxyServer) ServeOnListener added in v1.1.1 

func (s *ProxyServer) ServeOnListener(l net.Listener) error

Serve starts the server using given listener, loops forever.

type RESTClient 

type RESTClient interface {
	Get() *client.Request
	Post() *client.Request
	Patch(api.PatchType) *client.Request
	Delete() *client.Request
	Put() *client.Request
}

RESTClient is a client helper for dealing with RESTful resources in a generic way.

type Reaper added in v0.9.1 

type Reaper interface {
	Stop(namespace, name string, timeout time.Duration, gracePeriod *api.DeleteOptions) (string, error)
}

A Reaper handles terminating an object as gracefully as possible. timeout is how long we'll wait for the termination to be successful gracePeriod is time given to an API object for it to delete itself cleanly (e.g. pod shutdown)

func ReaperFor added in v0.9.1 

func ReaperFor(kind string, c client.Interface) (Reaper, error)

func ReaperForReplicationController added in v0.18.0 

func ReaperForReplicationController(c client.Interface, timeout time.Duration) (Reaper, error)

type ReplicationControllerDescriber 

type ReplicationControllerDescriber struct {
	client.Interface
}

ReplicationControllerDescriber generates information about a replication controller and the pods it has created.

func (*ReplicationControllerDescriber) Describe 

func (d *ReplicationControllerDescriber) Describe(namespace, name string) (string, error)

type ReplicationControllerReaper added in v0.9.1 

type ReplicationControllerReaper struct {
	client.Interface
	// contains filtered or unexported fields
}

func (*ReplicationControllerReaper) Stop added in v0.9.1 

func (reaper *ReplicationControllerReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *api.DeleteOptions) (string, error)

type ReplicationControllerScaler added in v0.18.0 

type ReplicationControllerScaler struct {
	// contains filtered or unexported fields
}

func (*ReplicationControllerScaler) Scale added in v0.18.0 

func (scaler *ReplicationControllerScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, waitForReplicas *RetryParams) error

Scale updates a ReplicationController to a new size, with optional precondition check (if preconditions is not nil), optional retries (if retry is not nil), and then optionally waits for it's replica count to reach the new value (if wait is not nil).

func (*ReplicationControllerScaler) ScaleSimple added in v0.18.0 

func (scaler *ReplicationControllerScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) 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
	HandledResources() []string
}

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 

type ResourcePrinterFunc func(runtime.Object, io.Writer) error

ResourcePrinterFunc is a function that can print objects

func (ResourcePrinterFunc) HandledResources added in v1.1.1 

func (fn ResourcePrinterFunc) HandledResources() []string

TODO: implement HandledResources()

func (ResourcePrinterFunc) PrintObj added in v0.9.0 

func (fn ResourcePrinterFunc) PrintObj(obj runtime.Object, w io.Writer) error

PrintObj implements ResourcePrinter

type ResourceQuotaDescriber added in v0.10.0 

type ResourceQuotaDescriber struct {
	client.Interface
}

ResourceQuotaDescriber generates information about a resource quota

func (*ResourceQuotaDescriber) Describe added in v0.10.0 

func (d *ResourceQuotaDescriber) Describe(namespace, name string) (string, error)

type RetryParams added in v0.15.0 

type RetryParams struct {
	Interval, Timeout time.Duration
}

RetryParams encapsulates the retry parameters used by kubectl's scaler.

func NewRetryParams added in v0.18.0 

func NewRetryParams(interval, timeout time.Duration) *RetryParams

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, client client.Interface) *RollingUpdater

NewRollingUpdater creates a RollingUpdater from a client.

func (*RollingUpdater) Update added in v0.9.0 

func (r *RollingUpdater) Update(config *RollingUpdaterConfig) error

Update all pods for a ReplicationController (oldRc) by creating a new controller (newRc) with 0 replicas, and synchronously scaling oldRc and newRc until oldRc has 0 replicas and newRc has the original # of desired replicas. Cleanup occurs based on a RollingUpdaterCleanupPolicy.

Each interval, the updater will attempt to make progress however it can without violating any availability constraints defined by the config. This means the amount scaled up or down each interval will vary based on the timeliness of readiness and the updater will always try to make progress, even slowly.

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.

A scaling event (either up or down) is considered progress; if no progress is made within the config.Timeout, an error is returned.

TODO: make this handle performing a rollback of a partially completed rollout.

type RollingUpdaterCleanupPolicy added in v0.16.2 

type RollingUpdaterCleanupPolicy string

RollingUpdaterCleanupPolicy is a cleanup action to take after the deployment is complete. 

const (
	// DeleteRollingUpdateCleanupPolicy means delete the old controller.
	DeleteRollingUpdateCleanupPolicy RollingUpdaterCleanupPolicy = "Delete"
	// PreserveRollingUpdateCleanupPolicy means keep the old controller.
	PreserveRollingUpdateCleanupPolicy RollingUpdaterCleanupPolicy = "Preserve"
	// RenameRollingUpdateCleanupPolicy means delete the old controller, and rename
	// the new controller to the name of the old controller.
	RenameRollingUpdateCleanupPolicy RollingUpdaterCleanupPolicy = "Rename"
)

type RollingUpdaterConfig added in v0.16.2 

type RollingUpdaterConfig struct {
	// Out is a writer for progress output.
	Out io.Writer
	// OldRC is an existing controller to be replaced.
	OldRc *api.ReplicationController
	// NewRc is a controller that will take ownership of updated pods (will be
	// created if needed).
	NewRc *api.ReplicationController
	// UpdatePeriod is the time to wait between individual pod updates.
	UpdatePeriod time.Duration
	// Interval is the time to wait between polling controller status after
	// update.
	Interval time.Duration
	// Timeout is the time to wait for controller updates before giving up.
	Timeout time.Duration
	// CleanupPolicy defines the cleanup action to take after the deployment is
	// complete.
	CleanupPolicy RollingUpdaterCleanupPolicy
	// The maximum number of pods that can be unavailable during the update.
	// Value can be an absolute number (ex: 5) or a percentage of total pods at
	// the start of update (ex: 10%). Absolute number is calculated from
	// percentage by rounding up. This can not be 0 if MaxSurge is 0. By
	// default, a fixed value of 1 is used. Example: when this is set to 30%,
	// the old RC can be scaled down by 30% immediately when the rolling update
	// starts. Once new pods are ready, old RC can be scaled down further,
	// followed by scaling up the new RC, ensuring that at least 70% of original
	// number of pods are available at all times during the update.
	MaxUnavailable util.IntOrString
	// The maximum number of pods that can be scheduled above the original
	// number of pods. Value can be an absolute number (ex: 5) or a percentage of total
	// pods at the start of the update (ex: 10%). This can not be 0 if
	// MaxUnavailable is 0. Absolute number is calculated from percentage by
	// rounding up. By default, a value of 1 is used. Example: when this is set
	// to 30%, the new RC can be scaled up by 30% immediately when the rolling
	// update starts. Once old pods have been killed, new RC can be scaled up
	// further, ensuring that total number of pods running at any time during
	// the update is atmost 130% of original pods.
	MaxSurge util.IntOrString
}

RollingUpdaterConfig is the configuration for a rolling deployment process.

type RuntimeSort added in v1.1.1 

type RuntimeSort struct {
	// contains filtered or unexported fields
}

RuntimeSort is an implementation of the golang sort interface that knows how to sort lists of runtime.Object

func (*RuntimeSort) Len added in v1.1.1 

func (r *RuntimeSort) Len() int

func (*RuntimeSort) Less added in v1.1.1 

func (r *RuntimeSort) Less(i, j int) bool

func (*RuntimeSort) Swap added in v1.1.1 

func (r *RuntimeSort) Swap(i, j int)

type ScalePrecondition added in v0.18.0 

type ScalePrecondition struct {
	Size            int
	ResourceVersion string
}

ScalePrecondition describes a condition that must be true for the scale 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 (*ScalePrecondition) ValidateJob added in v1.1.1 

func (precondition *ScalePrecondition) ValidateJob(job *experimental.Job) error

ValidateJob ensures that the preconditions match. Returns nil if they are valid, an error otherwise

func (*ScalePrecondition) ValidateReplicationController added in v1.1.1 

func (precondition *ScalePrecondition) ValidateReplicationController(controller *api.ReplicationController) error

ValidateReplicationController ensures that the preconditions match. Returns nil if they are valid, an error otherwise

type Scaler added in v0.18.0 

type Scaler interface {
	// Scale scales the named resource after checking preconditions. It optionally
	// retries in the event of resource version mismatch (if retry is not nil),
	// and optionally waits until the status of the resource matches newSize (if wait is not nil)
	Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, wait *RetryParams) error
	// ScaleSimple does a simple one-shot attempt at scaling - not useful on it's own, but
	// a necessary building block for Scale
	ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) error
}

func ScalerFor added in v0.18.0 

func ScalerFor(kind string, c client.Interface) (Scaler, error)

type SecretDescriber added in v0.18.0 

type SecretDescriber struct {
	client.Interface
}

SecretDescriber generates information about a secret

func (*SecretDescriber) Describe added in v0.18.0 

func (d *SecretDescriber) Describe(namespace, name string) (string, error)

type ServiceAccountDescriber added in v0.18.0 

type ServiceAccountDescriber struct {
	client.Interface
}

ServiceAccountDescriber generates information about a service.

func (*ServiceAccountDescriber) Describe added in v0.18.0 

func (d *ServiceAccountDescriber) Describe(namespace, name string) (string, error)

type ServiceDescriber 

type ServiceDescriber struct {
	client.Interface
}

ServiceDescriber generates information about a service.

func (*ServiceDescriber) Describe 

func (d *ServiceDescriber) Describe(namespace, name string) (string, error)

type ServiceGeneratorV1 added in v1.0.2 

type ServiceGeneratorV1 struct{}

The only difference between ServiceGeneratorV1 and V2 is that the service port is named "default" in V1, while it is left unnamed in V2.

func (ServiceGeneratorV1) Generate added in v1.0.2 

func (ServiceGeneratorV1) Generate(params map[string]interface{}) (runtime.Object, error)

func (ServiceGeneratorV1) ParamNames added in v1.0.2 

func (ServiceGeneratorV1) ParamNames() []GeneratorParam

type ServiceGeneratorV2 added in v1.0.2 

type ServiceGeneratorV2 struct{}

func (ServiceGeneratorV2) Generate added in v1.0.2 

func (ServiceGeneratorV2) Generate(params map[string]interface{}) (runtime.Object, error)

func (ServiceGeneratorV2) ParamNames added in v1.0.2 

func (ServiceGeneratorV2) ParamNames() []GeneratorParam

type ServiceReaper added in v0.9.1 

type ServiceReaper struct {
	client.Interface
}

func (*ServiceReaper) Stop added in v0.9.1 

func (reaper *ServiceReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *api.DeleteOptions) (string, error)

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.0 

type SortableEvents []api.Event

SortableEvents implements sort.Interface for []api.Event based on the Timestamp field

func (SortableEvents) Len added in v0.8.0 

func (list SortableEvents) Len() int

func (SortableEvents) Less added in v0.8.0 

func (list SortableEvents) Less(i, j int) bool

func (SortableEvents) Swap added in v0.8.0 

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 SortingPrinter added in v1.1.1 

type SortingPrinter struct {
	SortField string
	Delegate  ResourcePrinter
}

Sorting printer sorts list types before delegating to another printer. Non-list types are simply passed through

func (*SortingPrinter) HandledResources added in v1.1.1 

func (p *SortingPrinter) HandledResources() []string

TODO: implement HandledResources()

func (*SortingPrinter) PrintObj added in v1.1.1 

func (s *SortingPrinter) PrintObj(obj runtime.Object, out io.Writer) error

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)

func (*TemplatePrinter) HandledResources added in v1.1.1 

func (p *TemplatePrinter) HandledResources() []string

TODO: implement HandledResources()

func (*TemplatePrinter) PrintObj 

func (p *TemplatePrinter) PrintObj(obj runtime.Object, w io.Writer) error

PrintObj formats the obj with the Go Template.

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.

func (*VersionedPrinter) HandledResources added in v1.1.1 

func (p *VersionedPrinter) HandledResources() []string

TODO: implement HandledResources()

func (*VersionedPrinter) PrintObj added in v0.9.0 

func (p *VersionedPrinter) PrintObj(obj runtime.Object, w io.Writer) error

PrintObj implements ResourcePrinter

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.

func (*YAMLPrinter) HandledResources added in v1.1.1 

func (p *YAMLPrinter) HandledResources() []string

TODO: implement HandledResources()

func (*YAMLPrinter) PrintObj 

func (p *YAMLPrinter) PrintObj(obj runtime.Object, w io.Writer) error

PrintObj prints the data as YAML.

Source Files

View all Source files

Directories

Path Synopsis
cmd
config
util
util/editor
util/jsonmerge
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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.