util

Documentation

Index

• Variables
• func AddCRISocketFlag(flagSet *pflag.FlagSet, criSocket *string)
• func Examples(s string) string
• func GetJoinControlPlaneCommand(kubeConfigFile, token, key string, ...) (string, error)
• func GetJoinWorkerCommand(kubeConfigFile, token string, skipTokenPrint bool) (string, error)
• func GetKubeConfigPath(file string) string
• func LongDesc(s string) string
• func SubCmdRunE(name string) func(*cobra.Command, []string) error
• func ValidateExactArgNumber(args []string, supportedArgs []string) error

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

func AddCRISocketFlag(flagSet *pflag.FlagSet, criSocket *string)

AddCRISocketFlag adds the cri-socket flag to the supplied flagSet

func Examples

func Examples(s string) string

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 GetJoinControlPlaneCommand

func GetJoinControlPlaneCommand(kubeConfigFile, token, key string, skipTokenPrint, skipCertificateKeyPrint bool) (string, error)

GetJoinControlPlaneCommand returns the kubeadm join command for a given token and and Kubernetes cluster (the current cluster in the kubeconfig file)

func GetJoinWorkerCommand

func GetJoinWorkerCommand(kubeConfigFile, token string, skipTokenPrint bool) (string, error)

GetJoinWorkerCommand returns the kubeadm join command for a given token and and Kubernetes cluster (the current cluster in the kubeconfig file)

func GetKubeConfigPath

func GetKubeConfigPath(file string) string

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 LongDesc

func LongDesc(s string) string

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 SubCmdRunE

func SubCmdRunE(name string) func(*cobra.Command, []string) error

SubCmdRunE 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. We want to return an error code in these cases so that the user knows that their command was invalid.

func ValidateExactArgNumber

func ValidateExactArgNumber(args []string, supportedArgs []string) error

ValidateExactArgNumber validates that the required top-level arguments are specified