kubectl

type BasicReplicationController ¶ added in v0.9.0

type BasicReplicationController struct{}

func (BasicReplicationController) Generate(params map[string]string) (runtime.Object, error)

func (BasicReplicationController) ParamNames() []GeneratorParam

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 (c ControllerScaleError) Error() string

type ControllerScaleErrorType ¶ added in v0.18.0

type ControllerScaleErrorType int

const (
	ControllerScaleGetFailure ControllerScaleErrorType = iota
	ControllerScaleUpdateFailure
)

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(kind string, c *client.Client) (Describer, bool)

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 (d *Describers) Add(fns ...interface{}) error

func(...) (string, error)

func (d *Describers) DescribeObject(exact interface{}, extra ...interface{}) (string, error)

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 (e ErrNoDescriber) Error() string

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 (f *FilterServer) HandlerFor(delegate http.Handler) *FilterServer

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]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

type GeneratorParam struct {
	Name     string
	Required bool
}

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(noHeaders, withNamespace bool, wide bool, columnLabels []string) *HumanReadablePrinter

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

func (h *HumanReadablePrinter) Handler(columns []string, printFunc interface{}) error

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

type JSONPrinter ¶

type JSONPrinter struct {
}

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

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

type LimitRangeDescriber ¶ added in v0.10.0

type LimitRangeDescriber struct {
	client.Interface
}

LimitRangeDescriber generates information about a limit range

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

type NamespaceDescriber ¶ added in v0.20.0

type NamespaceDescriber struct {
	client.Interface
}

NamespaceDescriber generates information about a namespace

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

type NamespaceInfo ¶

type NamespaceInfo struct {
	Namespace string
}

type NoSuchReaperError ¶ added in v0.16.0

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

func (n *NoSuchReaperError) Error() string

type NodeDescriber ¶ added in v0.13.0

type NodeDescriber struct {
	client.Interface
}

NodeDescriber generates information about a node.

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

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 (m OutputVersionMapper) RESTMapping(kind string, versions ...string) (*meta.RESTMapping, error)

type PersistentVolumeClaimDescriber ¶ added in v0.15.0

type PersistentVolumeClaimDescriber struct {
	client.Interface
}

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

type PersistentVolumeDescriber ¶ added in v0.15.0

type PersistentVolumeDescriber struct {
	client.Interface
}

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 (d *PodDescriber) Describe(namespace, name string) (string, error)

type PodReaper ¶ added in v0.9.1

type PodReaper struct {
	client.Interface
}

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 (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(filebase string, apiProxyPrefix string, staticPrefix string, filter *FilterServer, cfg *client.Config) (*ProxyServer, error)

func (s *ProxyServer) Serve(port int) error

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(kind string, c client.Interface) (Reaper, error)

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 (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 (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 (scaler *ReplicationControllerScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, waitForReplicas *RetryParams) error

func (scaler *ReplicationControllerScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, 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(format, formatArgument string) (ResourcePrinter, bool, error)

func NewVersionedPrinter(printer ResourcePrinter, convertor runtime.ObjectConvertor, version ...string) ResourcePrinter

type ResourcePrinterFunc ¶ added in v0.9.0

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

ResourcePrinterFunc is a function that can print objects

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

type ResourceQuotaDescriber ¶ added in v0.10.0

type ResourceQuotaDescriber struct {
	client.Interface
}

ResourceQuotaDescriber generates information about a resource quota

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(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(namespace string, c RollingUpdaterClient) *RollingUpdater

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

type RollingUpdaterCleanupPolicy ¶ added in v0.16.0

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 RollingUpdaterClient ¶ added in v0.16.0

type RollingUpdaterClient interface {
	ListReplicationControllers(namespace string, selector labels.Selector) (*api.ReplicationControllerList, error)
	GetReplicationController(namespace, name string) (*api.ReplicationController, error)
	UpdateReplicationController(namespace string, rc *api.ReplicationController) (*api.ReplicationController, error)
	CreateReplicationController(namespace string, rc *api.ReplicationController) (*api.ReplicationController, error)
	DeleteReplicationController(namespace, name string) error
	ControllerHasDesiredReplicas(rc *api.ReplicationController) wait.ConditionFunc
}

RollingUpdaterClient abstracts access to ReplicationControllers.

func NewRollingUpdaterClient(c client.Interface) RollingUpdaterClient

type RollingUpdaterConfig ¶ added in v0.16.0

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
}

RollingUpdaterConfig is the configuration for a rolling deployment process.

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 (precondition *ScalePrecondition) Validate(controller *api.ReplicationController) error

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) (string, error)
}

func ScalerFor(kind string, c ScalerClient) (Scaler, error)

type ScalerClient ¶ added in v0.18.0

type ScalerClient interface {
	GetReplicationController(namespace, name string) (*api.ReplicationController, error)
	UpdateReplicationController(namespace string, rc *api.ReplicationController) (*api.ReplicationController, error)
	ControllerHasDesiredReplicas(rc *api.ReplicationController) wait.ConditionFunc
}

ScalerClient abstracts access to ReplicationControllers.

func NewScalerClient(c client.Interface) ScalerClient

type SecretDescriber ¶ added in v0.18.0

type SecretDescriber struct {
	client.Interface
}

SecretDescriber generates information about a secret

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 (d *ServiceAccountDescriber) Describe(namespace, name string) (string, error)

type ServiceDescriber ¶

type ServiceDescriber struct {
	client.Interface
}

ServiceDescriber generates information about a service.

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

type ServiceGenerator ¶ added in v0.11.0

type ServiceGenerator struct{}

func (ServiceGenerator) Generate(params map[string]string) (runtime.Object, error)

func (ServiceGenerator) ParamNames() []GeneratorParam

type ServiceReaper ¶ added in v0.9.1

type ServiceReaper struct {
	client.Interface
}

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 (e ShortcutExpander) VersionAndKindForResource(resource string) (defaultVersion, kind string, err error)

type SortableEvents ¶ added in v0.8.0

type SortableEvents []api.Event

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

func (list SortableEvents) Len() int

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

func (list SortableEvents) Swap(i, j int)

type SortableResourceNames ¶ added in v0.10.0

type SortableResourceNames []api.ResourceName

func (list SortableResourceNames) Len() int

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

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(tmpl []byte) (*TemplatePrinter, error)

func (p *TemplatePrinter) PrintObj(obj runtime.Object, w io.Writer) 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.

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

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 (p *YAMLPrinter) PrintObj(obj runtime.Object, w io.Writer) error