Documentation
¶
Index ¶
- Variables
- func AddCRISocketFlag(flagSet *pflag.FlagSet, criSocket *string)
- func Examples(s string) string
- func GetClientSet(file string, dryRun bool) (clientset.Interface, error)
- func GetJoinControlPlaneCommand(kubeConfigFile, token, key string, ...) (string, error)
- func GetJoinWorkerCommand(kubeConfigFile, token string, skipTokenPrint bool) (string, error)
- func GetKubeConfigPath(file string) string
- func InteractivelyConfirmAction(action, question string, r io.Reader) error
- func LongDesc(s string) string
- func SubCmdRun() func(c *cobra.Command, args []string)
- func TypeMismatchErr(opt, rType string) error
- func ValidateExactArgNumber(args []string, supportedArgs []string) error
- func ValueFromFlagsOrConfig(flagSet *pflag.FlagSet, name string, cfgValue interface{}, ...) interface{}
Constants ¶
This section is empty.
Variables ¶
var ( // AlphaDisclaimer to be places at the end of description of commands in alpha release AlphaDisclaimer = ` Alpha Disclaimer: this command is currently alpha. ` // MacroCommandLongDescription provide a standard description for "macro" commands MacroCommandLongDescription = LongDesc(` This command is not meant to be run on its own. See list of available subcommands. `) )
Functions ¶
func AddCRISocketFlag ¶ added in v1.14.0
AddCRISocketFlag adds the cri-socket flag to the supplied flagSet
func Examples ¶ added in v1.16.0
Examples is designed to help with producing examples for command line usage. Its behavior is mimicking a similar kubectl function in the following ways: - Beginning and trailing space characters (including empty lines), are stripped from the output. - All lines of text are stripped of beginning and trailing spaces (thus loosing indentation) and are then double-space indented.
func GetClientSet ¶ added in v1.26.0
GetClientSet gets a real or fake client depending on whether the user is dry-running or not
func GetJoinControlPlaneCommand ¶ added in v1.14.0
func GetJoinControlPlaneCommand(kubeConfigFile, token, key string, skipTokenPrint, skipCertificateKeyPrint bool) (string, error)
GetJoinControlPlaneCommand returns the kubeadm join command for a given token and Kubernetes cluster (the current cluster in the kubeconfig file)
func GetJoinWorkerCommand ¶ added in v1.14.0
GetJoinWorkerCommand returns the kubeadm join command for a given token and Kubernetes cluster (the current cluster in the kubeconfig file)
func GetKubeConfigPath ¶ added in v1.14.0
GetKubeConfigPath can be used to search for a kubeconfig in standard locations if and empty string is passed to the function. If a non-empty string is passed the function returns the same string.
func InteractivelyConfirmAction ¶ added in v1.25.0
InteractivelyConfirmAction asks the user whether they _really_ want to take the action.
func LongDesc ¶ added in v1.16.0
LongDesc is designed to help with producing better long command line descriptions in code. Its behavior is somewhat inspired by the same function of kubectl, which uses Markdown for the input message. This one is not Markdown compliant, but it covers the needs of kubeadm. In particular: - Beginning and trailing space characters (including empty lines), are stripped from the output. - Consecutive non-empty lines of text are joined with spaces to form paragraphs. - Paragraphs are blocks of text divided by one or more empty lines or lines consisting only of "space" characters. - Paragraphs are spaced by precisely one empty line in the output. - A line break can be forced by adding a couple of empty spaces at the end of a text line. - All indentation is removed. The resulting output is not indented.
func SubCmdRun ¶ added in v1.26.0
SubCmdRun returns a function that handles a case where a subcommand must be specified Without this callback, if a user runs just the command without a subcommand, or with an invalid subcommand, cobra will print usage information, but still exit cleanly.
func TypeMismatchErr ¶ added in v1.30.0
TypeMismatchErr return an error which indicates how the type is mismatched.
func ValidateExactArgNumber ¶
ValidateExactArgNumber validates that the required top-level arguments are specified
func ValueFromFlagsOrConfig ¶ added in v1.28.0
func ValueFromFlagsOrConfig(flagSet *pflag.FlagSet, name string, cfgValue interface{}, flagValue interface{}) interface{}
ValueFromFlagsOrConfig checks if the "name" flag has been set. If yes, it returns the value of the flag, otherwise it returns the value from config.
Types ¶
This section is empty.
Source Files