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. `) )
AddCRISocketFlag adds the cri-socket flag to the supplied flagSet
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.
GetJoinControlPlaneCommand returns the kubeadm join command for a given token and and Kubernetes cluster (the current cluster in the kubeconfig file)
GetJoinWorkerCommand returns the kubeadm join command for a given token and and Kubernetes cluster (the current cluster in the kubeconfig file)
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.
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.
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.
ValidateExactArgNumber validates that the required top-level arguments are specified