cmd

package
v1.3.0-alpha.1 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2016 License: Apache-2.0 Imports: 60 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateConfigMap added in v1.2.0

func CreateConfigMap(f *cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error

CreateConfigMap is the implementation of the create configmap generic command.

func CreateNamespace added in v1.2.0

func CreateNamespace(f *cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error

CreateNamespace implements the behavior to run the create namespace command

func CreateSecretDockerRegistry added in v1.2.0

func CreateSecretDockerRegistry(f *cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error

CreateSecretDockerRegistry is the implementation of the create secret docker-registry command

func CreateSecretGeneric added in v1.2.0

func CreateSecretGeneric(f *cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error

CreateSecretGeneric is the implementation of the create secret generic command

func CreateServiceAccount added in v1.2.0

func CreateServiceAccount(f *cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error

CreateServiceAccount implements the behavior to run the create service account command

func DeleteResult added in v0.16.0

func DeleteResult(r *resource.Result, out io.Writer, ignoreNotFound bool, shortOutput bool, mapper meta.RESTMapper) error

func DescribeMatchingResources added in v0.17.0

func DescribeMatchingResources(mapper meta.RESTMapper, typer runtime.ObjectTyper, f *cmdutil.Factory, namespace, rsrc, prefix string, out io.Writer, originalError error) error

func NameFromCommandArgs added in v1.2.0

func NameFromCommandArgs(cmd *cobra.Command, args []string) (string, error)

NameFromCommandArgs is a utility function for commands that assume the first argument is a resource name

func NewCmdAnnotate added in v1.1.1

func NewCmdAnnotate(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdApiVersions added in v0.15.0

func NewCmdApiVersions(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdApply added in v1.1.1

func NewCmdApply(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdAttach added in v1.1.1

func NewCmdAttach(f *cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command

func NewCmdAutoscale added in v1.1.1

func NewCmdAutoscale(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdClusterInfo added in v0.15.0

func NewCmdClusterInfo(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdConvert added in v1.2.0

func NewCmdConvert(f *cmdutil.Factory, out io.Writer) *cobra.Command

NewCmdConvert creates a command object for the generic "convert" action, which translates the config file into a given version.

func NewCmdCordon added in v1.2.0

func NewCmdCordon(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdCreate added in v0.15.0

func NewCmdCreate(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdCreateConfigMap added in v1.2.0

func NewCmdCreateConfigMap(f *cmdutil.Factory, cmdOut io.Writer) *cobra.Command

ConfigMap is a command to ease creating ConfigMaps.

func NewCmdCreateNamespace added in v1.2.0

func NewCmdCreateNamespace(f *cmdutil.Factory, cmdOut io.Writer) *cobra.Command

NewCmdCreateNamespace is a macro command to create a new namespace

func NewCmdCreateSecret added in v1.2.0

func NewCmdCreateSecret(f *cmdutil.Factory, cmdOut io.Writer) *cobra.Command

NewCmdCreateSecret groups subcommands to create various types of secrets

func NewCmdCreateSecretDockerRegistry added in v1.2.0

func NewCmdCreateSecretDockerRegistry(f *cmdutil.Factory, cmdOut io.Writer) *cobra.Command

NewCmdCreateSecretDockerRegistry is a macro command for creating secrets to work with Docker registries

func NewCmdCreateSecretGeneric added in v1.2.0

func NewCmdCreateSecretGeneric(f *cmdutil.Factory, cmdOut io.Writer) *cobra.Command

NewCmdCreateSecretGeneric is a command to create generic secrets from files, directories, or literal values

func NewCmdCreateServiceAccount added in v1.2.0

func NewCmdCreateServiceAccount(f *cmdutil.Factory, cmdOut io.Writer) *cobra.Command

NewCmdCreateServiceAccount is a macro command to create a new service account

func NewCmdDelete added in v0.15.0

func NewCmdDelete(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdDescribe added in v0.15.0

func NewCmdDescribe(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdDrain added in v1.2.0

func NewCmdDrain(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdEdit added in v1.1.1

func NewCmdEdit(f *cmdutil.Factory, out, errOut io.Writer) *cobra.Command

func NewCmdExec added in v0.15.0

func NewCmdExec(f *cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command

func NewCmdExplain added in v1.2.0

func NewCmdExplain(f *cmdutil.Factory, out io.Writer) *cobra.Command

NewCmdExplain returns a cobra command for swagger docs

func NewCmdExposeService added in v0.15.0

func NewCmdExposeService(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdGet added in v0.15.0

func NewCmdGet(f *cmdutil.Factory, out io.Writer) *cobra.Command

NewCmdGet creates a command object for the generic "get" action, which retrieves one or more resources from a server.

func NewCmdLabel added in v0.15.0

func NewCmdLabel(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdLogs added in v1.2.0

func NewCmdLogs(f *cmdutil.Factory, out io.Writer) *cobra.Command

NewCmdLog creates a new pod logs command

func NewCmdNamespace

func NewCmdNamespace(out io.Writer) *cobra.Command

TODO remove once people have been given enough time to notice

func NewCmdPatch added in v0.21.0

func NewCmdPatch(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdPortForward added in v0.15.0

func NewCmdPortForward(f *cmdutil.Factory) *cobra.Command

func NewCmdProxy

func NewCmdProxy(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdReplace added in v0.21.0

func NewCmdReplace(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdRollingUpdate added in v0.15.0

func NewCmdRollingUpdate(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdRun added in v0.18.2

func NewCmdRun(f *cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command

func NewCmdScale added in v0.18.2

func NewCmdScale(f *cmdutil.Factory, out io.Writer) *cobra.Command

NewCmdScale returns a cobra command with the appropriate configuration and flags to run scale

func NewCmdStop added in v0.15.0

func NewCmdStop(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdUncordon added in v1.2.0

func NewCmdUncordon(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewCmdVersion

func NewCmdVersion(f *cmdutil.Factory, out io.Writer) *cobra.Command

func NewKubectlCommand added in v0.15.0

func NewKubectlCommand(f *cmdutil.Factory, in io.Reader, out, err io.Writer) *cobra.Command

NewKubectlCommand creates the `kubectl` command and its nested children.

func ReapResult added in v0.16.0

func ReapResult(r *resource.Result, f *cmdutil.Factory, out io.Writer, isDefaultDelete, ignoreNotFound bool, timeout time.Duration, gracePeriod int, shortOutput bool, mapper meta.RESTMapper) error

func Run added in v0.18.2

func Run(f *cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer, cmd *cobra.Command, args []string, argsLenAtDash int) error

func RunApiVersions added in v0.14.0

func RunApiVersions(f *cmdutil.Factory, w io.Writer) error

func RunApply added in v1.1.1

func RunApply(f *cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *ApplyOptions) error

func RunAutoscale added in v1.1.1

func RunAutoscale(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, filenames []string) error

func RunClusterInfo added in v0.13.0

func RunClusterInfo(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command) error

func RunCreate added in v0.13.0

func RunCreate(f *cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *CreateOptions) error

func RunCreateSubcommand added in v1.2.0

func RunCreateSubcommand(f *cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *CreateSubcommandOptions) error

RunCreateSubcommand executes a create subcommand using the specified options

func RunDelete added in v0.13.0

func RunDelete(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, options *DeleteOptions) error

func RunDescribe added in v0.13.0

func RunDescribe(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, options *DescribeOptions) error

func RunEdit added in v1.1.1

func RunEdit(f *cmdutil.Factory, out, errOut io.Writer, cmd *cobra.Command, args []string, filenames []string) error

func RunExplain added in v1.2.0

func RunExplain(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string) error

RunExplain executes the appropriate steps to print a model's documentation

func RunExpose added in v0.13.0

func RunExpose(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, options *ExposeOptions) error

func RunGet added in v0.9.0

func RunGet(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, options *GetOptions) error

RunGet implements the generic Get command TODO: convert all direct flag accessors to a struct and pass that instead of cmd

func RunLabel added in v0.13.0

func RunLabel(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, options *LabelOptions) error

func RunPatch added in v0.21.0

func RunPatch(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, shortOutput bool, options *PatchOptions) error

func RunPortForward added in v0.13.0

func RunPortForward(f *cmdutil.Factory, cmd *cobra.Command, args []string, fw portForwarder) error

func RunProxy added in v0.13.0

func RunProxy(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command) error

func RunReplace added in v0.21.0

func RunReplace(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, options *ReplaceOptions) error

func RunRollingUpdate added in v0.13.0

func RunRollingUpdate(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, options *RollingUpdateOptions) error

func RunScale added in v0.18.2

func RunScale(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, shortOutput bool, options *ScaleOptions) error

RunScale executes the scaling

func RunStop added in v0.16.0

func RunStop(f *cmdutil.Factory, cmd *cobra.Command, args []string, out io.Writer, options *StopOptions) error

func RunVersion added in v0.13.0

func RunVersion(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command) error

func ValidateArgs added in v0.14.0

func ValidateArgs(cmd *cobra.Command, args []string) error

Types

type AnnotateOptions added in v1.1.1

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

AnnotateOptions have the data required to perform the annotate operation

func (*AnnotateOptions) Complete added in v1.1.1

func (o *AnnotateOptions) Complete(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string) (err error)

Complete adapts from the command line args and factory to the data required.

func (AnnotateOptions) RunAnnotate added in v1.1.1

func (o AnnotateOptions) RunAnnotate() error

RunAnnotate does the work

func (AnnotateOptions) Validate added in v1.1.1

func (o AnnotateOptions) Validate(args []string) error

Validate checks to the AnnotateOptions to see if there is sufficient information run the command.

type ApplyOptions added in v1.1.1

type ApplyOptions struct {
	Filenames []string
}

ApplyOptions stores cmd.Flag values for apply. As new fields are added, add them here instead of referencing the cmd.Flags()

type AttachOptions added in v1.1.1

type AttachOptions struct {
	Namespace     string
	PodName       string
	ContainerName string
	Stdin         bool
	TTY           bool
	CommandName   string

	// InterruptParent, if set, is used to handle interrupts while attached
	InterruptParent *interrupt.Handler

	In  io.Reader
	Out io.Writer
	Err io.Writer

	Pod *api.Pod

	Attach RemoteAttach
	Client *client.Client
	Config *restclient.Config
}

AttachOptions declare the arguments accepted by the Exec command

func (*AttachOptions) Complete added in v1.1.1

func (p *AttachOptions) Complete(f *cmdutil.Factory, cmd *cobra.Command, argsIn []string) error

Complete verifies command line arguments and loads data from the command environment

func (*AttachOptions) GetContainer added in v1.2.0

func (p *AttachOptions) GetContainer(pod *api.Pod) api.Container

GetContainer returns the container to attach to, with a fallback.

func (*AttachOptions) GetContainerName added in v1.1.1

func (p *AttachOptions) GetContainerName(pod *api.Pod) string

GetContainerName returns the name of the container to attach to, with a fallback.

func (*AttachOptions) Run added in v1.1.1

func (p *AttachOptions) Run() error

Run executes a validated remote execution against a pod.

func (*AttachOptions) Validate added in v1.1.1

func (p *AttachOptions) Validate() error

Validate checks that the provided attach options are specified.

type ConvertOptions added in v1.2.0

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

ConvertOptions have the data required to perform the convert operation

func (*ConvertOptions) Complete added in v1.2.0

func (o *ConvertOptions) Complete(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string) (err error)

Complete collects information required to run Convert command from command line.

func (*ConvertOptions) RunConvert added in v1.2.0

func (o *ConvertOptions) RunConvert() error

RunConvert implements the generic Convert command

type CreateOptions added in v1.1.1

type CreateOptions struct {
	Filenames []string
}

CreateOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type CreateSubcommandOptions added in v1.2.0

type CreateSubcommandOptions struct {
	// Name of resource being created
	Name string
	// StructuredGenerator is the resource generator for the object being created
	StructuredGenerator kubectl.StructuredGenerator
	// DryRun is true if the command should be simulated but not run against the server
	DryRun bool
	// OutputFormat
	OutputFormat string
}

CreateSubcommandOptions is an options struct to support create subcommands

type DefaultRemoteAttach added in v1.1.1

type DefaultRemoteAttach struct{}

DefaultRemoteAttach is the standard implementation of attaching

func (*DefaultRemoteAttach) Attach added in v1.1.1

func (*DefaultRemoteAttach) Attach(method string, url *url.URL, config *restclient.Config, stdin io.Reader, stdout, stderr io.Writer, tty bool) error

type DefaultRemoteExecutor added in v1.1.1

type DefaultRemoteExecutor struct{}

DefaultRemoteExecutor is the standard implementation of remote command execution

func (*DefaultRemoteExecutor) Execute added in v1.1.1

func (*DefaultRemoteExecutor) Execute(method string, url *url.URL, config *restclient.Config, stdin io.Reader, stdout, stderr io.Writer, tty bool) error

type DeleteOptions added in v1.1.1

type DeleteOptions struct {
	Filenames []string
}

DeleteOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type DescribeOptions added in v1.1.1

type DescribeOptions struct {
	Filenames []string
}

DescribeOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type DrainOptions added in v1.2.0

type DrainOptions struct {
	Force              bool
	GracePeriodSeconds int
	IgnoreDaemonsets   bool
	// contains filtered or unexported fields
}

func (*DrainOptions) RunCordonOrUncordon added in v1.2.0

func (o *DrainOptions) RunCordonOrUncordon(desired bool) error

RunCordonOrUncordon runs either Cordon or Uncordon. The desired value for "Unschedulable" is passed as the first arg.

func (*DrainOptions) RunDrain added in v1.2.0

func (o *DrainOptions) RunDrain() error

RunDrain runs the 'drain' command

func (*DrainOptions) SetupDrain added in v1.2.0

func (o *DrainOptions) SetupDrain(cmd *cobra.Command, args []string) error

SetupDrain populates some fields from the factory, grabs command line arguments and looks up the node using Builder

type ExecOptions added in v1.1.1

type ExecOptions struct {
	Namespace     string
	PodName       string
	ContainerName string
	Stdin         bool
	TTY           bool
	Command       []string

	In  io.Reader
	Out io.Writer
	Err io.Writer

	Executor RemoteExecutor
	Client   *client.Client
	Config   *restclient.Config
}

ExecOptions declare the arguments accepted by the Exec command

func (*ExecOptions) Complete added in v1.1.1

func (p *ExecOptions) Complete(f *cmdutil.Factory, cmd *cobra.Command, argsIn []string, argsLenAtDash int) error

Complete verifies command line arguments and loads data from the command environment

func (*ExecOptions) Run added in v1.1.1

func (p *ExecOptions) Run() error

Run executes a validated remote execution against a pod.

func (*ExecOptions) Validate added in v1.1.1

func (p *ExecOptions) Validate() error

Validate checks that the provided exec options are specified.

type ExposeOptions added in v1.1.1

type ExposeOptions struct {
	Filenames []string
}

ExposeOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type GetOptions added in v1.1.1

type GetOptions struct {
	Filenames []string
}

GetOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type LabelOptions added in v1.1.1

type LabelOptions struct {
	Filenames []string
}

LabelOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type LogsOptions added in v1.2.0

type LogsOptions struct {
	Namespace   string
	ResourceArg string
	Options     runtime.Object

	Mapper       meta.RESTMapper
	Typer        runtime.ObjectTyper
	ClientMapper resource.ClientMapper
	Decoder      runtime.Decoder

	Object        runtime.Object
	LogsForObject func(object, options runtime.Object) (*restclient.Request, error)

	Out io.Writer
}

func (*LogsOptions) Complete added in v1.2.0

func (o *LogsOptions) Complete(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string) error

func (LogsOptions) RunLogs added in v1.2.0

func (o LogsOptions) RunLogs() (int64, error)

RunLogs retrieves a pod log

func (LogsOptions) Validate added in v1.2.0

func (o LogsOptions) Validate() error

type PatchOptions added in v1.1.1

type PatchOptions struct {
	Filenames []string
}

PatchOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type RemoteAttach added in v1.1.1

type RemoteAttach interface {
	Attach(method string, url *url.URL, config *restclient.Config, stdin io.Reader, stdout, stderr io.Writer, tty bool) error
}

RemoteAttach defines the interface accepted by the Attach command - provided for test stubbing

type RemoteExecutor added in v1.1.1

type RemoteExecutor interface {
	Execute(method string, url *url.URL, config *restclient.Config, stdin io.Reader, stdout, stderr io.Writer, tty bool) error
}

RemoteExecutor defines the interface accepted by the Exec command - provided for test stubbing

type ReplaceOptions added in v1.1.1

type ReplaceOptions struct {
	Filenames []string
}

ReplaceOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type RollingUpdateOptions added in v1.1.1

type RollingUpdateOptions struct {
	Filenames []string
}

RollingUpdateOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type ScaleOptions added in v1.1.1

type ScaleOptions struct {
	Filenames []string
}

ScaleOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

type StopOptions added in v1.1.1

type StopOptions struct {
	Filenames []string
}

StopOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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