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: May 25, 2016 License: Apache-2.0 Imports: 61 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateConfigMap added in v1.1.5 

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

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

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

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

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 

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

func DescribeMatchingResources 

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

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 

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

func NewCmdApiVersions 

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

func NewCmdApply added in v1.0.7 

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

func NewCmdAttach 

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

func NewCmdAutoscale added in v1.1.2 

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

func NewCmdClusterInfo 

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

func NewCmdConvert added in v1.0.7 

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

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

func NewCmdCreate 

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

func NewCmdCreateConfigMap added in v1.1.5 

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

ConfigMap is a command to ease creating ConfigMaps.

func NewCmdCreateNamespace added in v1.1.3 

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

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

NewCmdCreateSecret groups subcommands to create various types of secrets

func NewCmdCreateSecretDockerRegistry added in v1.1.3 

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

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

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

NewCmdCreateServiceAccount is a macro command to create a new service account

func NewCmdDelete 

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

func NewCmdDescribe 

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

func NewCmdDrain added in v1.1.3 

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

func NewCmdEdit added in v1.0.7 

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

func NewCmdExec 

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

func NewCmdExplain added in v1.0.7 

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

NewCmdExplain returns a cobra command for swagger docs

func NewCmdExposeService 

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

func NewCmdGet 

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 

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

func NewCmdLogs added in v1.1.2 

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 

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

func NewCmdPortForward 

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

func NewCmdProxy 

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

func NewCmdReplace 

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

func NewCmdRollingUpdate 

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

func NewCmdRun 

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

func NewCmdRunWithOptions added in v1.1.5 

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

func NewCmdScale 

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 

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

func NewCmdUncordon added in v1.1.3 

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

func NewCmdVersion 

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

func NewKubectlCommand 

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 

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 

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

func RunApiVersions 

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

func RunApply added in v1.0.7 

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

func RunAutoscale added in v1.1.2 

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

func RunClusterInfo 

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

func RunCreate 

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

func RunCreateSubcommand added in v1.1.3 

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 

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

func RunDescribe 

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

func RunEdit added in v1.0.7 

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

func RunExplain added in v1.0.7 

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 

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

func RunGet 

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 

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

func RunPatch 

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

func RunPortForward 

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

func RunProxy 

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

func RunReplace 

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

func RunRollingUpdate 

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

func RunScale 

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

RunScale executes the scaling

func RunStop 

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

func RunVersion 

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

func ValidateArgs 

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

Types

type AnnotateOptions 

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

AnnotateOptions have the data required to perform the annotate operation

func (*AnnotateOptions) Complete 

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 

func (o AnnotateOptions) RunAnnotate() error

RunAnnotate does the work

func (AnnotateOptions) Validate 

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

type ApplyOptions struct {
	Filenames []string
	Recursive bool
}

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

type AttachOptions 

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 

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

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

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

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

func (*AttachOptions) Run 

func (p *AttachOptions) Run() error

Run executes a validated remote execution against a pod.

func (*AttachOptions) Validate 

func (p *AttachOptions) Validate() error

Validate checks that the provided attach options are specified.

type AutoscaleOptions 

type AutoscaleOptions struct {
	Filenames []string
	Recursive bool
}

AutoscaleOptions 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 ConvertOptions added in v1.0.7 

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

ConvertOptions have the data required to perform the convert operation

func (*ConvertOptions) Complete added in v1.0.7 

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

func (o *ConvertOptions) RunConvert() error

RunConvert implements the generic Convert command

type CreateOptions added in v1.0.7 

type CreateOptions struct {
	Filenames []string
	Recursive bool
}

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

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 

type DefaultRemoteAttach struct{}

DefaultRemoteAttach is the standard implementation of attaching

func (*DefaultRemoteAttach) Attach 

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

type DefaultRemoteExecutor 

type DefaultRemoteExecutor struct{}

DefaultRemoteExecutor is the standard implementation of remote command execution

func (*DefaultRemoteExecutor) Execute 

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

type DeleteOptions struct {
	Filenames []string
	Recursive bool
}

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

type DescribeOptions struct {
	Filenames []string
	Recursive bool
}

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

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

func (*DrainOptions) RunCordonOrUncordon added in v1.1.3 

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

func (o *DrainOptions) RunDrain() error

RunDrain runs the 'drain' command

func (*DrainOptions) SetupDrain added in v1.1.3 

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 EditOptions 

type EditOptions struct {
	Filenames []string
	Recursive bool
}

EditOptions 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 ExecOptions 

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 

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 

func (p *ExecOptions) Run() error

Run executes a validated remote execution against a pod.

func (*ExecOptions) Validate 

func (p *ExecOptions) Validate() error

Validate checks that the provided exec options are specified.

type ExposeOptions added in v1.0.7 

type ExposeOptions struct {
	Filenames []string
	Recursive bool
}

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

type GetOptions struct {
	Filenames []string
	Recursive bool
}

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

type LabelOptions struct {
	Filenames []string
	Recursive bool
}

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

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

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

func (LogsOptions) RunLogs added in v1.1.2 

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

RunLogs retrieves a pod log

func (LogsOptions) Validate added in v1.0.7 

func (o LogsOptions) Validate() error

type PatchOptions added in v1.0.7 

type PatchOptions struct {
	Filenames []string
	Recursive bool
}

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 

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 

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

type ReplaceOptions struct {
	Filenames []string
	Recursive bool
}

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

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 RunOptions added in v1.1.5 

type RunOptions struct {
	DefaultRestartAlwaysGenerator string
	DefaultGenerator              string
}

type ScaleOptions added in v1.0.7 

type ScaleOptions struct {
	Filenames []string
	Recursive bool
}

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

type StopOptions struct {
	Filenames []string
	Recursive bool
}

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

Source Files

View all Source files

Directories

Path Synopsis
editor
jsonmerge

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.