Documentation
¶
Index ¶
- Constants
- func AddPrinterFlags(cmd *cobra.Command)
- func ClientMapperForCommand(cmd *cobra.Command, f *Factory) resource.ClientMapper
- func CompareNamespaceFromFile(cmd *cobra.Command, namespace string) error
- func DefaultClientConfig(flags *pflag.FlagSet) clientcmd.ClientConfig
- func FirstNonEmptyString(args ...string) string
- func GetExplicitKubeNamespace(cmd *cobra.Command) (string, bool)
- func GetFilesFromDir(directory string, fileType string) []string
- func GetFlagBool(cmd *cobra.Command, flag string) bool
- func GetFlagBoolPtr(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 GetKubeNamespace(cmd *cobra.Command) string
- func Merge(dst runtime.Object, fragment, kind string) error
- func NewCmdNamespace(out io.Writer) *cobra.Command
- func PrintObject(cmd *cobra.Command, obj runtime.Object, f *Factory, out io.Writer) error
- func PrinterForCommand(cmd *cobra.Command) (kubectl.ResourcePrinter, bool, error)
- func PrinterForMapping(f *Factory, cmd *cobra.Command, mapping *meta.RESTMapping) (kubectl.ResourcePrinter, error)
- func ReadConfigData(location string) ([]byte, error)
- func ReadConfigDataFromLocation(location string) ([]byte, error)
- func ResourceFromArgs(cmd *cobra.Command, args []string, mapper meta.RESTMapper) (mapping *meta.RESTMapping, namespace, name string)
- func ResourceFromArgsOrFile(cmd *cobra.Command, args []string, filename string, typer runtime.ObjectTyper, ...) (mapping *meta.RESTMapping, namespace, name string)
- func ResourceFromFile(cmd *cobra.Command, filename string, typer runtime.ObjectTyper, ...) (mapping *meta.RESTMapping, namespace, name string, data []byte)
- func ResourceOrTypeFromArgs(cmd *cobra.Command, args []string, mapper meta.RESTMapper) (mapping *meta.RESTMapping, namespace, name string)
- func ResourcesFromArgsOrFile(cmd *cobra.Command, args []string, filename, selector string, ...) resource.Visitor
- func RunGet(f *Factory, out io.Writer, cmd *cobra.Command, args []string)
- func SplitResourceArgument(arg string) []string
- type Factory
- func (f *Factory) BindFlags(flags *pflag.FlagSet)
- 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) NewCmdGet(out io.Writer) *cobra.Command
- func (f *Factory) NewCmdLog(out io.Writer) *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) NewCmdUpdate(out io.Writer) *cobra.Command
- func (f *Factory) NewCmdVersion(out io.Writer) *cobra.Command
- func (f *Factory) NewKubectlCommand(out io.Writer) *cobra.Command
Constants ¶
const (
FlagMatchBinaryVersion = "match-server-version"
)
Variables ¶
This section is empty.
Functions ¶
func AddPrinterFlags ¶ added in v0.9.0
func ClientMapperForCommand ¶ added in v0.9.0
func ClientMapperForCommand(cmd *cobra.Command, f *Factory) resource.ClientMapper
ClientMapperForCommand returns a ClientMapper for the given command and factory.
func CompareNamespaceFromFile ¶
CompareNamespaceFromFile returns an error if the namespace the user has provided on the CLI or via the default namespace file does not match the namespace of an input file. This prevents a user from unintentionally updating the wrong namespace.
func DefaultClientConfig ¶ added in v0.9.0
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 and merge rules:
- CommandLineLocation - this parsed from the command line, so it must be late bound
- EnvVarLocation
- CurrentDirectoryLocation
- 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
func FirstNonEmptyString ¶
Returns the first non-empty string out of the ones provided. If all strings are empty, returns an empty string.
func GetExplicitKubeNamespace ¶ added in v0.7.0
GetExplicitKubeNamespace returns the value of the namespace a user explicitly provided on the command line, or false if no such namespace was specified.
func GetFilesFromDir ¶
Return a list of file names of a certain type within a given directory. TODO: replace with resource.Builder
func GetFlagBoolPtr ¶
Returns nil if the flag wasn't set.
func GetFlagDuration ¶ added in v0.9.0
func GetFlagInt ¶
Assumes the flag has a default value.
func GetKubeNamespace ¶ added in v0.7.0
GetKubeNamespace returns the value of the namespace a user provided on the command line or use the default namespace.
func PrintObject ¶ added in v0.9.0
PrintObject prints an api object given command line flags to modify the output format
func PrinterForCommand ¶ added in v0.9.0
PrinterForCommand returns the default printer for this command. Requires that printer flags have been added to cmd (see AddPrinterFlags).
func PrinterForMapping ¶ added in v0.9.0
func PrinterForMapping(f *Factory, 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).
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 ResourceFromArgs ¶
func ResourceFromArgs(cmd *cobra.Command, args []string, mapper meta.RESTMapper) (mapping *meta.RESTMapping, namespace, name string)
ResourceFromArgs expects two arguments with a given type, and extracts the fields necessary to uniquely locate a resource. Displays a usageError if that contract is not satisfied, or a generic error if any other problems occur.
func ResourceFromArgsOrFile ¶
func ResourceFromArgsOrFile(cmd *cobra.Command, args []string, filename string, typer runtime.ObjectTyper, mapper meta.RESTMapper, schema validation.Schema) (mapping *meta.RESTMapping, namespace, name string)
ResourceFromArgsOrFile expects two arguments or a valid file with a given type, and extracts the fields necessary to uniquely locate a resource. Displays a usageError if that contract is not satisfied, or a generic error if any other problems occur.
func ResourceFromFile ¶
func ResourceFromFile(cmd *cobra.Command, filename string, typer runtime.ObjectTyper, mapper meta.RESTMapper, schema validation.Schema) (mapping *meta.RESTMapping, namespace, name string, data []byte)
ResourceFromFile retrieves the name and namespace from a valid file. If the file does not resolve to a known type an error is returned. The returned mapping can be used to determine the correct REST endpoint to modify this resource with.
func ResourceOrTypeFromArgs ¶
func ResourceOrTypeFromArgs(cmd *cobra.Command, args []string, mapper meta.RESTMapper) (mapping *meta.RESTMapping, namespace, name string)
ResourceFromArgs expects two arguments with a given type, and extracts the fields necessary to uniquely locate a resource. Displays a usageError if that contract is not satisfied, or a generic error if any other problems occur.
func ResourcesFromArgsOrFile ¶ added in v0.8.2
func ResourcesFromArgsOrFile( cmd *cobra.Command, args []string, filename, selector string, typer runtime.ObjectTyper, mapper meta.RESTMapper, clientBuilder func(cmd *cobra.Command, mapping *meta.RESTMapping) (resource.RESTClient, error), schema validation.Schema, requireNames bool, ) resource.Visitor
ResourcesFromArgsOrFile computes a list of Resources by extracting info from filename or args. It will handle label selectors provided.
func RunGet ¶ added in v0.9.0
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
func SplitResourceArgument ¶ added in v0.8.2
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 schema that can validate objects stored on disk. Validator func(*cobra.Command) (validation.Schema, 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() *Factory
NewFactory creates a factory with the default Kubernetes resources defined
func (*Factory) BindFlags ¶ added in v0.9.0
BindFlags adds any flags that are common to all kubectl sub commands.
func (*Factory) NewCmdGet ¶
NewCmdGet creates a command object for the generic "get" action, which retrieves one or more resources from a server.