cmd

package
v1.11.9 Latest Latest
Warning

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

 Go to latest Published: Mar 21, 2019 License: Apache-2.0 Imports: 119 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	EvictionKind        = "Eviction"
	EvictionSubresource = "pods/eviction"
)

Variables

This section is empty.

Functions

func NewCmdAlpha added in v1.8.0 

func NewCmdAlpha(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

NewCmdAlpha creates a command that acts as an alternate root command for features in alpha

func NewCmdAnnotate added in v1.1.1 

func NewCmdAnnotate(parent string, f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdApiResources added in v1.11.1 

func NewCmdApiResources(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdApiVersions added in v0.15.0 

func NewCmdApiVersions(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdApply added in v1.1.1 

func NewCmdApply(baseName string, f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdApplyEditLastApplied added in v1.7.0 

func NewCmdApplyEditLastApplied(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdApplySetLastApplied added in v1.6.0 

func NewCmdApplySetLastApplied(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdApplyViewLastApplied added in v1.6.0 

func NewCmdApplyViewLastApplied(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdAttach added in v1.1.1 

func NewCmdAttach(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdAutoscale added in v1.1.1 

func NewCmdAutoscale(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdCertificate added in v1.5.1 

func NewCmdCertificate(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdCertificateApprove added in v1.5.1 

func NewCmdCertificateApprove(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdCertificateDeny added in v1.5.1 

func NewCmdCertificateDeny(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdClusterInfo added in v0.15.0 

func NewCmdClusterInfo(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdClusterInfoDump added in v1.3.0 

func NewCmdClusterInfoDump(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

NewCmdCreateSecret groups subcommands to create various types of secrets

func NewCmdCompletion added in v1.3.0 

func NewCmdCompletion(out io.Writer, boilerPlate string) *cobra.Command

func NewCmdConvert added in v1.2.0 

func NewCmdConvert(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *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, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdCp added in v1.5.1 

func NewCmdCp(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

NewCmdCp creates a new Copy command.

func NewCmdDelete added in v0.15.0 

func NewCmdDelete(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdDescribe added in v0.15.0 

func NewCmdDescribe(parent string, f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdDiff added in v1.9.1 

func NewCmdDiff(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdDrain added in v1.2.0 

func NewCmdDrain(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdEdit added in v1.1.1 

func NewCmdEdit(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdExec added in v0.15.0 

func NewCmdExec(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdExplain added in v1.2.0 

func NewCmdExplain(parent string, f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

NewCmdExplain returns a cobra command for swagger docs

func NewCmdExposeService added in v0.15.0 

func NewCmdExposeService(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdForPlugin added in v1.7.0 

func NewCmdForPlugin(f cmdutil.Factory, plugin *plugins.Plugin, runner plugins.PluginRunner, streams genericclioptions.IOStreams) *cobra.Command

NewCmdForPlugin creates a command capable of running the provided plugin.

func NewCmdHelp added in v1.4.2 

func NewCmdHelp() *cobra.Command

func NewCmdLabel added in v0.15.0 

func NewCmdLabel(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdLogs added in v1.2.0 

func NewCmdLogs(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

NewCmdLogs creates a new pod logs command

func NewCmdOptions added in v1.4.2 

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

NewCmdOptions implements the options command

func NewCmdPatch added in v0.21.0 

func NewCmdPatch(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdPlugin added in v1.7.0 

func NewCmdPlugin(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

NewCmdPlugin creates the command that is the top-level for plugin commands.

func NewCmdPortForward added in v0.15.0 

func NewCmdPortForward(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdProxy 

func NewCmdProxy(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdReplace added in v0.21.0 

func NewCmdReplace(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdRollingUpdate added in v0.15.0 

func NewCmdRollingUpdate(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdRun added in v0.18.2 

func NewCmdRun(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdScale added in v0.18.2 

func NewCmdScale(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

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

func NewCmdTaint added in v1.3.0 

func NewCmdTaint(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdTop added in v1.4.2 

func NewCmdTop(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdTopNode added in v1.4.2 

func NewCmdTopNode(f cmdutil.Factory, o *TopNodeOptions, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdTopPod added in v1.4.2 

func NewCmdTopPod(f cmdutil.Factory, o *TopPodOptions, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdUncordon added in v1.2.0 

func NewCmdUncordon(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewCmdVersion 

func NewCmdVersion(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

func NewDefaultKubectlCommand added in v1.10.0 

func NewDefaultKubectlCommand() *cobra.Command

func NewKubectlCommand added in v0.15.0 

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

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

func RunCompletion added in v1.3.0 

func RunCompletion(out io.Writer, boilerPlate string, cmd *cobra.Command, args []string) error

func RunDiff added in v1.9.1 

func RunDiff(f cmdutil.Factory, diff *DiffProgram, options *DiffOptions, from, to string) error

RunDiff uses the factory to parse file arguments, find the version to diff, and find each Info object for each files, and runs against the differ.

func RunHelp added in v1.4.2 

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

func RunProxy added in v0.13.0 

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

func ScaleJob added in v1.11.1 

func ScaleJob(info *resource.Info, jobsClient batchclient.JobsGetter, count uint, preconditions *kubectl.ScalePrecondition, retry, waitForReplicas *kubectl.RetryParams) error

func SupportEviction added in v1.5.1 

func SupportEviction(clientset kubernetes.Interface) (string, error)

SupportEviction uses Discovery API to find out if the server support eviction subresource If support, it will return its groupVersion; Otherwise, it will return ""

func SupportedMetricsAPIVersionAvailable added in v1.10.0 

func SupportedMetricsAPIVersionAvailable(discoveredAPIGroups *metav1.APIGroupList) bool

Types

type AnnotateOptions added in v1.1.1 

type AnnotateOptions struct {
	PrintFlags *genericclioptions.PrintFlags
	PrintObj   printers.ResourcePrinterFunc

	// Filename options
	resource.FilenameOptions
	RecordFlags *genericclioptions.RecordFlags

	Recorder genericclioptions.Recorder

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

AnnotateOptions have the data required to perform the annotate operation

func NewAnnotateOptions added in v1.11.1 

func NewAnnotateOptions(ioStreams genericclioptions.IOStreams) *AnnotateOptions

func (*AnnotateOptions) Complete added in v1.1.1 

func (o *AnnotateOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) 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() error

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

type ApiResourcesOptions added in v1.11.1 

type ApiResourcesOptions struct {
	Output     string
	APIGroup   string
	Namespaced bool
	Verbs      []string
	NoHeaders  bool
	Cached     bool

	genericclioptions.IOStreams
}

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

func NewAPIResourceOptions added in v1.11.1 

func NewAPIResourceOptions(ioStreams genericclioptions.IOStreams) *ApiResourcesOptions

func (*ApiResourcesOptions) RunApiResources added in v1.11.1 

func (o *ApiResourcesOptions) RunApiResources(cmd *cobra.Command, f cmdutil.Factory) error

func (*ApiResourcesOptions) Validate added in v1.11.1 

func (o *ApiResourcesOptions) Validate(cmd *cobra.Command) error

type ApiVersionsOptions added in v1.11.1 

type ApiVersionsOptions struct {
	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func NewApiVersionsOptions added in v1.11.1 

func NewApiVersionsOptions(ioStreams genericclioptions.IOStreams) *ApiVersionsOptions

func (*ApiVersionsOptions) Complete added in v1.11.1 

func (o *ApiVersionsOptions) Complete(f cmdutil.Factory) error

func (*ApiVersionsOptions) RunApiVersions added in v1.11.1 

func (o *ApiVersionsOptions) RunApiVersions() error

type ApplyOptions added in v1.1.1 

type ApplyOptions struct {
	RecordFlags *genericclioptions.RecordFlags
	Recorder    genericclioptions.Recorder

	PrintFlags *genericclioptions.PrintFlags
	ToPrinter  func(string) (printers.ResourcePrinter, error)

	DeleteFlags   *DeleteFlags
	DeleteOptions *DeleteOptions

	Selector       string
	DryRun         bool
	Prune          bool
	PruneResources []pruneResource

	All                        bool
	Overwrite                  bool
	OpenApiPatch               bool
	PruneWhitelist             []string
	ShouldIncludeUninitialized bool

	Validator     validation.Schema
	Builder       *resource.Builder
	Mapper        meta.RESTMapper
	DynamicClient dynamic.Interface
	OpenAPISchema openapi.Resources

	Namespace        string
	EnforceNamespace bool

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func NewApplyOptions added in v1.11.1 

func NewApplyOptions(ioStreams genericclioptions.IOStreams) *ApplyOptions

func (*ApplyOptions) Complete added in v1.11.1 

func (o *ApplyOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error

func (*ApplyOptions) Run added in v1.11.1 

func (o *ApplyOptions) Run() error

type AttachOptions added in v1.1.1 

type AttachOptions struct {
	StreamOptions

	CommandName       string
	SuggestedCmdUsage string

	Pod *api.Pod

	Attach        RemoteAttach
	PodClient     coreclient.PodsGetter
	GetPodTimeout time.Duration
	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) GetContainerName added in v1.1.1 

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

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

type AutoscaleOptions struct {
	FilenameOptions *resource.FilenameOptions

	RecordFlags *genericclioptions.RecordFlags
	Recorder    genericclioptions.Recorder

	PrintFlags *genericclioptions.PrintFlags
	ToPrinter  func(string) (printers.ResourcePrinter, error)

	Name       string
	Generator  string
	Min        int32
	Max        int32
	CpuPercent int32

	HPAClient autoscalingv1client.HorizontalPodAutoscalersGetter

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func NewAutoscaleOptions added in v1.11.1 

func NewAutoscaleOptions(ioStreams genericclioptions.IOStreams) *AutoscaleOptions

func (*AutoscaleOptions) Complete added in v1.11.1 

func (o *AutoscaleOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (*AutoscaleOptions) Run added in v1.11.1 

func (o *AutoscaleOptions) Run() error

func (*AutoscaleOptions) Validate added in v1.11.1 

func (o *AutoscaleOptions) Validate() error

type CertificateOptions added in v1.5.1 

type CertificateOptions struct {
	resource.FilenameOptions

	PrintFlags *genericclioptions.PrintFlags
	PrintObj   printers.ResourcePrinterFunc

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func (*CertificateOptions) Complete added in v1.5.1 

func (o *CertificateOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (*CertificateOptions) RunCertificateApprove added in v1.5.1 

func (o *CertificateOptions) RunCertificateApprove(force bool) error

func (*CertificateOptions) RunCertificateDeny added in v1.5.1 

func (o *CertificateOptions) RunCertificateDeny(force bool) error

func (*CertificateOptions) Validate added in v1.5.1 

func (o *CertificateOptions) Validate() error

type ClusterInfoDumpOptions added in v1.11.1 

type ClusterInfoDumpOptions struct {
	PrintFlags *genericclioptions.PrintFlags
	PrintObj   printers.ResourcePrinterFunc

	OutputDir     string
	AllNamespaces bool
	Namespaces    []string

	Timeout          time.Duration
	AppsClient       appsv1client.AppsV1Interface
	CoreClient       corev1client.CoreV1Interface
	Namespace        string
	RESTClientGetter genericclioptions.RESTClientGetter
	LogsForObject    polymorphichelpers.LogsForObjectFunc

	genericclioptions.IOStreams
}

func (*ClusterInfoDumpOptions) Complete added in v1.11.1 

func (o *ClusterInfoDumpOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error

func (*ClusterInfoDumpOptions) Run added in v1.11.1 

func (o *ClusterInfoDumpOptions) Run() error

type ClusterInfoOptions added in v1.11.1 

type ClusterInfoOptions struct {
	genericclioptions.IOStreams

	Namespace string

	Builder *resource.Builder
	Client  *restclient.Config
}

func (*ClusterInfoOptions) Complete added in v1.11.1 

func (o *ClusterInfoOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error

func (*ClusterInfoOptions) Run added in v1.11.1 

func (o *ClusterInfoOptions) Run() error

type ConvertOptions added in v1.2.0 

type ConvertOptions struct {
	PrintFlags *genericclioptions.PrintFlags
	PrintObj   printers.ResourcePrinterFunc

	resource.FilenameOptions

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

ConvertOptions have the data required to perform the convert operation

func NewConvertOptions added in v1.11.1 

func NewConvertOptions(ioStreams genericclioptions.IOStreams) *ConvertOptions

func (*ConvertOptions) Complete added in v1.2.0 

func (o *ConvertOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) (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 CopyOptions added in v1.11.1 

type CopyOptions struct {
	Container string
	Namespace string

	ClientConfig *restclient.Config
	Clientset    internalclientset.Interface

	genericclioptions.IOStreams
}

func NewCopyOptions added in v1.11.1 

func NewCopyOptions(ioStreams genericclioptions.IOStreams) *CopyOptions

func (*CopyOptions) Complete added in v1.11.1 

func (o *CopyOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error

func (*CopyOptions) Run added in v1.11.1 

func (o *CopyOptions) Run(args []string) error

func (*CopyOptions) Validate added in v1.11.1 

func (o *CopyOptions) Validate(cmd *cobra.Command, args []string) error

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, terminalSizeQueue remotecommand.TerminalSizeQueue) 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, terminalSizeQueue remotecommand.TerminalSizeQueue) error

type DeleteFlags added in v1.11.1 

type DeleteFlags struct {
	FileNameFlags *genericclioptions.FileNameFlags
	LabelSelector *string
	FieldSelector *string

	All            *bool
	Cascade        *bool
	Force          *bool
	GracePeriod    *int
	IgnoreNotFound *bool
	Now            *bool
	Timeout        *time.Duration
	Wait           *bool
	Output         *string
}

PrintFlags composes common printer flag structs used for commands requiring deletion logic.

func NewDeleteCommandFlags added in v1.11.1 

func NewDeleteCommandFlags(usage string) *DeleteFlags

NewDeleteCommandFlags provides default flags and values for use with the "delete" command

func NewDeleteFlags added in v1.11.1 

func NewDeleteFlags(usage string) *DeleteFlags

NewDeleteFlags provides default flags and values for use in commands outside of "delete"

func (*DeleteFlags) AddFlags added in v1.11.1 

func (f *DeleteFlags) AddFlags(cmd *cobra.Command)

func (*DeleteFlags) ToOptions added in v1.11.1 

func (f *DeleteFlags) ToOptions(dynamicClient dynamic.Interface, streams genericclioptions.IOStreams) *DeleteOptions

type DeleteOptions added in v1.1.1 

type DeleteOptions struct {
	resource.FilenameOptions

	LabelSelector   string
	FieldSelector   string
	DeleteAll       bool
	IgnoreNotFound  bool
	Cascade         bool
	DeleteNow       bool
	ForceDeletion   bool
	WaitForDeletion bool

	GracePeriod int
	Timeout     time.Duration

	Output string

	DynamicClient dynamic.Interface
	Mapper        meta.RESTMapper
	Result        *resource.Result

	genericclioptions.IOStreams
}

func (*DeleteOptions) Complete added in v1.6.0 

func (o *DeleteOptions) Complete(f cmdutil.Factory, args []string, cmd *cobra.Command) error

func (*DeleteOptions) DeleteResult added in v1.11.1 

func (o *DeleteOptions) DeleteResult(r *resource.Result) error

func (*DeleteOptions) PrintObj added in v1.11.1 

func (o *DeleteOptions) PrintObj(info *resource.Info)

deletion printing is special because we do not have an object to print. This mirrors name printer behavior

func (*DeleteOptions) RunDelete added in v1.6.0 

func (o *DeleteOptions) RunDelete() error

func (*DeleteOptions) Validate added in v1.6.0 

func (o *DeleteOptions) Validate(cmd *cobra.Command) error

type DescribeOptions added in v1.1.1 

type DescribeOptions struct {
	CmdParent string
	Selector  string
	Namespace string

	Describer  func(*meta.RESTMapping) (printers.Describer, error)
	NewBuilder func() *resource.Builder

	BuilderArgs []string

	EnforceNamespace     bool
	AllNamespaces        bool
	IncludeUninitialized bool

	DescriberSettings *printers.DescriberSettings
	FilenameOptions   *resource.FilenameOptions

	genericclioptions.IOStreams
}

func (*DescribeOptions) Complete added in v1.11.1 

func (o *DescribeOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (*DescribeOptions) DescribeMatchingResources added in v1.11.1 

func (o *DescribeOptions) DescribeMatchingResources(originalError error, resource, prefix string) error

func (*DescribeOptions) Run added in v1.11.1 

func (o *DescribeOptions) Run() error

func (*DescribeOptions) Validate added in v1.11.1 

func (o *DescribeOptions) Validate(args []string) error

type DiffOptions added in v1.9.1 

type DiffOptions struct {
	FilenameOptions resource.FilenameOptions
}

type DiffProgram added in v1.9.1 

type DiffProgram struct {
	Exec exec.Interface
	genericclioptions.IOStreams
}

DiffProgram finds and run the diff program. The value of KUBERNETES_EXTERNAL_DIFF environment variable will be used a diff program. By default, `diff(1)` will be used.

func (*DiffProgram) Run added in v1.9.1 

func (d *DiffProgram) Run(from, to string) error

Run runs the detected diff program. `from` and `to` are the directory to diff.

type DiffVersion added in v1.9.1 

type DiffVersion struct {
	Dir  *Directory
	Name string
}

DiffVersion gets the proper version of objects, and aggregate them into a directory.

func NewDiffVersion added in v1.9.1 

func NewDiffVersion(name string) (*DiffVersion, error)

NewDiffVersion creates a new DiffVersion with the named version.

func (*DiffVersion) Print added in v1.9.1 

func (v *DiffVersion) Print(obj Object, printer Printer) error

Print prints the object using the printer into a new file in the directory.

type Differ added in v1.9.1 

type Differ struct {
	From *DiffVersion
	To   *DiffVersion
}

Differ creates two DiffVersion and diffs them.

func NewDiffer added in v1.9.1 

func NewDiffer(from, to string) (*Differ, error)

func (*Differ) Diff added in v1.9.1 

func (d *Differ) Diff(obj Object, printer Printer) error

Diff diffs to versions of a specific object, and print both versions to directories.

func (*Differ) Run added in v1.9.1 

func (d *Differ) Run(diff *DiffProgram) error

Run runs the diff program against both directories.

func (*Differ) TearDown added in v1.9.1 

func (d *Differ) TearDown()

TearDown removes both temporary directories recursively.

type Directory added in v1.9.1 

type Directory struct {
	Name string
}

Directory creates a new temp directory, and allows to easily create new files.

func CreateDirectory added in v1.9.1 

func CreateDirectory(prefix string) (*Directory, error)

CreateDirectory does create the actual disk directory, and return a new representation of it.

func (*Directory) Delete added in v1.9.1 

func (d *Directory) Delete() error

Delete removes the directory recursively.

func (*Directory) NewFile added in v1.9.1 

func (d *Directory) NewFile(name string) (*os.File, error)

NewFile creates a new file in the directory.

type Downloader added in v1.11.1 

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

func NewDownloader added in v1.11.1 

func NewDownloader(f cmdutil.Factory) (*Downloader, error)

func (*Downloader) Download added in v1.11.1 

func (d *Downloader) Download(info *resource.Info) (*unstructured.Unstructured, error)

type DrainOptions added in v1.2.0 

type DrainOptions struct {
	PrintFlags *genericclioptions.PrintFlags
	ToPrinter  func(string) (printers.ResourcePrinterFunc, error)

	Namespace string

	Force              bool
	DryRun             bool
	GracePeriodSeconds int
	IgnoreDaemonsets   bool
	Timeout            time.Duration

	DeleteLocalData bool
	Selector        string
	PodSelector     string

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func NewDrainOptions added in v1.11.1 

func NewDrainOptions(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *DrainOptions

func (*DrainOptions) Complete added in v1.11.1 

func (o *DrainOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

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

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

type ExecOptions added in v1.1.1 

type ExecOptions struct {
	StreamOptions

	Command []string

	FullCmdName       string
	SuggestedCmdUsage string

	Executor  RemoteExecutor
	PodClient coreclient.PodsGetter
	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 ExplainOptions added in v1.11.1 

type ExplainOptions struct {
	genericclioptions.IOStreams

	CmdParent  string
	ApiVersion string
	Recursive  bool

	Mapper meta.RESTMapper
	Schema openapi.Resources
}

func NewExplainOptions added in v1.11.1 

func NewExplainOptions(parent string, streams genericclioptions.IOStreams) *ExplainOptions

func (*ExplainOptions) Complete added in v1.11.1 

func (o *ExplainOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error

func (*ExplainOptions) Run added in v1.11.1 

func (o *ExplainOptions) Run(args []string) error

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

func (*ExplainOptions) Validate added in v1.11.1 

func (o *ExplainOptions) Validate(args []string) error

type ExposeServiceOptions added in v1.11.1 

type ExposeServiceOptions struct {
	FilenameOptions resource.FilenameOptions
	RecordFlags     *genericclioptions.RecordFlags
	PrintFlags      *genericclioptions.PrintFlags
	PrintObj        printers.ResourcePrinterFunc

	DryRun           bool
	EnforceNamespace bool

	Generators                func(string) map[string]kubectl.Generator
	CanBeExposed              polymorphichelpers.CanBeExposedFunc
	ClientForMapping          func(*meta.RESTMapping) (resource.RESTClient, error)
	MapBasedSelectorForObject func(runtime.Object) (string, error)
	PortsForObject            polymorphichelpers.PortsForObjectFunc
	ProtocolsForObject        func(runtime.Object) (map[string]string, error)

	Namespace string
	Mapper    meta.RESTMapper

	DynamicClient dynamic.Interface
	Builder       *resource.Builder

	Recorder genericclioptions.Recorder
	genericclioptions.IOStreams
}

func NewExposeServiceOptions added in v1.11.1 

func NewExposeServiceOptions(ioStreams genericclioptions.IOStreams) *ExposeServiceOptions

func (*ExposeServiceOptions) Complete added in v1.11.1 

func (o *ExposeServiceOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error

func (*ExposeServiceOptions) RunExpose added in v1.11.1 

func (o *ExposeServiceOptions) RunExpose(cmd *cobra.Command, args []string) error

type HeapsterTopOptions added in v1.6.0 

type HeapsterTopOptions struct {
	Namespace string
	Service   string
	Scheme    string
	Port      string
}

func (*HeapsterTopOptions) Bind added in v1.6.0 

func (o *HeapsterTopOptions) Bind(flags *pflag.FlagSet)

type InfoObject added in v1.9.1 

type InfoObject struct {
	Remote  runtime.Unstructured
	Info    *resource.Info
	Encoder runtime.Encoder
	Parser  *parse.Factory
}

InfoObject is an implementation of the Object interface. It gets all the information from the Info object.

func (InfoObject) Last added in v1.9.1 

func (obj InfoObject) Last() (map[string]interface{}, error)

func (InfoObject) Live added in v1.9.1 

func (obj InfoObject) Live() (map[string]interface{}, error)

func (InfoObject) Local added in v1.9.1 

func (obj InfoObject) Local() (map[string]interface{}, error)

func (InfoObject) Merged added in v1.9.1 

func (obj InfoObject) Merged() (map[string]interface{}, error)

func (InfoObject) Name added in v1.9.1 

func (obj InfoObject) Name() string

type LabelOptions added in v1.1.1 

type LabelOptions struct {
	// Filename options
	resource.FilenameOptions
	RecordFlags *genericclioptions.RecordFlags

	PrintFlags *genericclioptions.PrintFlags
	ToPrinter  func(string) (printers.ResourcePrinter, error)

	Recorder genericclioptions.Recorder

	// Common shared fields
	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

LabelOptions have the data required to perform the label operation

func NewLabelOptions added in v1.11.1 

func NewLabelOptions(ioStreams genericclioptions.IOStreams) *LabelOptions

func (*LabelOptions) Complete added in v1.5.1 

func (o *LabelOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

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

func (*LabelOptions) RunLabel added in v1.5.1 

func (o *LabelOptions) RunLabel() error

RunLabel does the work

func (*LabelOptions) Validate added in v1.5.1 

func (o *LabelOptions) Validate() error

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

type LogsOptions added in v1.2.0 

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

	Object           runtime.Object
	GetPodTimeout    time.Duration
	RESTClientGetter genericclioptions.RESTClientGetter
	LogsForObject    polymorphichelpers.LogsForObjectFunc

	genericclioptions.IOStreams
}

func NewLogsOptions added in v1.11.1 

func NewLogsOptions(streams genericclioptions.IOStreams, allContainers bool) *LogsOptions

func (*LogsOptions) Complete added in v1.2.0 

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

func (LogsOptions) RunLogs added in v1.2.0 

func (o LogsOptions) RunLogs() error

RunLogs retrieves a pod log

func (LogsOptions) Validate added in v1.2.0 

func (o LogsOptions) Validate() error

type Object added in v1.9.1 

type Object interface {
	Local() (map[string]interface{}, error)
	Live() (map[string]interface{}, error)
	Last() (map[string]interface{}, error)
	Merged() (map[string]interface{}, error)

	Name() string
}

Object is an interface that let's you retrieve multiple version of it.

type PatchBuffer added in v1.7.0 

type PatchBuffer struct {
	Patch     []byte
	PatchType types.PatchType
}

type PatchOptions added in v1.1.1 

type PatchOptions struct {
	resource.FilenameOptions

	RecordFlags *genericclioptions.RecordFlags
	PrintFlags  *genericclioptions.PrintFlags
	ToPrinter   func(string) (printers.ResourcePrinter, error)
	Recorder    genericclioptions.Recorder

	Local     bool
	PatchType string
	Patch     string

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

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

func NewPatchOptions added in v1.11.1 

func NewPatchOptions(ioStreams genericclioptions.IOStreams) *PatchOptions

func (*PatchOptions) Complete added in v1.11.1 

func (o *PatchOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (*PatchOptions) RunPatch added in v1.11.1 

func (o *PatchOptions) RunPatch() error

func (*PatchOptions) Validate added in v1.11.1 

func (o *PatchOptions) Validate() error

type PortForwardOptions added in v1.4.2 

type PortForwardOptions struct {
	Namespace     string
	PodName       string
	RESTClient    *restclient.RESTClient
	Config        *restclient.Config
	PodClient     coreclient.PodsGetter
	Ports         []string
	PortForwarder portForwarder
	StopChannel   chan struct{}
	ReadyChannel  chan struct{}
}

PortForwardOptions contains all the options for running the port-forward cli command.

func (*PortForwardOptions) Complete added in v1.4.2 

func (o *PortForwardOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

Complete completes all the required options for port-forward cmd.

func (PortForwardOptions) RunPortForward added in v1.4.2 

func (o PortForwardOptions) RunPortForward() error

RunPortForward implements all the necessary functionality for port-forward cmd.

func (PortForwardOptions) Validate added in v1.4.2 

func (o PortForwardOptions) Validate() error

Validate validates all the required options for port-forward cmd.

type Printer added in v1.9.1 

type Printer struct{}

Printer is used to print an object.

func (*Printer) Print added in v1.9.1 

func (p *Printer) Print(obj map[string]interface{}, w io.Writer) error

Print the object inside the writer w.

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, terminalSizeQueue remotecommand.TerminalSizeQueue) 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, terminalSizeQueue remotecommand.TerminalSizeQueue) error
}

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

type ReplaceOptions added in v1.1.1 

type ReplaceOptions struct {
	PrintFlags  *genericclioptions.PrintFlags
	DeleteFlags *DeleteFlags
	RecordFlags *genericclioptions.RecordFlags

	DeleteOptions *DeleteOptions

	PrintObj func(obj runtime.Object) error

	Schema      validation.Schema
	Builder     func() *resource.Builder
	BuilderArgs []string

	Namespace        string
	EnforceNamespace bool

	Recorder genericclioptions.Recorder

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func NewReplaceOptions added in v1.11.1 

func NewReplaceOptions(streams genericclioptions.IOStreams) *ReplaceOptions

func (*ReplaceOptions) Complete added in v1.11.1 

func (o *ReplaceOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (*ReplaceOptions) Run added in v1.11.1 

func (o *ReplaceOptions) Run() error

func (*ReplaceOptions) Validate added in v1.11.1 

func (o *ReplaceOptions) Validate(cmd *cobra.Command) error

type RollingUpdateOptions added in v1.1.1 

type RollingUpdateOptions struct {
	FilenameOptions *resource.FilenameOptions

	OldName     string
	KeepOldName bool

	DeploymentKey    string
	Image            string
	Container        string
	PullPolicy       string
	Rollback         bool
	Period           time.Duration
	Timeout          time.Duration
	Interval         time.Duration
	DryRun           bool
	OutputFormat     string
	Namespace        string
	EnforceNamespace bool

	ScaleClient scaleclient.ScalesGetter
	ClientSet   internalclientset.Interface
	Builder     *resource.Builder

	ShouldValidate bool
	Validator      func(bool) (validation.Schema, error)

	FindNewName func(*api.ReplicationController) string

	PrintFlags *genericclioptions.PrintFlags
	ToPrinter  func(string) (printers.ResourcePrinter, error)

	genericclioptions.IOStreams
}

func NewRollingUpdateOptions added in v1.11.1 

func NewRollingUpdateOptions(streams genericclioptions.IOStreams) *RollingUpdateOptions

func (*RollingUpdateOptions) Complete added in v1.11.1 

func (o *RollingUpdateOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (*RollingUpdateOptions) Run added in v1.11.1 

func (o *RollingUpdateOptions) Run() error

func (*RollingUpdateOptions) Validate added in v1.11.1 

func (o *RollingUpdateOptions) Validate(cmd *cobra.Command, args []string) error

type RunObject added in v1.8.0 

type RunObject struct {
	Object  runtime.Object
	Mapping *meta.RESTMapping
}

type RunOptions added in v1.11.1 

type RunOptions struct {
	PrintFlags    *genericclioptions.PrintFlags
	DeleteFlags   *DeleteFlags
	DeleteOptions *DeleteOptions
	RecordFlags   *genericclioptions.RecordFlags

	DryRun bool

	PrintObj func(runtime.Object) error
	Recorder genericclioptions.Recorder

	DynamicClient dynamic.Interface

	ArgsLenAtDash  int
	Attach         bool
	Expose         bool
	Generator      string
	Image          string
	Interactive    bool
	LeaveStdinOpen bool
	Port           string
	Quiet          bool
	Schedule       string
	TTY            bool

	genericclioptions.IOStreams
}

func NewRunOptions added in v1.11.1 

func NewRunOptions(streams genericclioptions.IOStreams) *RunOptions

func (*RunOptions) Complete added in v1.11.1 

func (o *RunOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error

func (*RunOptions) Run added in v1.11.1 

func (o *RunOptions) Run(f cmdutil.Factory, cmd *cobra.Command, args []string) error

type ScaleOptions added in v1.1.1 

type ScaleOptions struct {
	FilenameOptions resource.FilenameOptions
	RecordFlags     *genericclioptions.RecordFlags
	PrintFlags      *genericclioptions.PrintFlags
	PrintObj        printers.ResourcePrinterFunc

	Selector        string
	All             bool
	Replicas        int
	ResourceVersion string
	CurrentReplicas int
	Timeout         time.Duration

	Recorder genericclioptions.Recorder

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func NewScaleOptions added in v1.11.1 

func NewScaleOptions(ioStreams genericclioptions.IOStreams) *ScaleOptions

func (*ScaleOptions) Complete added in v1.11.1 

func (o *ScaleOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (*ScaleOptions) RunScale added in v1.11.1 

func (o *ScaleOptions) RunScale() error

RunScale executes the scaling

func (*ScaleOptions) Validate added in v1.11.1 

func (o *ScaleOptions) Validate(cmd *cobra.Command) error

type SetLastAppliedOptions added in v1.6.0 

type SetLastAppliedOptions struct {
	CreateAnnotation bool

	PrintFlags *genericclioptions.PrintFlags
	PrintObj   printers.ResourcePrinterFunc

	FilenameOptions resource.FilenameOptions

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func NewSetLastAppliedOptions added in v1.11.1 

func NewSetLastAppliedOptions(ioStreams genericclioptions.IOStreams) *SetLastAppliedOptions

func (*SetLastAppliedOptions) Complete added in v1.6.0 

func (o *SetLastAppliedOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error

func (*SetLastAppliedOptions) RunSetLastApplied added in v1.6.0 

func (o *SetLastAppliedOptions) RunSetLastApplied() error

func (*SetLastAppliedOptions) Validate added in v1.6.0 

func (o *SetLastAppliedOptions) Validate() error

type StreamOptions added in v1.4.2 

type StreamOptions struct {
	Namespace     string
	PodName       string
	ContainerName string
	Stdin         bool
	TTY           bool
	// minimize unnecessary output
	Quiet bool
	// InterruptParent, if set, is used to handle interrupts while attached
	InterruptParent *interrupt.Handler

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

type TaintOptions added in v1.3.0 

type TaintOptions struct {
	PrintFlags *genericclioptions.PrintFlags
	ToPrinter  func(string) (printers.ResourcePrinter, error)

	ClientForMapping func(*meta.RESTMapping) (resource.RESTClient, error)

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

TaintOptions have the data required to perform the taint operation

func (*TaintOptions) Complete added in v1.3.0 

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

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

func (TaintOptions) RunTaint added in v1.3.0 

func (o TaintOptions) RunTaint() error

RunTaint does the work

func (TaintOptions) Validate added in v1.3.0 

func (o TaintOptions) Validate() error

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

type TopNodeOptions added in v1.4.2 

type TopNodeOptions struct {
	ResourceName    string
	Selector        string
	NodeClient      corev1.CoreV1Interface
	HeapsterOptions HeapsterTopOptions
	Client          *metricsutil.HeapsterMetricsClient
	Printer         *metricsutil.TopCmdPrinter
	DiscoveryClient discovery.DiscoveryInterface
	MetricsClient   metricsclientset.Interface

	genericclioptions.IOStreams
}

TopNodeOptions contains all the options for running the top-node cli command.

func (*TopNodeOptions) Complete added in v1.4.2 

func (o *TopNodeOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (TopNodeOptions) RunTopNode added in v1.4.2 

func (o TopNodeOptions) RunTopNode() error

func (*TopNodeOptions) Validate added in v1.4.2 

func (o *TopNodeOptions) Validate() error

type TopPodOptions added in v1.4.2 

type TopPodOptions struct {
	ResourceName    string
	Namespace       string
	Selector        string
	AllNamespaces   bool
	PrintContainers bool
	PodClient       corev1.PodsGetter
	HeapsterOptions HeapsterTopOptions
	Client          *metricsutil.HeapsterMetricsClient
	Printer         *metricsutil.TopCmdPrinter
	DiscoveryClient discovery.DiscoveryInterface
	MetricsClient   metricsclientset.Interface

	genericclioptions.IOStreams
}

func (*TopPodOptions) Complete added in v1.4.2 

func (o *TopPodOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (TopPodOptions) RunTopPod added in v1.4.2 

func (o TopPodOptions) RunTopPod() error

func (*TopPodOptions) Validate added in v1.4.2 

func (o *TopPodOptions) Validate() error

type Version added in v1.7.0 

type Version struct {
	ClientVersion *apimachineryversion.Info `json:"clientVersion,omitempty" yaml:"clientVersion,omitempty"`
	ServerVersion *apimachineryversion.Info `json:"serverVersion,omitempty" yaml:"serverVersion,omitempty"`
}

type VersionOptions added in v1.8.0 

type VersionOptions struct {
	ClientOnly bool
	Short      bool
	Output     string

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func NewVersionOptions added in v1.11.1 

func NewVersionOptions(ioStreams genericclioptions.IOStreams) *VersionOptions

func (*VersionOptions) Complete added in v1.8.0 

func (o *VersionOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error

func (*VersionOptions) Run added in v1.8.0 

func (o *VersionOptions) Run() error

func (*VersionOptions) Validate added in v1.8.0 

func (o *VersionOptions) Validate() error

type ViewLastAppliedOptions added in v1.6.0 

type ViewLastAppliedOptions struct {
	FilenameOptions              resource.FilenameOptions
	Selector                     string
	LastAppliedConfigurationList []string
	OutputFormat                 string
	All                          bool
	Factory                      cmdutil.Factory

	genericclioptions.IOStreams
}

func NewViewLastAppliedOptions added in v1.11.1 

func NewViewLastAppliedOptions(ioStreams genericclioptions.IOStreams) *ViewLastAppliedOptions

func (*ViewLastAppliedOptions) Complete added in v1.6.0 

func (o *ViewLastAppliedOptions) Complete(cmd *cobra.Command, f cmdutil.Factory, args []string) error

func (*ViewLastAppliedOptions) RunApplyViewLastApplied added in v1.6.0 

func (o *ViewLastAppliedOptions) RunApplyViewLastApplied(cmd *cobra.Command) error

func (*ViewLastAppliedOptions) Validate added in v1.6.0 

func (o *ViewLastAppliedOptions) Validate(cmd *cobra.Command) error

Source Files

View all Source files

Directories

Path Synopsis
Package scalejob is deprecated This package contains deprecated functions used to "scale" jobs in a way inconsistent with normal scaling rules
 Package scalejob is deprecated This package contains deprecated functions used to "scale" jobs in a way inconsistent with normal scaling rules
set
env
Package env provides functions to incorporate environment variables into set env.
 Package env provides functions to incorporate environment variables into set env.
editor
editor/crlf
openapi
Package openapi is a collection of libraries for fetching the openapi spec from a Kubernetes server and then indexing the type definitions.
 Package openapi is a collection of libraries for fetching the openapi spec from a Kubernetes server and then indexing the type definitions.
openapi/testing
openapi/validation
sanity

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.