Documentation
¶
Index ¶
- func CompareNamespaceFromFile(cmd *cobra.Command, namespace string) error
- func DataToObjects(m meta.RESTMapper, t runtime.ObjectTyper, data []byte) (result []runtime.Object, errors util.ErrorList)
- 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 GetFlagInt(cmd *cobra.Command, flag string) int
- func GetFlagString(cmd *cobra.Command, flag string) string
- func GetKubeNamespace(cmd *cobra.Command) string
- func NewCmdNamespace(out io.Writer) *cobra.Command
- 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(filename string, typer runtime.ObjectTyper, mapper meta.RESTMapper, ...) (mapping *meta.RESTMapping, namespace, name string, data []byte)
- func ResourceOrTypeFromArgs(cmd *cobra.Command, args []string, mapper meta.RESTMapper) (mapping *meta.RESTMapping, namespace, name string)
- type Factory
- func (f *Factory) NewCmdCreate(out io.Writer) *cobra.Command
- func (f *Factory) NewCmdCreateAll(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) NewCmdUpdate(out io.Writer) *cobra.Command
- func (f *Factory) NewCmdVersion(out io.Writer) *cobra.Command
- func (f *Factory) Run(out io.Writer)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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 DataToObjects ¶
func DataToObjects(m meta.RESTMapper, t runtime.ObjectTyper, data []byte) (result []runtime.Object, errors util.ErrorList)
DataToObjects converts the raw JSON data into API objects
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.
func GetFlagBoolPtr ¶
Returns nil if the flag wasn't set.
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 ReadConfigData ¶
ReadConfigData reads the bytes from the specified filesytem or network location or from stdin if location == "-".
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(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.
Types ¶
type Factory ¶
type Factory struct {
ClientBuilder clientcmd.Builder
Mapper meta.RESTMapper
Typer runtime.ObjectTyper
Client func(cmd *cobra.Command, mapping *meta.RESTMapping) (kubectl.RESTClient, error)
Describer func(cmd *cobra.Command, mapping *meta.RESTMapping) (kubectl.Describer, error)
Printer func(cmd *cobra.Command, mapping *meta.RESTMapping, noHeaders bool) (kubectl.ResourcePrinter, error)
Validator func(*cobra.Command) (validation.Schema, error)
}
Factory provides abstractions that allow the Kubectl command to be extended across multiple types of resources and different API sets.
func NewFactory ¶
NewFactory creates a factory with the default Kubernetes resources defined
Source Files