cmd

package
v1.11.0-alpha.1 Latest Latest
Warning

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

 Go to latest Published: Apr 19, 2018 License: Apache-2.0 Imports: 109 Imported by: 0

Documentation

Overview

Example (PrintServiceWithLabels) 
tf := cmdtesting.NewTestFactory()
defer tf.Cleanup()

ns := legacyscheme.Codecs

tf.Client = &fake.RESTClient{
	NegotiatedSerializer: ns,
	Client:               nil,
}
cmd := resource.NewCmdGet(tf, os.Stdout, os.Stderr)
svc := &api.ServiceList{
	Items: []api.Service{
		{
			ObjectMeta: metav1.ObjectMeta{
				Name:              "svc1",
				Namespace:         "ns1",
				CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)},
				Labels: map[string]string{
					"l1": "value",
				},
			},
			Spec: api.ServiceSpec{
				Ports: []api.ServicePort{
					{Protocol: "UDP", Port: 53},
					{Protocol: "TCP", Port: 53},
				},
				Selector: map[string]string{
					"s": "magic",
				},
				ClusterIP: "10.1.1.1",
				Type:      api.ServiceTypeClusterIP,
			},
			Status: api.ServiceStatus{},
		},
		{
			ObjectMeta: metav1.ObjectMeta{
				Name:              "svc2",
				Namespace:         "ns2",
				CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)},
				Labels: map[string]string{
					"l1": "dolla-bill-yall",
				},
			},
			Spec: api.ServiceSpec{
				Ports: []api.ServicePort{
					{Protocol: "TCP", Port: 80},
					{Protocol: "TCP", Port: 8080},
				},
				Selector: map[string]string{
					"s": "kazam",
				},
				ClusterIP: "10.1.1.2",
				Type:      api.ServiceTypeClusterIP,
			},
			Status: api.ServiceStatus{},
		}},
}
ld := strings.NewLineDelimiter(os.Stdout, "|")
defer ld.Flush()
cmd.Flags().Set("label-columns", "l1")
err := cmdutil.PrintObject(cmd, svc, ld)
if err != nil {
	fmt.Printf("Unexpected error: %v", err)
}

Output:

|NAME      TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)           AGE       L1|
|svc1      ClusterIP   10.1.1.1     <none>        53/UDP,53/TCP     10y       value|
|svc2      ClusterIP   10.1.1.2     <none>        80/TCP,8080/TCP   10y       dolla-bill-yall|
||

Index

Examples

Constants

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

Variables

This section is empty.

Functions

func DescribeMatchingResources added in v0.17.0 

func DescribeMatchingResources(f cmdutil.Factory, namespace, rsrc, prefix string, describerSettings *printers.DescriberSettings, out io.Writer, originalError error) error

func NewCmdAlpha added in v1.8.0 

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

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

func NewCmdAnnotate added in v1.1.0 

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

func NewCmdApiResources added in v1.11.0 

func NewCmdApiResources(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(baseName string, f cmdutil.Factory, out, errOut io.Writer) *cobra.Command

func NewCmdApplyEditLastApplied added in v1.7.0 

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

func NewCmdApplySetLastApplied added in v1.6.0 

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

func NewCmdApplyViewLastApplied added in v1.6.0 

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

func NewCmdAttach added in v1.1.0 

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 NewCmdCertificate added in v1.5.0 

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

func NewCmdCertificateApprove added in v1.5.0 

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

func NewCmdCertificateDeny added in v1.5.0 

func NewCmdCertificateDeny(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 NewCmdClusterInfoDump added in v1.3.0 

func NewCmdClusterInfoDump(f cmdutil.Factory, cmdOut io.Writer) *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, 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 NewCmdCp added in v1.5.0 

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

NewCmdCp creates a new Copy command.

func NewCmdDelete added in v0.15.0 

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

func NewCmdDescribe added in v0.15.0 

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

func NewCmdDiff added in v1.9.0 

func NewCmdDiff(f cmdutil.Factory, stdout, stderr io.Writer) *cobra.Command

func NewCmdDrain added in v1.2.0 

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

func NewCmdEdit added in v1.1.0 

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, cmdErr 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 NewCmdForPlugin added in v1.7.0 

func NewCmdForPlugin(f cmdutil.Factory, plugin *plugins.Plugin, runner plugins.PluginRunner, in io.Reader, out, errout io.Writer) *cobra.Command

NewCmdForPlugin creates a command capable of running the provided plugin.

func NewCmdHelp added in v1.4.0 

func NewCmdHelp() *cobra.Command

func NewCmdLabel added in v0.15.0 

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

func NewCmdLogs added in v1.2.0 

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

NewCmdLogs creates a new pod logs command

func NewCmdOptions added in v1.4.0 

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

NewCmdOptions implements the options command

func NewCmdPatch added in v0.21.0 

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

func NewCmdPlugin added in v1.7.0 

func NewCmdPlugin(f cmdutil.Factory, in io.Reader, out, err io.Writer) *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, cmdOut, cmdErr io.Writer) *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, errOut 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.0 

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

func NewCmdScale added in v0.18.0 

func NewCmdScale(f cmdutil.Factory, out, errOut io.Writer) *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, out io.Writer) *cobra.Command

func NewCmdTop added in v1.4.0 

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

func NewCmdTopNode added in v1.4.0 

func NewCmdTopNode(f cmdutil.Factory, options *TopNodeOptions, out io.Writer) *cobra.Command

func NewCmdTopPod added in v1.4.0 

func NewCmdTopPod(f cmdutil.Factory, options *TopPodOptions, 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 NewDefaultKubectlCommand added in v1.10.0 

func NewDefaultKubectlCommand() *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 RunApiVersions added in v0.14.0 

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

func RunClusterInfo added in v0.13.0 

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

func RunCompletion added in v1.3.0 

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

func RunDescribe added in v0.13.0 

func RunDescribe(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, args []string, options *resource.FilenameOptions, describerSettings *printers.DescriberSettings) error

func RunDiff added in v1.9.0 

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 RunExplain added in v1.2.0 

func RunExplain(f cmdutil.Factory, out, cmdErr 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 *resource.FilenameOptions) error

func RunHelp added in v1.4.0 

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

func RunPatch added in v0.21.0 

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

func RunProxy added in v0.13.0 

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

func RunRollingUpdate added in v0.13.0 

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

func RunScale added in v0.18.0 

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

RunScale executes the scaling

func ScaleJob added in v1.11.0 

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

func SupportEviction added in v1.5.0 

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

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

	Recorder genericclioptions.Recorder
	// contains filtered or unexported fields
}

AnnotateOptions have the data required to perform the annotate operation

func NewAnnotateOptions added in v1.11.0 

func NewAnnotateOptions(out io.Writer) *AnnotateOptions

func (*AnnotateOptions) Complete added in v1.1.0 

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

func (o AnnotateOptions) RunAnnotate(f cmdutil.Factory, cmd *cobra.Command) error

RunAnnotate does the work

func (AnnotateOptions) Validate added in v1.1.0 

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

type ApiResourcesOptions struct {
	Output     string
	APIGroup   string
	Namespaced bool
	NoHeaders  bool
	// contains filtered or unexported fields
}

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

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

func (*ApiResourcesOptions) RunApiResources added in v1.11.0 

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

func (*ApiResourcesOptions) Validate added in v1.11.0 

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

type ApplyOptions added in v1.1.1 

type ApplyOptions struct {
	RecordFlags     *genericclioptions.RecordFlags
	FilenameOptions resource.FilenameOptions

	Recorder genericclioptions.Recorder

	Selector       string
	Force          bool
	Prune          bool
	Cascade        bool
	GracePeriod    int
	PruneResources []pruneResource
	Timeout        time.Duration

	All            bool
	Overwrite      bool
	OpenApiPatch   bool
	PruneWhitelist []string

	Out    io.Writer
	ErrOut io.Writer
	// contains filtered or unexported fields
}

func NewApplyOptions added in v1.11.0 

func NewApplyOptions(out, errout io.Writer) *ApplyOptions

func (*ApplyOptions) Complete added in v1.11.0 

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

func (*ApplyOptions) Run added in v1.11.0 

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

TODO(juanvallejo): break dependency on factory and cmd

type AttachOptions added in v1.1.0 

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

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

func (p *AttachOptions) Run() error

Run executes a validated remote execution against a pod.

func (*AttachOptions) Validate added in v1.1.0 

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
}

func NewAutoscaleOptions added in v1.11.0 

func NewAutoscaleOptions() *AutoscaleOptions

func (*AutoscaleOptions) Complete added in v1.11.0 

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

func (*AutoscaleOptions) RunAutoscale 

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

type CertificateOptions added in v1.5.0 

type CertificateOptions struct {
	resource.FilenameOptions
	// contains filtered or unexported fields
}

func (*CertificateOptions) Complete added in v1.5.0 

func (options *CertificateOptions) Complete(cmd *cobra.Command, args []string) error

func (*CertificateOptions) RunCertificateApprove added in v1.5.0 

func (options *CertificateOptions) RunCertificateApprove(f cmdutil.Factory, out io.Writer, force bool) error

func (*CertificateOptions) RunCertificateDeny added in v1.5.0 

func (options *CertificateOptions) RunCertificateDeny(f cmdutil.Factory, out io.Writer, force bool) error

func (*CertificateOptions) Validate added in v1.5.0 

func (options *CertificateOptions) Validate() error

type ConvertOptions added in v1.2.0 

type ConvertOptions struct {
	resource.FilenameOptions
	// contains filtered or unexported fields
}

ConvertOptions have the data required to perform the convert operation

func NewConvertOptions added in v1.11.0 

func NewConvertOptions() *ConvertOptions

func (*ConvertOptions) Complete added in v1.2.0 

func (o *ConvertOptions) Complete(f cmdutil.Factory, out io.Writer, 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 DefaultRemoteAttach added in v1.1.0 

type DefaultRemoteAttach struct{}

DefaultRemoteAttach is the standard implementation of attaching

func (*DefaultRemoteAttach) Attach added in v1.1.0 

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

type DefaultRemoteExecutor struct{}

DefaultRemoteExecutor is the standard implementation of remote command execution

func (*DefaultRemoteExecutor) Execute added in v1.1.0 

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

type DeleteFlags struct {
	FileNameFlags *FileNameFlags

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

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

func NewDeleteCommandFlags added in v1.11.0 

func NewDeleteCommandFlags(usage string) *DeleteFlags

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

func NewDeleteFlags added in v1.11.0 

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

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

func (*DeleteFlags) ToOptions added in v1.11.0 

func (f *DeleteFlags) ToOptions(out, errOut io.Writer) *DeleteOptions

type DeleteOptions added in v1.1.0 

type DeleteOptions struct {
	resource.FilenameOptions

	Selector        string
	DeleteAll       bool
	IgnoreNotFound  bool
	Cascade         bool
	DeleteNow       bool
	ForceDeletion   bool
	WaitForDeletion bool

	Reaper func(mapping *meta.RESTMapping) (kubectl.Reaper, error)

	GracePeriod int
	Timeout     time.Duration

	Output string

	Mapper meta.RESTMapper
	Result *resource.Result

	Out    io.Writer
	ErrOut io.Writer
}

func (*DeleteOptions) Complete added in v1.6.0 

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

func (*DeleteOptions) DeleteResult added in v1.11.0 

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

func (*DeleteOptions) PrintObj added in v1.11.0 

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

func (o *DeleteOptions) ReapResult(r *resource.Result, isDefaultDelete, quiet bool) error

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 DiffOptions added in v1.9.0 

type DiffOptions struct {
	FilenameOptions resource.FilenameOptions
}

type DiffProgram added in v1.9.0 

type DiffProgram struct {
	Exec   exec.Interface
	Stdout io.Writer
	Stderr io.Writer
}

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

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

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

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

NewDiffVersion creates a new DiffVersion with the named version.

func (*DiffVersion) Print added in v1.9.0 

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

type Differ struct {
	From *DiffVersion
	To   *DiffVersion
}

Differ creates two DiffVersion and diffs them.

func NewDiffer added in v1.9.0 

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

func (*Differ) Diff added in v1.9.0 

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

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

Run runs the diff program against both directories.

func (*Differ) TearDown added in v1.9.0 

func (d *Differ) TearDown()

TearDown removes both temporary directories recursively.

type Directory added in v1.9.0 

type Directory struct {
	Name string
}

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

func CreateDirectory added in v1.9.0 

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

func (d *Directory) Delete() error

Delete removes the directory recursively.

func (*Directory) NewFile added in v1.9.0 

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

NewFile creates a new file in the directory.

type DrainOptions added in v1.2.0 

type DrainOptions struct {
	Factory            cmdutil.Factory
	Force              bool
	DryRun             bool
	GracePeriodSeconds int
	IgnoreDaemonsets   bool
	Timeout            time.Duration

	DeleteLocalData bool
	Selector        string
	PodSelector     string

	Out    io.Writer
	ErrOut io.Writer
	// contains filtered or unexported fields
}

func NewDrainOptions added in v1.11.0 

func NewDrainOptions(f cmdutil.Factory, out, errOut io.Writer) *DrainOptions

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

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

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

func (p *ExecOptions) Run() error

Run executes a validated remote execution against a pod.

func (*ExecOptions) Validate added in v1.1.0 

func (p *ExecOptions) Validate() error

Validate checks that the provided exec options are specified.

type FileNameFlags 

type FileNameFlags struct {
	Usage string

	Filenames *[]string
	Recursive *bool
}

func (*FileNameFlags) AddFlags 

func (o *FileNameFlags) AddFlags(cmd *cobra.Command)

func (*FileNameFlags) ToOptions 

func (o *FileNameFlags) ToOptions() resource.FilenameOptions

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

type InfoObject struct {
	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.0 

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

func (InfoObject) Live added in v1.9.0 

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

func (InfoObject) Local added in v1.9.0 

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

func (InfoObject) Merged added in v1.9.0 

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

func (InfoObject) Name added in v1.9.0 

func (obj InfoObject) Name() string

type LabelOptions added in v1.1.0 

type LabelOptions struct {
	// Filename options
	resource.FilenameOptions
	// contains filtered or unexported fields
}

LabelOptions have the data required to perform the label operation

func (*LabelOptions) Complete added in v1.5.0 

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

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

func (*LabelOptions) RunLabel added in v1.5.0 

func (o *LabelOptions) RunLabel(f cmdutil.Factory, cmd *cobra.Command) error

RunLabel does the work

func (*LabelOptions) Validate added in v1.5.0 

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

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

	Object        runtime.Object
	GetPodTimeout time.Duration
	LogsForObject func(object, options runtime.Object, timeout time.Duration) (*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() 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.0 

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

type PatchOptions struct {
	resource.FilenameOptions

	Local  bool
	DryRun bool

	OutputFormat 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 PortForwardOptions added in v1.4.0 

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

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

func (o PortForwardOptions) RunPortForward() error

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

func (PortForwardOptions) Validate added in v1.4.0 

func (o PortForwardOptions) Validate() error

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

type Printer added in v1.9.0 

type Printer struct{}

Printer is used to print an object.

func (*Printer) Print added in v1.9.0 

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

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

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 ReplaceOpts 

type ReplaceOpts struct {
	PrintFlags  *printers.PrintFlags
	DeleteFlags *DeleteFlags

	DeleteOptions *DeleteOptions

	PrintObj func(obj runtime.Object) error

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

	ShouldRecord func(info *resource.Info) bool

	Namespace        string
	EnforceNamespace bool

	Out    io.Writer
	ErrOut io.Writer
	// contains filtered or unexported fields
}

func (*ReplaceOpts) Complete 

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

func (*ReplaceOpts) Run 

func (o *ReplaceOpts) Run() error

func (*ReplaceOpts) Validate 

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

type RunObject added in v1.8.0 

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

type RunOptions added in v1.11.0 

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

	DryRun bool

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

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

	In     io.Reader
	Out    io.Writer
	ErrOut io.Writer
}

func NewRunOptions added in v1.11.0 

func NewRunOptions(in io.Reader, out, errOut io.Writer) *RunOptions

func (*RunOptions) Complete added in v1.11.0 

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

func (*RunOptions) Run added in v1.11.0 

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

type SetLastAppliedOptions added in v1.6.0 

type SetLastAppliedOptions struct {
	FilenameOptions  resource.FilenameOptions
	Selector         string
	InfoList         []*resource.Info
	Mapper           meta.RESTMapper
	Typer            runtime.ObjectTyper
	Namespace        string
	EnforceNamespace bool
	DryRun           bool
	ShortOutput      bool
	CreateAnnotation bool
	Output           string
	PatchBufferList  []PatchBuffer
	Factory          cmdutil.Factory

	Out    io.Writer
	ErrOut io.Writer
}

func NewSetLastAppliedOptions added in v1.11.0 

func NewSetLastAppliedOptions(out, errout io.Writer) *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(f cmdutil.Factory, cmd *cobra.Command) error

func (*SetLastAppliedOptions) Validate added in v1.6.0 

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

type StreamOptions added in v1.4.0 

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
	In              io.Reader
	Out             io.Writer
	Err             io.Writer
	// contains filtered or unexported fields
}

type TaintOptions added in v1.3.0 

type TaintOptions struct {
	// 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, out io.Writer, 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.0 

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

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

func (*TopNodeOptions) Complete added in v1.4.0 

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

func (TopNodeOptions) RunTopNode added in v1.4.0 

func (o TopNodeOptions) RunTopNode() error

func (*TopNodeOptions) Validate added in v1.4.0 

func (o *TopNodeOptions) Validate() error

type TopPodOptions added in v1.4.0 

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
}

func (*TopPodOptions) Complete added in v1.4.0 

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

func (TopPodOptions) RunTopPod added in v1.4.0 

func (o TopPodOptions) RunTopPod() error

func (*TopPodOptions) Validate added in v1.4.0 

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 {
	// contains filtered or unexported fields
}

VersionOptions: describe the options available to users of the "kubectl version" command.

func (*VersionOptions) Complete added in v1.8.0 

func (o *VersionOptions) Complete(cmd *cobra.Command) error

func (*VersionOptions) Run added in v1.8.0 

func (o *VersionOptions) Run(f cmdutil.Factory, out io.Writer) 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
	Out                          io.Writer
	ErrOut                       io.Writer
}

func NewViewLastAppliedOptions added in v1.11.0 

func NewViewLastAppliedOptions(out, err io.Writer) *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
editor
env
Package env provides functions to incorporate environment variables into kubectl commands.
 Package env provides functions to incorporate environment variables into kubectl commands.
jsonmerge
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.