const (
// DefaultErrorExitCode defines exit the code for failed action generally
DefaultErrorExitCode = 1
// PreFlightExitCode defines exit the code for preflight checks
PreFlightExitCode = 2
// ValidationExitCode defines the exit code validation checks
ValidationExitCode = 3
)
var (
// ErrInvalidSubCommandMsg is an error message returned on invalid subcommands
ErrInvalidSubCommandMsg = "invalid subcommand"
// ErrExit is an error returned when kubeadm is about to exit
ErrExit = errors.New("exit")
)
func ArgumentsFromCommand(command []string) []kubeadmapi.Arg
ArgumentsFromCommand parses a CLI command in the form "--foo=bar" to an Arg slice
func ArgumentsToCommand(base []kubeadmapi.Arg, overrides []kubeadmapi.Arg) []string
ArgumentsToCommand takes two Arg slices, one with the base arguments and one with optional override arguments. In the return list override arguments will precede base arguments. If an argument is present in the overrides, it will cause all instances of the same argument in the base list to be discarded, leaving only the instances of this argument in the overrides to be applied.
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 Chroot(rootfs string) error
Chroot chroot()s to the new path. NB: All file paths after this call are effectively relative to `rootfs`
func CopyDir(src string, dst string) ([]byte, error)
CopyDir copies the content of a folder
func CopyFile(src, dest string) error
CopyFile copies a file from src to dest.
func FormatErrMsg(errs []error) string
FormatErrMsg returns a human-readable string describing the slice of errors passed to the function
func GetControlPlaneEndpoint(controlPlaneEndpoint string, localEndpoint *kubeadmapi.APIEndpoint) (string, error)
GetControlPlaneEndpoint returns a properly formatted endpoint for the control plane built according following rules: - If the controlPlaneEndpoint is defined, use it. - if the controlPlaneEndpoint is defined but without a port number, use the controlPlaneEndpoint + localEndpoint.BindPort is used. - Otherwise, in case the controlPlaneEndpoint is not defined, use the localEndpoint.AdvertiseAddress + the localEndpoint.BindPort.
func GetLocalAPIEndpoint(localEndpoint *kubeadmapi.APIEndpoint) (string, error)
GetLocalAPIEndpoint parses an APIEndpoint and returns it as a string, or returns and error in case it cannot be parsed.
func GetProxyEnvVars() []kubeadmapi.EnvVar
GetProxyEnvVars builds a list of environment variables in order to use the right proxy
func GroupVersionKindsFromBytes(b []byte) ([]schema.GroupVersionKind, error)
GroupVersionKindsFromBytes parses the bytes and returns a gvk slice
func GroupVersionKindsHasClusterConfiguration(gvks ...schema.GroupVersionKind) bool
GroupVersionKindsHasClusterConfiguration returns whether the following gvk slice contains a ClusterConfiguration object
func GroupVersionKindsHasInitConfiguration(gvks ...schema.GroupVersionKind) bool
GroupVersionKindsHasInitConfiguration returns whether the following gvk slice contains a InitConfiguration object
func GroupVersionKindsHasJoinConfiguration(gvks ...schema.GroupVersionKind) bool
GroupVersionKindsHasJoinConfiguration returns whether the following gvk slice contains a JoinConfiguration object
func GroupVersionKindsHasKind(gvks []schema.GroupVersionKind, kind string) bool
GroupVersionKindsHasKind returns whether the following gvk slice contains the kind given as a parameter
func GroupVersionKindsHasResetConfiguration(gvks ...schema.GroupVersionKind) bool
GroupVersionKindsHasResetConfiguration returns whether the following gvk slice contains a ResetConfiguration object
func GroupVersionKindsHasUpgradeConfiguration(gvks ...schema.GroupVersionKind) bool
GroupVersionKindsHasUpgradeConfiguration returns whether the following gvk slice contains a UpgradeConfiguration object
func KubernetesIsCIVersion(version string) bool
KubernetesIsCIVersion checks if user requested CI version
func KubernetesReleaseVersion(version string) (string, error)
KubernetesReleaseVersion is helper function that can fetch available version information from release servers based on label names, like "stable" or "latest".
If argument is already semantic version string, it will return same string.
In case of labels, it tries to fetch from release servers and then return actual semantic version.
Available names on release servers:
stable (latest stable release) stable-1 (latest stable release in 1.x) stable-1.0 (and similarly 1.1, 1.2, 1.3, ...) latest (latest release, including alpha/beta) latest-1 (latest release in 1.x, including alpha/beta) latest-1.0 (and similarly 1.1, 1.2, 1.3, ...)
func KubernetesVersionToImageTag(version string) string
KubernetesVersionToImageTag is helper function that replaces all non-allowed symbols in tag strings with underscores. Image tag can only contain lowercase and uppercase letters, digits, underscores, periods and dashes. Current usage is for CI images where all of symbols except '+' are valid, but function is for generic usage where input can't be always pre-validated.
func MarshalToYaml(obj runtime.Object, gv schema.GroupVersion) ([]byte, error)
MarshalToYaml marshals an object into yaml.
func MarshalToYamlForCodecs(obj runtime.Object, gv schema.GroupVersion, codecs serializer.CodecFactory) ([]byte, error)
MarshalToYamlForCodecs marshals an object into yaml using the specified codec TODO: Is specifying the gv really needed here? TODO: Can we support json out of the box easily here?
func MergeKubeadmEnvVars(envList ...[]kubeadmapi.EnvVar) []v1.EnvVar
MergeKubeadmEnvVars merges values of environment variable slices. The values defined in later slices overwrite values in previous ones.
func MoveFile(src, dest string) error
MoveFile moves a file from src to dest.
func ParseHostPort(hostport string) (string, string, error)
ParseHostPort parses a network address of the form "host:port", "ipv4:port", "[ipv6]:port" into host and port; ":port" can be eventually omitted. If the string is not a valid representation of network address, ParseHostPort returns an error.
func ParsePort(port string) (int, error)
ParsePort parses a string representing a TCP port. If the string is not a valid representation of a TCP port, ParsePort returns an error.
func ParseTemplate(strtmpl string, obj interface{}) ([]byte, error)
ParseTemplate validates and parses passed as argument template
func SplitYAMLDocuments(yamlBytes []byte) (kubeadmapi.DocumentMap, error)
SplitYAMLDocuments reads the YAML bytes per-document, unmarshals the TypeMeta information from each document and returns a map between the GroupVersionKind of the document and the document bytes
func UniversalUnmarshal(buffer []byte) (runtime.Object, error)
UniversalUnmarshal unmarshals YAML or JSON into a runtime.Object using the universal deserializer.
| Name | Synopsis |
|---|---|
| .. | |
| apiclient | |
| certs | |
| config | Package config contains utilities for managing the kubeadm configuration API. |
| strict | |
| crypto | |
| dryrun | |
| etcd | |
| image | |
| initsystem | |
| kubeconfig | |
| output | |
| patches | |
| pkiutil | |
| testing | |
| pubkeypin | Package pubkeypin provides primitives for x509 public key pinning in the style of RFC7469. |
| runtime | |
| staticpod | |
| users | |