...

Package cmd

import "k8s.io/kubectl/pkg/cmd"
Overview
Index
Subdirectories

Overview ▾

func Command

func Command(name string, arg ...string) *exec.Cmd

func HandlePluginCommand

func HandlePluginCommand(pluginHandler PluginHandler, cmdArgs []string, exactMatch bool) error

HandlePluginCommand receives a pluginHandler and command-line arguments and attempts to find a plugin executable on the PATH that satisfies the given arguments.

func IsSubcommandPluginAllowed

func IsSubcommandPluginAllowed(foundCmd string) bool

IsSubcommandPluginAllowed returns the given command is allowed to use plugin as subcommand if the subcommand does not exist as builtin.

func NewCmdAlpha

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

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

func NewDefaultKubectlCommand

func NewDefaultKubectlCommand() *cobra.Command

NewDefaultKubectlCommand creates the `kubectl` command with default arguments

func NewDefaultKubectlCommandWithArgs

func NewDefaultKubectlCommandWithArgs(o KubectlOptions) *cobra.Command

NewDefaultKubectlCommandWithArgs creates the `kubectl` command with arguments

func NewKubectlCommand

func NewKubectlCommand(o KubectlOptions) *cobra.Command

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

type DefaultPluginHandler

DefaultPluginHandler implements PluginHandler

type DefaultPluginHandler struct {
    ValidPrefixes []string
}

func NewDefaultPluginHandler

func NewDefaultPluginHandler(validPrefixes []string) *DefaultPluginHandler

NewDefaultPluginHandler instantiates the DefaultPluginHandler with a list of given filename prefixes used to identify valid plugin filenames.

func (*DefaultPluginHandler) Execute

func (h *DefaultPluginHandler) Execute(executablePath string, cmdArgs, environment []string) error

Execute implements PluginHandler

func (*DefaultPluginHandler) Lookup

func (h *DefaultPluginHandler) Lookup(filename string) (string, bool)

Lookup implements PluginHandler

type KubectlOptions

type KubectlOptions struct {
    PluginHandler PluginHandler
    Arguments     []string
    ConfigFlags   *genericclioptions.ConfigFlags

    genericiooptions.IOStreams
}

type PluginHandler

PluginHandler is capable of parsing command line arguments and performing executable filename lookups to search for valid plugin files, and execute found plugins.

type PluginHandler interface {
    // exists at the given filename, or a boolean false.
    // Lookup will iterate over a list of given prefixes
    // in order to recognize valid plugin filenames.
    // The first filepath to match a prefix is returned.
    Lookup(filename string) (string, bool)
    // Execute receives an executable's filepath, a slice
    // of arguments, and a slice of environment variables
    // to relay to the executable.
    Execute(executablePath string, cmdArgs, environment []string) error
}

Subdirectories

Name Synopsis
..
annotate
apiresources
apply
attach
auth
autoscale
certificates
clusterinfo
completion
config
cp
create
debug
delete
describe
diff
drain
edit
events
exec
explain
expose
get
help
kustomize
label
logs
options
patch
plugin
portforward
proxy
replace
rollout
run
scale
set
env Package env provides functions to incorporate environment variables into set env.
taint Package taints implements utilites for working with taints
testing
top
util
editor
crlf
podcmd
sanity
version
wait