Documentation ¶
Overview ¶
Example (PrintMultiContainersReplicationControllerWithWide) ¶
Output: NAME DESIRED CURRENT READY AGE CONTAINER(S) IMAGE(S) SELECTOR foo 1 1 0 10y foo,foo2 someimage,someimage2 foo=bar
Example (PrintPodHideTerminated) ¶
Output: NAME READY STATUS RESTARTS AGE test1 1/2 Pending 6 10y test2 1/2 Running 6 10y test5 1/2 Unknown 6 10y
Example (PrintPodShowAll) ¶
Output: NAME READY STATUS RESTARTS AGE test1 1/2 Pending 6 10y test2 1/2 Running 6 10y test3 1/2 Succeeded 6 10y test4 1/2 Failed 6 10y test5 1/2 Unknown 6 10y
Example (PrintPodWithShowLabels) ¶
Output: NAME READY STATUS RESTARTS AGE LABELS test1 1/2 podPhase 6 10y l1=key,l2=value
Example (PrintPodWithWideFormat) ¶
Output: NAME READY STATUS RESTARTS AGE IP NODE test1 1/2 podPhase 6 10y 10.1.1.3 kubernetes-node-abcd
Example (PrintReplicationController) ¶
Output: NAME DESIRED CURRENT READY AGE foo 1 1 0 10y
Example (PrintReplicationControllerWithNamespace) ¶
Output: NAMESPACE NAME DESIRED CURRENT READY AGE beep foo 1 1 1 10y
Example (PrintServiceWithNamespacesAndLabels) ¶
Output: |NAMESPACE NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE L1| |ns1 svc1 10.1.1.1 <unknown> 53/UDP,53/TCP 10y value| |ns2 svc2 10.1.1.2 <unknown> 80/TCP,8080/TCP 10y dolla-bill-yall| ||
Index ¶
- Constants
- func CreateConfigMap(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateDeployment(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateNamespace(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateQuota(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateSecretDockerRegistry(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateSecretGeneric(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateSecretTLS(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateServiceAccount(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateServiceClusterIP(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateServiceLoadBalancer(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func CreateServiceNodePort(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
- func DeleteResult(r *resource.Result, out io.Writer, ignoreNotFound bool, shortOutput bool, ...) error
- func Deprecated(baseName, to string, parent, cmd *cobra.Command) string
- func DescribeMatchingResources(mapper meta.RESTMapper, typer runtime.ObjectTyper, f cmdutil.Factory, ...) error
- func NameFromCommandArgs(cmd *cobra.Command, args []string) (string, error)
- func NewCmdAnnotate(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdApiVersions(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdApply(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdAttach(f cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command
- func NewCmdAutoscale(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdCertificate(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdCertificateApprove(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdCertificateDeny(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdClusterInfo(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdClusterInfoDump(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCompletion(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdConvert(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdCordon(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdCp(f cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command
- func NewCmdCreate(f cmdutil.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdCreateConfigMap(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateDeployment(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateNamespace(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateQuota(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateSecret(f cmdutil.Factory, cmdOut, errOut io.Writer) *cobra.Command
- func NewCmdCreateSecretDockerRegistry(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateSecretGeneric(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateSecretTLS(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateService(f cmdutil.Factory, cmdOut, errOut io.Writer) *cobra.Command
- func NewCmdCreateServiceAccount(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateServiceClusterIP(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateServiceLoadBalancer(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdCreateServiceNodePort(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
- func NewCmdDelete(f cmdutil.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdDescribe(f cmdutil.Factory, out, cmdErr io.Writer) *cobra.Command
- func NewCmdDrain(f cmdutil.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdEdit(f cmdutil.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdExec(f cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command
- func NewCmdExplain(f cmdutil.Factory, out, cmdErr io.Writer) *cobra.Command
- func NewCmdExposeService(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdGet(f cmdutil.Factory, out io.Writer, errOut io.Writer) *cobra.Command
- func NewCmdHelp(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdLabel(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdLogs(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdOptions(out io.Writer) *cobra.Command
- func NewCmdPatch(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdPortForward(f cmdutil.Factory, cmdOut, cmdErr io.Writer) *cobra.Command
- func NewCmdProxy(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdReplace(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdRollingUpdate(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdRun(f cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command
- func NewCmdScale(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdStop(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdTaint(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdTop(f cmdutil.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdTopNode(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdTopPod(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdUncordon(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdVersion(f cmdutil.Factory, out io.Writer) *cobra.Command
- func NewKubectlCommand(f cmdutil.Factory, in io.Reader, out, err io.Writer) *cobra.Command
- func ReapResult(r *resource.Result, f cmdutil.Factory, out io.Writer, ...) error
- func Run(f cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer, ...) error
- func RunApiVersions(f cmdutil.Factory, w io.Writer) error
- func RunApply(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *ApplyOptions) error
- func RunAutoscale(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunClusterInfo(f cmdutil.Factory, out io.Writer, cmd *cobra.Command) error
- func RunCompletion(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string) error
- func RunCreate(f cmdutil.Factory, cmd *cobra.Command, out, errOut io.Writer, ...) error
- func RunCreateSubcommand(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, ...) error
- func RunDelete(f cmdutil.Factory, out, errOut io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunDescribe(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunEdit(f cmdutil.Factory, out, errOut io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunEditOnCreate(f cmdutil.Factory, out, errOut io.Writer, cmd *cobra.Command, ...) error
- func RunExplain(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, args []string) error
- func RunExpose(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunGet(f cmdutil.Factory, out, errOut io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunHelp(cmd *cobra.Command, args []string)
- func RunPatch(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunProxy(f cmdutil.Factory, out io.Writer, cmd *cobra.Command) error
- func RunReplace(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunRollingUpdate(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunScale(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, ...) error
- func RunStop(f cmdutil.Factory, cmd *cobra.Command, args []string, out io.Writer, ...) error
- func RunVersion(f cmdutil.Factory, out io.Writer, cmd *cobra.Command) error
- func SupportEviction(clientset *internalclientset.Clientset) (string, error)
- func ValidateArgs(cmd *cobra.Command, args []string) error
- type AnnotateOptions
- type ApplyOptions
- type AttachOptions
- type CertificateOptions
- func (options *CertificateOptions) Complete(cmd *cobra.Command, args []string) error
- func (options *CertificateOptions) RunCertificateApprove(f cmdutil.Factory, out io.Writer) error
- func (options *CertificateOptions) RunCertificateDeny(f cmdutil.Factory, out io.Writer) error
- func (options *CertificateOptions) Validate() error
- type ConvertOptions
- type CreateSubcommandOptions
- type DefaultRemoteAttach
- type DefaultRemoteExecutor
- type DrainOptions
- type EditMode
- type ExecOptions
- type GetOptions
- type LabelOptions
- type LogsOptions
- type PatchOptions
- type PortForwardOptions
- type RemoteAttach
- type RemoteExecutor
- type StreamOptions
- type TaintOptions
- type TopNodeOptions
- type TopOptions
- type TopPodOptions
Examples ¶
- Package (PrintMultiContainersReplicationControllerWithWide)
- Package (PrintPodHideTerminated)
- Package (PrintPodShowAll)
- Package (PrintPodWithShowLabels)
- Package (PrintPodWithWideFormat)
- Package (PrintReplicationController)
- Package (PrintReplicationControllerWithNamespace)
- Package (PrintServiceWithNamespacesAndLabels)
Constants ¶
const ( EvictionKind = "Eviction" EvictionSubresource = "pods/eviction" )
Variables ¶
This section is empty.
Functions ¶
func CreateConfigMap ¶ added in v1.2.0
CreateConfigMap is the implementation of the create configmap command.
func CreateDeployment ¶ added in v1.4.0
CreateDeployment implements the behavior to run the create deployment command
func CreateNamespace ¶ added in v1.2.0
CreateNamespace implements the behavior to run the create namespace command
func CreateQuota ¶ added in v1.4.0
CreateQuota implements the behavior to run the create quota command
func CreateSecretDockerRegistry ¶ added in v1.2.0
func CreateSecretDockerRegistry(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
CreateSecretDockerRegistry is the implementation of the create secret docker-registry command
func CreateSecretGeneric ¶ added in v1.2.0
func CreateSecretGeneric(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
CreateSecretGeneric is the implementation of the create secret generic command
func CreateSecretTLS ¶ added in v1.3.0
CreateSecretTLS is the implementation of the create secret tls command
func CreateServiceAccount ¶ added in v1.2.0
func CreateServiceAccount(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
CreateServiceAccount implements the behavior to run the create service account command
func CreateServiceClusterIP ¶ added in v1.4.0
func CreateServiceClusterIP(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
CreateServiceClusterIP implements the behavior to run the create service clusterIP command
func CreateServiceLoadBalancer ¶ added in v1.4.0
func CreateServiceLoadBalancer(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
CreateServiceLoadBalancer is the implementation of the service loadbalancer command
func CreateServiceNodePort ¶ added in v1.4.0
func CreateServiceNodePort(f cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args []string) error
CreateServiceNodePort is the implementation of the create service nodeport command
func DeleteResult ¶ added in v0.16.0
func Deprecated ¶ added in v1.4.0
func DescribeMatchingResources ¶ added in v0.17.0
func DescribeMatchingResources(mapper meta.RESTMapper, typer runtime.ObjectTyper, f cmdutil.Factory, namespace, rsrc, prefix string, describerSettings *kubectl.DescriberSettings, out io.Writer, originalError error) error
func NameFromCommandArgs ¶ added in v1.2.0
NameFromCommandArgs is a utility function for commands that assume the first argument is a resource name
func NewCmdAnnotate ¶ added in v1.1.0
func NewCmdApiVersions ¶ added in v0.15.0
func NewCmdApply ¶ added in v1.1.1
func NewCmdAttach ¶ added in v1.1.0
func NewCmdAutoscale ¶ added in v1.1.1
func NewCmdCertificate ¶ added in v1.5.0
func NewCmdCertificateApprove ¶ added in v1.5.0
func NewCmdCertificateDeny ¶ added in v1.5.0
func NewCmdClusterInfo ¶ added in v0.15.0
func NewCmdClusterInfoDump ¶ added in v1.3.0
NewCmdCreateSecret groups subcommands to create various types of secrets
func NewCmdCompletion ¶ added in v1.3.0
func NewCmdConvert ¶ added in v1.2.0
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 NewCmdCreate ¶ added in v0.15.0
func NewCmdCreateConfigMap ¶ added in v1.2.0
ConfigMap is a command to ease creating ConfigMaps.
func NewCmdCreateDeployment ¶ added in v1.4.0
NewCmdCreateDeployment is a macro command to create a new deployment
func NewCmdCreateNamespace ¶ added in v1.2.0
NewCmdCreateNamespace is a macro command to create a new namespace
func NewCmdCreateQuota ¶ added in v1.4.0
NewCmdCreateQuota is a macro command to create a new quota
func NewCmdCreateSecret ¶ added in v1.2.0
NewCmdCreateSecret groups subcommands to create various types of secrets
func NewCmdCreateSecretDockerRegistry ¶ added in v1.2.0
NewCmdCreateSecretDockerRegistry is a macro command for creating secrets to work with Docker registries
func NewCmdCreateSecretGeneric ¶ added in v1.2.0
NewCmdCreateSecretGeneric is a command to create generic secrets from files, directories, or literal values
func NewCmdCreateSecretTLS ¶ added in v1.3.0
NewCmdCreateSecretTLS is a macro command for creating secrets to work with Docker registries
func NewCmdCreateService ¶ added in v1.4.0
NewCmdCreateService is a macro command to create a new service
func NewCmdCreateServiceAccount ¶ added in v1.2.0
NewCmdCreateServiceAccount is a macro command to create a new service account
func NewCmdCreateServiceClusterIP ¶ added in v1.4.0
NewCmdCreateServiceClusterIP is a command to create a clusterIP service
func NewCmdCreateServiceLoadBalancer ¶ added in v1.4.0
NewCmdCreateServiceLoadBalancer is a macro command for creating a LoadBalancer service
func NewCmdCreateServiceNodePort ¶ added in v1.4.0
NewCmdCreateServiceNodePort is a macro command for creating a NodePort service
func NewCmdDelete ¶ added in v0.15.0
func NewCmdDescribe ¶ added in v0.15.0
func NewCmdDrain ¶ added in v1.2.0
func NewCmdEdit ¶ added in v1.1.0
func NewCmdExec ¶ added in v0.15.0
func NewCmdExplain ¶ added in v1.2.0
NewCmdExplain returns a cobra command for swagger docs
func NewCmdExposeService ¶ added in v0.15.0
func NewCmdGet ¶ added in v0.15.0
NewCmdGet creates a command object for the generic "get" action, which retrieves one or more resources from a server.
func NewCmdLabel ¶ added in v0.15.0
func NewCmdLogs ¶ added in v1.2.0
NewCmdLog creates a new pod logs command
func NewCmdOptions ¶ added in v1.4.0
NewCmdOptions implements the options command
func NewCmdPatch ¶ added in v0.21.0
func NewCmdPortForward ¶ added in v0.15.0
func NewCmdReplace ¶ added in v0.21.0
func NewCmdRollingUpdate ¶ added in v0.15.0
func NewCmdScale ¶ added in v0.18.0
NewCmdScale returns a cobra command with the appropriate configuration and flags to run scale
func NewCmdTaint ¶ added in v1.3.0
func NewCmdTopNode ¶ added in v1.4.0
func NewCmdTopPod ¶ added in v1.4.0
func NewCmdUncordon ¶ added in v1.2.0
func NewKubectlCommand ¶ added in v0.15.0
NewKubectlCommand creates the `kubectl` command and its nested children.
func ReapResult ¶ added in v0.16.0
func RunAutoscale ¶ added in v1.1.1
func RunClusterInfo ¶ added in v0.13.0
func RunCompletion ¶ added in v1.3.0
func RunCreateSubcommand ¶ added in v1.2.0
func RunCreateSubcommand(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *CreateSubcommandOptions) error
RunCreateSubcommand executes a create subcommand using the specified options
func RunDescribe ¶ added in v0.13.0
func RunEditOnCreate ¶ added in v1.5.0
func RunExplain ¶ added in v1.2.0
RunExplain executes the appropriate steps to print a model's documentation
func RunGet ¶ added in v0.9.0
func RunGet(f cmdutil.Factory, out, errOut 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 RunReplace ¶ added in v0.21.0
func RunRollingUpdate ¶ added in v0.13.0
func RunScale ¶ added in v0.18.0
func RunScale(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string, shortOutput bool, options *resource.FilenameOptions) error
RunScale executes the scaling
func RunVersion ¶ added in v0.13.0
func SupportEviction ¶ added in v1.5.0
func SupportEviction(clientset *internalclientset.Clientset) (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 ""
Types ¶
type AnnotateOptions ¶ added in v1.1.0
type AnnotateOptions struct { // Filename options resource.FilenameOptions // contains filtered or unexported fields }
AnnotateOptions have the data required to perform the annotate operation
func (*AnnotateOptions) Complete ¶ added in v1.1.0
func (o *AnnotateOptions) Complete(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string) (err error)
Complete adapts from the command line args and factory to the data required.
func (AnnotateOptions) RunAnnotate ¶ added in v1.1.0
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 ApplyOptions ¶ added in v1.1.1
type AttachOptions ¶ added in v1.1.0
type AttachOptions struct { StreamOptions CommandName string Pod *api.Pod Attach RemoteAttach PodClient coreclient.PodsGetter Config *restclient.Config }
AttachOptions declare the arguments accepted by the Exec command
func (*AttachOptions) Complete ¶ added in v1.1.0
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 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 (*CertificateOptions) RunCertificateDeny ¶ added in v1.5.0
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 (*ConvertOptions) Complete ¶ added in v1.2.0
func (o *ConvertOptions) Complete(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string) (err error)
Complete collects information required to run Convert command from command line.
func (*ConvertOptions) RunConvert ¶ added in v1.2.0
func (o *ConvertOptions) RunConvert() error
RunConvert implements the generic Convert command
type CreateSubcommandOptions ¶ added in v1.2.0
type CreateSubcommandOptions struct { // Name of resource being created Name string // StructuredGenerator is the resource generator for the object being created StructuredGenerator kubectl.StructuredGenerator // DryRun is true if the command should be simulated but not run against the server DryRun bool // OutputFormat OutputFormat string }
CreateSubcommandOptions is an options struct to support create subcommands
type DefaultRemoteAttach ¶ added in v1.1.0
type DefaultRemoteAttach struct{}
DefaultRemoteAttach is the standard implementation of attaching
type DefaultRemoteExecutor ¶ added in v1.1.0
type DefaultRemoteExecutor struct{}
DefaultRemoteExecutor is the standard implementation of remote command execution
type DrainOptions ¶ added in v1.2.0
type DrainOptions struct { Force bool GracePeriodSeconds int IgnoreDaemonsets bool Timeout time.Duration DeleteLocalData bool // contains filtered or unexported fields }
func (*DrainOptions) RunCordonOrUncordon ¶ added in v1.2.0
func (o *DrainOptions) RunCordonOrUncordon(desired bool) error
RunCordonOrUncordon runs either Cordon or Uncordon. The desired value for "Unschedulable" is passed as the first arg.
func (*DrainOptions) RunDrain ¶ added in v1.2.0
func (o *DrainOptions) RunDrain() error
RunDrain runs the 'drain' command
func (*DrainOptions) SetupDrain ¶ added in v1.2.0
func (o *DrainOptions) SetupDrain(cmd *cobra.Command, args []string) error
SetupDrain populates some fields from the factory, grabs command line arguments and looks up the node using Builder
type ExecOptions ¶ added in v1.1.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 GetOptions ¶ added in v1.1.0
type GetOptions struct { resource.FilenameOptions Raw string }
GetOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()
type LabelOptions ¶ added in v1.1.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(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 (*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 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) RunLogs ¶ added in v1.2.0
func (o LogsOptions) RunLogs() (int64, error)
RunLogs retrieves a pod log
func (LogsOptions) Validate ¶ added in v1.2.0
func (o LogsOptions) Validate() error
type PatchOptions ¶ added in v1.1.0
type PatchOptions struct { resource.FilenameOptions Local 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, cmdOut io.Writer, cmdErr io.Writer) 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 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 term.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 term.TerminalSizeQueue) error
}
RemoteExecutor defines the interface accepted by the Exec command - provided for test stubbing
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(args []string) 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 coreclient.NodesGetter Client *metricsutil.HeapsterMetricsClient Printer *metricsutil.TopCmdPrinter }
TopNodeOptions contains all the options for running the top-node cli command.
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 TopOptions ¶ added in v1.4.0
type TopOptions struct{}
TopOptions contains all the options for running the top cli command.
type TopPodOptions ¶ added in v1.4.0
type TopPodOptions struct { ResourceName string Namespace string Selector string AllNamespaces bool PrintContainers bool PodClient coreclient.PodsGetter Client *metricsutil.HeapsterMetricsClient Printer *metricsutil.TopCmdPrinter }
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
Source Files ¶
- annotate.go
- apiversions.go
- apply.go
- attach.go
- autoscale.go
- certificates.go
- clusterinfo.go
- clusterinfo_dump.go
- cmd.go
- completion.go
- convert.go
- cp.go
- create.go
- create_configmap.go
- create_deployment.go
- create_namespace.go
- create_quota.go
- create_secret.go
- create_service.go
- create_serviceaccount.go
- delete.go
- describe.go
- drain.go
- edit.go
- exec.go
- explain.go
- expose.go
- get.go
- help.go
- label.go
- logs.go
- options.go
- patch.go
- portforward.go
- proxy.go
- replace.go
- rollingupdate.go
- run.go
- scale.go
- stop.go
- taint.go
- top.go
- top_node.go
- top_pod.go
- version.go