cmd

Documentation

Index

• Constants
• func DefaultClientConfig(flags *pflag.FlagSet) clientcmd.ClientConfig
• func NewCmdNamespace(out io.Writer) *cobra.Command
• func RunGet(f *Factory, out io.Writer, cmd *cobra.Command, args []string)
• type Factory
  • func NewFactory(optionalClientConfig clientcmd.ClientConfig) *Factory
  • func (f *Factory) BindFlags(flags *pflag.FlagSet)
  • func (f *Factory) ClientMapperForCommand(cmd *cobra.Command) resource.ClientMapper
  • func (f *Factory) NewCmdCreate(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdDelete(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdDescribe(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdExec(cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command
  • func (f *Factory) NewCmdExposeService(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdGet(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdLabel(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdLog(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdPortForward() *cobra.Command
  • func (f *Factory) NewCmdProxy(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdResize(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdRollingUpdate(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdRunContainer(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdStop(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdUpdate(out io.Writer) *cobra.Command
  • func (f *Factory) NewCmdVersion(out io.Writer) *cobra.Command
  • func (f *Factory) NewKubectlCommand(in io.Reader, out, err io.Writer) *cobra.Command
  • func (f *Factory) PrintObject(cmd *cobra.Command, obj runtime.Object, out io.Writer) error
  • func (f *Factory) PrinterForMapping(cmd *cobra.Command, mapping *meta.RESTMapping) (kubectl.ResourcePrinter, error)

Constants

const (
	FlagMatchBinaryVersion = "match-server-version"
)

Functions

func DefaultClientConfig

func DefaultClientConfig(flags *pflag.FlagSet) clientcmd.ClientConfig

DefaultClientConfig creates a clientcmd.ClientConfig with the following hierarchy:

1. Use the kubeconfig builder. The number of merges and overrides here gets a little crazy. Stay with me.
1. Merge together the kubeconfig itself. This is done with the following hierarchy and merge rules:
1. CommandLineLocation - this parsed from the command line, so it must be late bound
2. EnvVarLocation
3. CurrentDirectoryLocation
4. HomeDirectoryLocation Empty filenames are ignored. Files with non-deserializable content produced errors. The first file to set a particular value or map key wins and the value or map key is never changed. This means that the first file to set CurrentContext will have its context preserved. It also means that if two files specify a "red-user", only values from the first file's red-user are used. Even non-conflicting entries from the second file's "red-user" are discarded.
2. Determine the context to use based on the first hit in this chain
1. command line argument - again, parsed from the command line, so it must be late bound
2. CurrentContext from the merged kubeconfig file
3. Empty is allowed at this stage
3. Determine the cluster info and auth info to use. At this point, we may or may not have a context. They are built based on the first hit in this chain. (run it twice, once for auth, once for cluster)
1. command line argument
2. If context is present, then use the context value
3. Empty is allowed
4. Determine the actual cluster info to use. At this point, we may or may not have a cluster info. Build each piece of the cluster info based on the chain:
1. command line argument
2. If cluster info is present and a value for the attribute is present, use it.
3. If you don't have a server location, bail.
5. Auth info is build using the same rules as cluster info, EXCEPT that you can only have one authentication technique per auth info. The following conditions result in an error:
1. If there are two conflicting techniques specified from the command line, fail.
2. If the command line does not specify one, and the auth info has conflicting techniques, fail.
3. If the command line specifies one and the auth info specifies another, honor the command line technique.
2. Use default values and potentially prompt for auth information

func NewCmdNamespace

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

TODO remove once people have been given enough time to notice

func RunGet

func RunGet(f *Factory, out io.Writer, cmd *cobra.Command, args []string)

RunGet implements the generic Get command TODO: convert all direct flag accessors to a struct and pass that instead of cmd TODO: return an error instead of using glog.Fatal and checkErr

Types

type Factory

type Factory struct {

	// Returns interfaces for dealing with arbitrary runtime.Objects.
	Object func(cmd *cobra.Command) (meta.RESTMapper, runtime.ObjectTyper)
	// Returns a client for accessing Kubernetes resources or an error.
	Client func(cmd *cobra.Command) (*client.Client, error)
	// Returns a client.Config for accessing the Kubernetes server.
	ClientConfig func(cmd *cobra.Command) (*client.Config, error)
	// Returns a RESTClient for working with the specified RESTMapping or an error. This is intended
	// for working with arbitrary resources and is not guaranteed to point to a Kubernetes APIServer.
	RESTClient func(cmd *cobra.Command, mapping *meta.RESTMapping) (resource.RESTClient, error)
	// Returns a Describer for displaying the specified RESTMapping type or an error.
	Describer func(cmd *cobra.Command, mapping *meta.RESTMapping) (kubectl.Describer, error)
	// Returns a Printer for formatting objects of the given type or an error.
	Printer func(cmd *cobra.Command, mapping *meta.RESTMapping, noHeaders bool) (kubectl.ResourcePrinter, error)
	// Returns a Resizer for changing the size of the specified RESTMapping type or an error
	Resizer func(cmd *cobra.Command, mapping *meta.RESTMapping) (kubectl.Resizer, error)
	// Returns a Reaper for gracefully shutting down resources.
	Reaper func(cmd *cobra.Command, mapping *meta.RESTMapping) (kubectl.Reaper, error)
	// Returns a schema that can validate objects stored on disk.
	Validator func(*cobra.Command) (validation.Schema, error)
	// Returns the default namespace to use in cases where no other namespace is specified
	DefaultNamespace func(cmd *cobra.Command) (string, error)
	// contains filtered or unexported fields
}

Factory provides abstractions that allow the Kubectl command to be extended across multiple types of resources and different API sets. TODO: make the functions interfaces

func NewFactory

func NewFactory(optionalClientConfig clientcmd.ClientConfig) *Factory

NewFactory creates a factory with the default Kubernetes resources defined if optionalClientConfig is nil, then flags will be bound to a new clientcmd.ClientConfig. if optionalClientConfig is not nil, then this factory will make use of it.

func (*Factory) BindFlags

func (f *Factory) BindFlags(flags *pflag.FlagSet)

BindFlags adds any flags that are common to all kubectl sub commands.

func (*Factory) ClientMapperForCommand

func (f *Factory) ClientMapperForCommand(cmd *cobra.Command) resource.ClientMapper

ClientMapperForCommand returns a ClientMapper for the given command and factory.

func (*Factory) NewCmdCreate

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

func (*Factory) NewCmdDelete

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

func (*Factory) NewCmdDescribe

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

func (*Factory) NewCmdExec

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

func (*Factory) NewCmdExposeService

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

func (*Factory) NewCmdGet

func (f *Factory) NewCmdGet(out io.Writer) *cobra.Command

NewCmdGet creates a command object for the generic "get" action, which retrieves one or more resources from a server.

func (*Factory) NewCmdLabel

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

func (*Factory) NewCmdLog

func (f *Factory) NewCmdLog(out io.Writer) *cobra.Command

func (*Factory) NewCmdPortForward

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

func (*Factory) NewCmdProxy

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

func (*Factory) NewCmdResize

func (f *Factory) NewCmdResize(out io.Writer) *cobra.Command

func (*Factory) NewCmdRollingUpdate

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

func (*Factory) NewCmdRunContainer

func (f *Factory) NewCmdRunContainer(out io.Writer) *cobra.Command

func (*Factory) NewCmdStop

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

func (*Factory) NewCmdUpdate

func (f *Factory) NewCmdUpdate(out io.Writer) *cobra.Command

func (*Factory) NewCmdVersion

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

func (*Factory) NewKubectlCommand

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

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

func (*Factory) PrintObject

func (f *Factory) PrintObject(cmd *cobra.Command, obj runtime.Object, out io.Writer) error

PrintObject prints an api object given command line flags to modify the output format

func (*Factory) PrinterForMapping

func (f *Factory) PrinterForMapping(cmd *cobra.Command, mapping *meta.RESTMapping) (kubectl.ResourcePrinter, error)

PrinterForMapping returns a printer suitable for displaying the provided resource type. Requires that printer flags have been added to cmd (see AddPrinterFlags).