Documentation

Index

Constants

View Source
const (
	ApplyAnnotationsFlag = "save-config"
	DefaultErrorExitCode = 1
)

Variables

View Source
var ErrExit = fmt.Errorf("exit")

    ErrExit may be passed to CheckError to instruct it to output nothing but exit with status code 1.

    Functions

    func AddApplyAnnotationFlags

    func AddApplyAnnotationFlags(cmd *cobra.Command)

    func AddApplyAnnotationVarFlags

    func AddApplyAnnotationVarFlags(cmd *cobra.Command, applyAnnotation *bool)

    func AddDryRunFlag

    func AddDryRunFlag(cmd *cobra.Command)

      AddDryRunFlag adds dry-run flag to a command. Usually used by mutations.

      func AddFieldManagerFlagVar

      func AddFieldManagerFlagVar(cmd *cobra.Command, p *string, defaultFieldManager string)

      func AddFilenameOptionFlags

      func AddFilenameOptionFlags(cmd *cobra.Command, options *resource.FilenameOptions, usage string)

      func AddGeneratorFlags

      func AddGeneratorFlags(cmd *cobra.Command, defaultGenerator string)

        AddGeneratorFlags adds flags common to resource generation commands TODO: need to take a pass at other generator commands to use this set of flags

        func AddJsonFilenameFlag

        func AddJsonFilenameFlag(flags *pflag.FlagSet, value *[]string, usage string)

        func AddKustomizeFlag

        func AddKustomizeFlag(flags *pflag.FlagSet, value *string)

          AddKustomizeFlag adds kustomize flag to a command

          func AddPodRunningTimeoutFlag

          func AddPodRunningTimeoutFlag(cmd *cobra.Command, defaultTimeout time.Duration)

          func AddServerSideApplyFlags

          func AddServerSideApplyFlags(cmd *cobra.Command)

          func AddSourceToErr

          func AddSourceToErr(verb string, source string, err error) error

            AddSourceToErr adds handleResourcePrefix and source string to error message. verb is the string like "creating", "deleting" etc. source is the filename or URL to the template file(*.json or *.yaml), or stdin to use to handle the resource.

            func AddValidateFlags

            func AddValidateFlags(cmd *cobra.Command)

            func AddValidateOptionFlags

            func AddValidateOptionFlags(cmd *cobra.Command, options *ValidateOptions)

            func BehaviorOnFatal

            func BehaviorOnFatal(f func(string, int))

              BehaviorOnFatal allows you to override the default behavior when a fatal error occurs, which is to call os.Exit(code). You can pass 'panic' as a function here if you prefer the panic() over os.Exit(1).

              func CheckDiffErr

              func CheckDiffErr(err error)

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

                This method is meant specifically for `kubectl diff` and may be used by other commands.

                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 DefaultBehaviorOnFatal

                  func DefaultBehaviorOnFatal()

                    DefaultBehaviorOnFatal allows you to undo any previous override. Useful in tests.

                    func DefaultSubCommandRun

                    func DefaultSubCommandRun(out io.Writer) func(c *cobra.Command, args []string)

                      DefaultSubCommandRun prints a command's help string to the specified output if no arguments (sub-commands) are provided, or a usage error otherwise.

                      func DumpReaderToFile

                      func DumpReaderToFile(reader io.Reader, filename string) error

                        DumpReaderToFile writes all data from the given io.Reader to the specified file (usually for temporary use).

                        func GetFieldManagerFlag

                        func GetFieldManagerFlag(cmd *cobra.Command) string

                        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 GetFlagInt32

                          func GetFlagInt32(cmd *cobra.Command, flag string) int32

                            Assumes the flag has a default value.

                            func GetFlagInt64

                            func GetFlagInt64(cmd *cobra.Command, flag string) int64

                              Assumes the flag has a default value.

                              func GetFlagString

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

                              func GetFlagStringArray

                              func GetFlagStringArray(cmd *cobra.Command, flag string) []string

                                GetFlagStringArray can be used to accept multiple argument with flag repetition (e.g. -f arg1 -f arg2 ...)

                                func GetFlagStringSlice

                                func GetFlagStringSlice(cmd *cobra.Command, flag string) []string

                                  GetFlagStringSlice can be used to accept multiple argument with flag repetition (e.g. -f arg1,arg2 -f arg3 ...)

                                  func GetForceConflictsFlag

                                  func GetForceConflictsFlag(cmd *cobra.Command) bool

                                  func GetPodRunningTimeoutFlag

                                  func GetPodRunningTimeoutFlag(cmd *cobra.Command) (time.Duration, error)

                                  func GetResourcesAndPairs

                                  func GetResourcesAndPairs(args []string, pairType string) (resources []string, pairArgs []string, err error)

                                    GetResourcesAndPairs retrieves resources and "KEY=VALUE or KEY-" pair args from given args

                                    func GetServerSideApplyFlag

                                    func GetServerSideApplyFlag(cmd *cobra.Command) bool

                                    func IsFilenameSliceEmpty

                                    func IsFilenameSliceEmpty(filenames []string, directory string) bool

                                    func IsSiblingCommandExists

                                    func IsSiblingCommandExists(cmd *cobra.Command, targetCmdName string) bool

                                      IsSiblingCommandExists receives a pointer to a cobra command and a target string. Returns true if the target string is found in the list of sibling commands.

                                      func ManualStrip

                                      func ManualStrip(file []byte) []byte

                                        ManualStrip is used for dropping comments from a YAML file

                                        func Merge

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

                                          Merge requires JSON serialization TODO: merge assumes JSON serialization, and does not properly abstract API retrieval

                                          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 ParsePairs

                                              func ParsePairs(pairArgs []string, pairType string, supportRemove bool) (newPairs map[string]string, removePairs []string, err error)

                                                ParsePairs retrieves new and remove pairs (if supportRemove is true) from "KEY=VALUE or KEY-" pair args

                                                func PrintErrorWithCauses

                                                func PrintErrorWithCauses(err error, errOut io.Writer) bool

                                                  PrintErrorWithCauses prints an error's kind, name, and each of the error's causes in a new line. The returned string will end with a newline. Returns true if a case exists to handle the error type, or false otherwise.

                                                  func PrintFlagsWithDryRunStrategy

                                                  func PrintFlagsWithDryRunStrategy(printFlags *genericclioptions.PrintFlags, dryRunStrategy DryRunStrategy) *genericclioptions.PrintFlags

                                                    PrintFlagsWithDryRunStrategy sets a success message at print time for the dry run strategy

                                                    TODO(juanvallejo): This can be cleaned up even further by creating a PrintFlags struct that binds the --dry-run flag, and whose ToPrinter method returns a printer that understands how to print this success message.

                                                    func RequireNoArguments

                                                    func RequireNoArguments(c *cobra.Command, args []string)

                                                      RequireNoArguments exits with a usage error if extra arguments are provided.

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

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

                                                        func StripComments

                                                        func StripComments(file []byte) []byte

                                                          StripComments will transform a YAML file into JSON, thus dropping any comments in it. Note that if the given file has a syntax error, the transformation will fail and we will manually drop all comments from the file.

                                                          func SuggestAPIResources

                                                          func SuggestAPIResources(parent string) string

                                                            SuggestAPIResources returns a suggestion to use the "api-resources" command to retrieve a supported list of resources

                                                            func UsageErrorf

                                                            func UsageErrorf(cmd *cobra.Command, format string, args ...interface{}) error

                                                            func Warning

                                                            func Warning(cmdErr io.Writer, newGeneratorName, oldGeneratorName string)

                                                            Types

                                                            type DryRunStrategy

                                                            type DryRunStrategy int
                                                            const (
                                                            	// DryRunNone indicates the client will make all mutating calls
                                                            	DryRunNone DryRunStrategy = iota
                                                            
                                                            	// DryRunClient, or client-side dry-run, indicates the client will prevent
                                                            	// making mutating calls such as CREATE, PATCH, and DELETE
                                                            	DryRunClient
                                                            
                                                            	// DryRunServer, or server-side dry-run, indicates the client will send
                                                            	// mutating calls to the APIServer with the dry-run parameter to prevent
                                                            	// persisting changes.
                                                            	//
                                                            	// Note that clients sending server-side dry-run calls should verify that
                                                            	// the APIServer and the resource supports server-side dry-run, and otherwise
                                                            	// clients should fail early.
                                                            	//
                                                            	// If a client sends a server-side dry-run call to an APIServer that doesn't
                                                            	// support server-side dry-run, then the APIServer will persist changes inadvertently.
                                                            	DryRunServer
                                                            )

                                                            func GetDryRunStrategy

                                                            func GetDryRunStrategy(cmd *cobra.Command) (DryRunStrategy, error)

                                                            type Factory

                                                            type Factory interface {
                                                            	genericclioptions.RESTClientGetter
                                                            
                                                            	// DynamicClient returns a dynamic client ready for use
                                                            	DynamicClient() (dynamic.Interface, error)
                                                            
                                                            	// KubernetesClientSet gives you back an external clientset
                                                            	KubernetesClientSet() (*kubernetes.Clientset, error)
                                                            
                                                            	// Returns a RESTClient for accessing Kubernetes resources or an error.
                                                            	RESTClient() (*restclient.RESTClient, error)
                                                            
                                                            	// NewBuilder returns an object that assists in loading objects from both disk and the server
                                                            	// and which implements the common patterns for CLI interactions with generic resources.
                                                            	NewBuilder() *resource.Builder
                                                            
                                                            	// 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.
                                                            	ClientForMapping(mapping *meta.RESTMapping) (resource.RESTClient, error)
                                                            	// Returns a RESTClient for working with Unstructured objects.
                                                            	UnstructuredClientForMapping(mapping *meta.RESTMapping) (resource.RESTClient, error)
                                                            
                                                            	// Returns a schema that can validate objects stored on disk.
                                                            	Validator(validate bool) (validation.Schema, error)
                                                            	// OpenAPISchema returns the schema openapi schema definition
                                                            	OpenAPISchema() (openapi.Resources, error)
                                                            }

                                                              Factory provides abstractions that allow the Kubectl command to be extended across multiple types of resources and different API sets. The rings are here for a reason. In order for composers to be able to provide alternative factory implementations they need to provide low level pieces of *certain* functions so that when the factory calls back into itself it uses the custom version of the function. Rather than try to enumerate everything that someone would want to override we split the factory into rings, where each ring can depend on methods in an earlier ring, but cannot depend upon peer methods in its own ring. 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(clientGetter genericclioptions.RESTClientGetter) Factory

                                                              type MatchVersionFlags

                                                              type MatchVersionFlags struct {
                                                              	Delegate genericclioptions.RESTClientGetter
                                                              
                                                              	RequireMatchedServerVersion bool
                                                              	// contains filtered or unexported fields
                                                              }

                                                                MatchVersionFlags is for setting the "match server version" function.

                                                                func (*MatchVersionFlags) AddFlags

                                                                func (f *MatchVersionFlags) AddFlags(flags *pflag.FlagSet)

                                                                func (*MatchVersionFlags) ToDiscoveryClient

                                                                func (f *MatchVersionFlags) ToDiscoveryClient() (discovery.CachedDiscoveryInterface, error)

                                                                func (*MatchVersionFlags) ToRESTConfig

                                                                func (f *MatchVersionFlags) ToRESTConfig() (*rest.Config, error)

                                                                  ToRESTConfig implements RESTClientGetter. Returns a REST client configuration based on a provided path to a .kubeconfig file, loading rules, and config flag overrides. Expects the AddFlags method to have been called.

                                                                  func (*MatchVersionFlags) ToRESTMapper

                                                                  func (f *MatchVersionFlags) ToRESTMapper() (meta.RESTMapper, error)

                                                                    ToRESTMapper returns a mapper.

                                                                    func (*MatchVersionFlags) ToRawKubeConfigLoader

                                                                    func (f *MatchVersionFlags) ToRawKubeConfigLoader() clientcmd.ClientConfig

                                                                    type ScaleClientFunc

                                                                      ScaleClientFunc provides a ScalesGetter

                                                                      var ScaleClientFn ScaleClientFunc = scaleClient

                                                                        ScaleClientFn gives a way to easily override the function for unit testing if needed.

                                                                        type ValidateOptions

                                                                        type ValidateOptions struct {
                                                                        	EnableValidation bool
                                                                        }

                                                                        Directories

                                                                        Path Synopsis