util

Documentation

Index

• Constants
• func AddPrinterFlags(cmd *cobra.Command)
• func CheckErr(err error)
• func DefaultClientConfig(flags *pflag.FlagSet) clientcmd.ClientConfig
• func GetFlagBool(cmd *cobra.Command, flag string) bool
• func GetFlagDuration(cmd *cobra.Command, flag string) time.Duration
• func GetFlagInt(cmd *cobra.Command, flag string) int
• func GetFlagString(cmd *cobra.Command, flag string) string
• func Merge(dst runtime.Object, fragment, kind string) (runtime.Object, error)
• func MultilineError(prefix string, err error) string
• func MultipleErrors(prefix string, errs []error) string
• func OutputVersion(cmd *cobra.Command, defaultVersion string) string
• func PrinterForCommand(cmd *cobra.Command) (kubectl.ResourcePrinter, bool, error)
• func ReadConfigData(location string) ([]byte, error)
• func ReadConfigDataFromLocation(location string) ([]byte, error)
• func ReadConfigDataFromReader(reader io.Reader, source string) ([]byte, error)
• func StandardErrorMessage(err error) (string, bool)
• func UsageError(cmd *cobra.Command, format string, args ...interface{}) error
• type Factory
  • func NewFactory(optionalClientConfig clientcmd.ClientConfig) *Factory
  • func (f *Factory) BindFlags(flags *pflag.FlagSet)
  • func (f *Factory) ClientMapperForCommand() resource.ClientMapper
  • 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 AddPrinterFlags

func AddPrinterFlags(cmd *cobra.Command)

func CheckErr

func CheckErr(err error)

CheckErr prints a user friendly error to STDERR and exits with a non-zero exit code. Unrecognized errors will be printed with an "error: " prefix.

This method is generic to the command in use and may be used by non-Kubectl commands.

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 rules:
1. CommandLineLocation - this parsed from the command line, so it must be late bound. If you specify this, then no other kubeconfig files are merged. This file must exist.
2. If $KUBECONFIG is set, then it is treated as a list of files that should be merged.
3. 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 GetFlagBool

func GetFlagBool(cmd *cobra.Command, flag string) bool

func GetFlagDuration

func GetFlagDuration(cmd *cobra.Command, flag string) time.Duration

func GetFlagInt

func GetFlagInt(cmd *cobra.Command, flag string) int

Assumes the flag has a default value.

func GetFlagString

func GetFlagString(cmd *cobra.Command, flag string) string

func Merge

func Merge(dst runtime.Object, fragment, kind string) (runtime.Object, error)

func MultilineError

func MultilineError(prefix string, err error) string

MultilineError returns a string representing an error that splits sub errors into their own lines. The returned string will end with a newline.

func MultipleErrors

func MultipleErrors(prefix string, errs []error) string

MultipleErrors returns a newline delimited string containing the prefix and referenced errors in standard form.

func OutputVersion

func OutputVersion(cmd *cobra.Command, defaultVersion string) string

OutputVersion returns the preferred output version for generic content (JSON, YAML, or templates)

func PrinterForCommand

func PrinterForCommand(cmd *cobra.Command) (kubectl.ResourcePrinter, bool, error)

PrinterForCommand returns the default printer for this command. Requires that printer flags have been added to cmd (see AddPrinterFlags).

func ReadConfigData

func ReadConfigData(location string) ([]byte, error)

ReadConfigData reads the bytes from the specified filesytem or network location or from stdin if location == "-". TODO: replace with resource.Builder

func ReadConfigDataFromLocation

func ReadConfigDataFromLocation(location string) ([]byte, error)

TODO: replace with resource.Builder

func ReadConfigDataFromReader

func ReadConfigDataFromReader(reader io.Reader, source string) ([]byte, error)

func StandardErrorMessage

func StandardErrorMessage(err error) (string, bool)

StandardErrorMessage translates common errors into a human readable message, or returns false if the error is not one of the recognized types. It may also log extended information to glog.

This method is generic to the command in use and may be used by non-Kubectl commands.

func UsageError

func UsageError(cmd *cobra.Command, format string, args ...interface{}) 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)
	// PodSelectorForObject returns the pod selector associated with the provided object
	PodSelectorForObject func(object runtime.Object) (string, error)
	// PortsForObject returns the ports associated with the provided object
	PortsForObject func(object runtime.Object) ([]string, error)
	// LabelsForObject returns the labels associated with the provided object
	LabelsForObject func(object runtime.Object) (map[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)
	// Returns the generator for the provided generator name
	Generator func(name string) (kubectl.Generator, bool)
	// 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

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() resource.ClientMapper

ClientMapperForCommand returns a ClientMapper for the factory.

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