kubectl

package
v0.10.1-0...-64678b7 Latest Latest
Warning

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

 Go to latest Published: Feb 14, 2015 License: Apache-2.0 Imports: 29 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

This section is empty.

Variables

View Source 
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 GetClientVersion 

func GetClientVersion(w io.Writer)

func GetVersion 

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

func MakeLabels 

func MakeLabels(labels map[string]string) string

func MakeParams 

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

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

func ParseLabels 

func ParseLabels(labelString string) map[string]string

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

func ValidateParams 

func ValidateParams(paramSpec []GeneratorParam, params map[string]string) 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 BasicReplicationController 

type BasicReplicationController struct{}

func (BasicReplicationController) Generate 

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

func (BasicReplicationController) ParamNames 

func (BasicReplicationController) ParamNames() []GeneratorParam

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.

func DescriberFor 

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

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

type Generator 

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 

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 

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.

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 JSONPrinter 

type JSONPrinter struct {
}

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

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 LimitRangeDescriber 

type LimitRangeDescriber struct {
	client.Interface
}

LimitRangeDescriber generates information about a limit range

func (*LimitRangeDescriber) Describe 

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

type MinionDescriber 

type MinionDescriber struct {
	client.Interface
}

MinionDescriber generates information about a minion.

func (*MinionDescriber) Describe 

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

type NamespaceInfo 

type NamespaceInfo struct {
	Namespace string
}

type OutputVersionMapper 

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 

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 

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 

type PodReaper struct {
	client.Interface
}

func (*PodReaper) Stop 

func (reaper *PodReaper) Stop(namespace, name string) (string, error)

type PreconditionError 

type PreconditionError struct {
	Precondition  string
	ExpectedValue string
	ActualValue   string
}

func (*PreconditionError) Error 

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 Reaper 

type Reaper interface {
	Stop(namespace, name string) (string, error)
}

A Reaper handles terminating an object as gracefully as possible.

func ReaperFor 

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

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

func (*ReplicationControllerReaper) Stop 

func (reaper *ReplicationControllerReaper) Stop(namespace, name string) (string, error)

type ReplicationControllerResizer 

type ReplicationControllerResizer struct {
	client.Interface
}

func (*ReplicationControllerResizer) Resize 

func (resize *ReplicationControllerResizer) Resize(namespace, name string, preconditions *ResizePrecondition, newSize uint) (string, error)

type ResizePrecondition 

type ResizePrecondition struct {
	Size            int
	ResourceVersion string
}

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 

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 

type Resizer interface {
	Resize(namespace, name string, preconditions *ResizePrecondition, newSize uint) (string, error)
}

func ResizerFor 

func ResizerFor(kind string, c client.Interface) (Resizer, 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 

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 

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

ResourcePrinterFunc is a function that can print objects

func (ResourcePrinterFunc) PrintObj 

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

PrintObj implements ResourcePrinter

type ResourceQuotaDescriber 

type ResourceQuotaDescriber struct {
	client.Interface
}

ResourceQuotaDescriber generates information about a resource quota

func (*ResourceQuotaDescriber) Describe 

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

type RollingUpdater 

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

RollingUpdater provides methods for updating replicated pods in a predictable, fault-tolerant way.

func NewRollingUpdater 

func NewRollingUpdater(namespace string, c client.Interface) *RollingUpdater

NewRollingUpdater creates a RollingUpdater from a client

func (*RollingUpdater) Update 

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 

type ServiceDescriber struct {
	client.Interface
}

ServiceDescriber generates information about a service.

func (*ServiceDescriber) Describe 

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

type ServiceGenerator 

type ServiceGenerator struct{}

func (ServiceGenerator) Generate 

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

func (ServiceGenerator) ParamNames 

func (ServiceGenerator) ParamNames() []GeneratorParam

type ServiceReaper 

type ServiceReaper struct {
	client.Interface
}

func (*ServiceReaper) Stop 

func (reaper *ServiceReaper) Stop(namespace, name string) (string, error)

type ShortcutExpander 

type ShortcutExpander struct {
	meta.RESTMapper
}

ShortcutExpander is a RESTMapper that can be used for Kubernetes resources.

func (ShortcutExpander) VersionAndKindForResource 

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 

type SortableEvents []api.Event

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

func (SortableEvents) Len 

func (list SortableEvents) Len() int

func (SortableEvents) Less 

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

func (SortableEvents) Swap 

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

type SortableResourceNames 

type SortableResourceNames []api.ResourceName

func (SortableResourceNames) Len 

func (list SortableResourceNames) Len() int

func (SortableResourceNames) Less 

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

func (SortableResourceNames) Swap 

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)

func (*TemplatePrinter) PrintObj 

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

PrintObj formats the obj with the Go Template.

type VersionedPrinter 

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) PrintObj 

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