Documentation
¶
Index ¶
- Constants
- func AddPrinterFlags(cmd *cobra.Command)
- func CheckCustomErr(customPrefix string, err error)
- 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 GetFlagStringList(cmd *cobra.Command, flag string) util.StringList
- 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 NewClientCache(loader clientcmd.ClientConfig) *clientCache
- 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 (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, withNamespace bool) (kubectl.ResourcePrinter, error)
Constants ¶
const (
FlagMatchBinaryVersion = "match-server-version"
)
Variables ¶
This section is empty.
Functions ¶
func AddPrinterFlags ¶
AddPrinterFlags adds printing related flags to a command (e.g. output format, no headers, template path)
func CheckCustomErr ¶
CheckCustomErr is like CheckErr except a custom prefix error string may be provied to help produce more specific error messages. For example, for the update failed case this function could be called with:
cmdutil.CheckCustomErr("Update failed", err)
This function supresses the detailed output that is produced by CheckErr and specifically the field is erased and the error message has the details of the spec removed. Unfortunately, what starts off as a detail message is a sperate field ends up being concatentated into one string which contains the spec and the detail string. To avoid significant refactoring of the error data structures we just extract the required detail string by looking for it after "}': " which is horrible but expedient.
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:
Use the kubeconfig builder. The number of merges and overrides here gets a little crazy. Stay with me.
Merge together the kubeconfig itself. This is done with the following hierarchy rules:
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.
If $KUBECONFIG is set, then it is treated as a list of files that should be merged.
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.
Determine the context to use based on the first hit in this chain
command line argument - again, parsed from the command line, so it must be late bound
CurrentContext from the merged kubeconfig file
Empty is allowed at this stage
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)
command line argument
If context is present, then use the context value
Empty is allowed
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:
command line argument
If cluster info is present and a value for the attribute is present, use it.
If you don't have a server location, bail.
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:
If there are two conflicting techniques specified from the command line, fail.
If the command line does not specify one, and the auth info has conflicting techniques, fail.
If the command line specifies one and the auth info specifies another, honor the command line technique.
Use default values and potentially prompt for auth information
However, if it appears that we're running in a kubernetes cluster container environment, then run with the auth info kubernetes mounted for us. Specifically: The env vars KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT are set, and the file /var/run/secrets/kubernetes.io/serviceaccount/token exists and is not a directory.
func GetFlagInt ¶
Assumes the flag has a default value.
func GetFlagStringList ¶
func GetFlagStringList(cmd *cobra.Command, flag string) util.StringList
GetFlagStringList can be used to accept multiple argument with flag repetition (e.g. -f arg1 -f arg2 ...)
func MultilineError ¶
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 ¶
MultipleErrors returns a newline delimited string containing the prefix and referenced errors in standard form.
func NewClientCache ¶
func NewClientCache(loader clientcmd.ClientConfig) *clientCache
func OutputVersion ¶
OutputVersion returns the preferred output version for generic content (JSON, YAML, or templates)
func PrinterForCommand ¶
PrinterForCommand returns the default printer for this command. Requires that printer flags have been added to cmd (see AddPrinterFlags).
func ReadConfigData ¶
ReadConfigData reads the bytes from the specified filesytem or network location or from stdin if location == "-". TODO: replace with resource.Builder
func ReadConfigDataFromLocation ¶
TODO: replace with resource.Builder
func StandardErrorMessage ¶
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.
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, withNamespace bool, columnLabels []string) (kubectl.ResourcePrinter, error)
// Returns a Scaler for changing the size of the specified RESTMapping type or an error
Scaler func(mapping *meta.RESTMapping) (kubectl.Scaler, 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) ClientMapperForCommand ¶
func (f *Factory) ClientMapperForCommand() resource.ClientMapper
ClientMapperForCommand returns a ClientMapper for the factory.
func (*Factory) PrintObject ¶
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, withNamespace bool) (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