cmd

package
v0.14.0 Latest Latest
Warning

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

 Go to latest Published: Mar 30, 2015 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

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

Variables

This section is empty.

Functions

func DefaultClientConfig added in v0.9.0 

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.
  2. Merge together the kubeconfig itself. This is done with the following hierarchy and merge rules:
  3. CommandLineLocation - this parsed from the command line, so it must be late bound
  4. EnvVarLocation
  5. CurrentDirectoryLocation
  6. 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.
  7. Determine the context to use based on the first hit in this chain
  8. command line argument - again, parsed from the command line, so it must be late bound
  9. CurrentContext from the merged kubeconfig file
  10. Empty is allowed at this stage
  11. 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)
  12. command line argument
  13. If context is present, then use the context value
  14. Empty is allowed
  15. 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:
  16. command line argument
  17. If cluster info is present and a value for the attribute is present, use it.
  18. If you don't have a server location, bail.
  19. 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:
  20. If there are two conflicting techniques specified from the command line, fail.
  21. If the command line does not specify one, and the auth info has conflicting techniques, fail.
  22. If the command line specifies one and the auth info specifies another, honor the command line technique.
  23. 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 RunApiVersions added in v0.14.0 

func RunApiVersions(f *Factory, out io.Writer) error

func RunClusterInfo added in v0.13.0 

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

func RunCreate added in v0.13.0 

func RunCreate(f *Factory, out io.Writer, cmd *cobra.Command, filenames util.StringList) error

func RunDelete added in v0.13.0 

func RunDelete(f *Factory, out io.Writer, cmd *cobra.Command, args []string, filenames util.StringList) error

func RunDescribe added in v0.13.0 

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

func RunExec added in v0.13.0 

func RunExec(f *Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer, cmd *cobra.Command, args []string) error

func RunExpose added in v0.13.0 

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

func RunGet added in v0.9.0 

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

RunGet implements the generic Get command TODO: convert all direct flag accessors to a struct and pass that instead of cmd

func RunLabel added in v0.13.0 

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

func RunLog added in v0.13.0 

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

func RunPortForward added in v0.13.0 

func RunPortForward(f *Factory, cmd *cobra.Command, args []string) error

func RunProxy added in v0.13.0 

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

func RunResize added in v0.13.0 

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

func RunRollingUpdate added in v0.13.0 

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

func RunRunContainer added in v0.13.0 

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

func RunUpdate added in v0.13.0 

func RunUpdate(f *Factory, out io.Writer, cmd *cobra.Command, args []string, filenames util.StringList) error

func RunVersion added in v0.13.0 

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

func ValidateArgs added in v0.14.0 

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

Types

type Factory 

type Factory struct {

	// Returns interfaces for dealing with arbitrary runtime.Objects.
	Object func() (meta.RESTMapper, runtime.ObjectTyper)
	// Returns a client for accessing Kubernetes resources or an error.
	Client func() (*client.Client, error)
	// Returns a client.Config for accessing the Kubernetes server.
	ClientConfig func() (*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(mapping *meta.RESTMapping) (resource.RESTClient, error)
	// Returns a Describer for displaying the specified RESTMapping type or an error.
	Describer func(mapping *meta.RESTMapping) (kubectl.Describer, error)
	// Returns a Printer for formatting objects of the given type or an error.
	Printer func(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(mapping *meta.RESTMapping) (kubectl.Resizer, error)
	// Returns a Reaper for gracefully shutting down resources.
	Reaper func(mapping *meta.RESTMapping) (kubectl.Reaper, error)
	// PodSelectorForResource returns the pod selector associated with the provided resource name
	// or an error.
	PodSelectorForResource func(mapping *meta.RESTMapping, namespace, name string) (string, error)
	// Returns a schema that can validate objects stored on disk.
	Validator func() (validation.Schema, error)
	// Returns the default namespace to use in cases where no other namespace is specified
	DefaultNamespace func() (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 TODO: pass the various interfaces on the factory directly into the command constructors (so the commands are decoupled from the factory).

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

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

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

func (*Factory) ClientMapperForCommand added in v0.11.0 

func (f *Factory) ClientMapperForCommand() resource.ClientMapper

ClientMapperForCommand returns a ClientMapper for the factory.

func (*Factory) NewCmdApiVersions added in v0.14.0 

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

func (*Factory) NewCmdClusterInfo added in v0.13.0 

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

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 added in v0.12.0 

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

func (*Factory) NewCmdExposeService added in v0.11.0 

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 added in v0.11.0 

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

func (*Factory) NewCmdLog added in v0.6.0 

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

func (*Factory) NewCmdPortForward added in v0.12.0 

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

func (*Factory) NewCmdProxy added in v0.6.0 

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

func (*Factory) NewCmdResize added in v0.9.0 

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

func (*Factory) NewCmdRollingUpdate added in v0.9.0 

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

func (*Factory) NewCmdRunContainer added in v0.9.0 

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

func (*Factory) NewCmdStop added in v0.9.1 

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

func (*Factory) NewCmdUpdate 

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

func (*Factory) NewCmdVersion added in v0.6.0 

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

func (*Factory) NewKubectlCommand added in v0.9.0 

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 added in v0.11.0 

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 added in v0.11.0 

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

Source Files

View all Source files

Directories

Path Synopsis

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.