cmd

Documentation

Index

• func AddClusterConfigFlags(flagSet *flag.FlagSet, cfg *kubeadmapiv1beta2.ClusterConfiguration, ...)
• func AddImagesCommonConfigFlags(flagSet *flag.FlagSet, cfg *kubeadmapiv1beta2.ClusterConfiguration, ...)
• func AddInitConfigFlags(flagSet *flag.FlagSet, cfg *kubeadmapiv1beta2.InitConfiguration)
• func AddInitOtherFlags(flagSet *flag.FlagSet, initOptions *initOptions)
• func AddResetFlags(flagSet *flag.FlagSet, resetOptions *resetOptions)
• func GetSupportedShells() []string
• func NewCmdCompletion(out io.Writer, boilerPlate string) *cobra.Command
• func NewCmdConfig(out io.Writer) *cobra.Command
• func NewCmdConfigImages(out io.Writer) *cobra.Command
• func NewCmdConfigImagesList(out io.Writer, mockK8sVersion *string) *cobra.Command
• func NewCmdConfigImagesPull() *cobra.Command
• func NewCmdConfigMigrate(out io.Writer) *cobra.Command
• func NewCmdConfigPrint(out io.Writer) *cobra.Command
• func NewCmdConfigPrintInitDefaults(out io.Writer) *cobra.Command
• func NewCmdConfigPrintJoinDefaults(out io.Writer) *cobra.Command
• func NewCmdConfigUpload(out io.Writer, kubeConfigFile *string) *cobra.Command
• func NewCmdConfigUploadFromFile(out io.Writer, kubeConfigFile *string) *cobra.Command
• func NewCmdConfigUploadFromFlags(out io.Writer, kubeConfigFile *string) *cobra.Command
• func NewCmdConfigView(out io.Writer, kubeConfigFile *string) *cobra.Command
• func NewCmdInit(out io.Writer, initOptions *initOptions) *cobra.Command
• func NewCmdJoin(out io.Writer, joinOptions *joinOptions) *cobra.Command
• func NewCmdReset(in io.Reader, out io.Writer, resetOptions *resetOptions) *cobra.Command
• func NewCmdToken(out io.Writer, errW io.Writer) *cobra.Command
• func NewCmdTokenGenerate(out io.Writer) *cobra.Command
• func NewCmdVersion(out io.Writer) *cobra.Command
• func NewKubeadmCommand(in io.Reader, out, err io.Writer) *cobra.Command
• func PullControlPlaneImages(runtime utilruntime.ContainerRuntime, cfg *kubeadmapi.ClusterConfiguration) error
• func RunCompletion(out io.Writer, boilerPlate string, cmd *cobra.Command, args []string) error
• func RunConfigView(out io.Writer, client clientset.Interface) error
• func RunCreateToken(out io.Writer, client clientset.Interface, cfgPath string, ...) error
• func RunDeleteTokens(out io.Writer, client clientset.Interface, tokenIDsOrTokens []string) error
• func RunGenerateToken(out io.Writer) error
• func RunListTokens(out io.Writer, errW io.Writer, client clientset.Interface, ...) error
• func RunVersion(out io.Writer, cmd *cobra.Command) error
• type ImagesList
  • func NewImagesList(cfgPath string, cfg *kubeadmapiv1beta2.ClusterConfiguration) (*ImagesList, error)
  • func (i *ImagesList) Run(out io.Writer, printer output.Printer) error
• type ImagesPull
  • func NewImagesPull(runtime utilruntime.ContainerRuntime, images []string) *ImagesPull
• type Version

Functions

func AddClusterConfigFlags

func AddClusterConfigFlags(flagSet *flag.FlagSet, cfg *kubeadmapiv1beta2.ClusterConfiguration, featureGatesString *string)

AddClusterConfigFlags adds cluster flags bound to the config to the specified flagset

func AddImagesCommonConfigFlags

func AddImagesCommonConfigFlags(flagSet *flag.FlagSet, cfg *kubeadmapiv1beta2.ClusterConfiguration, cfgPath *string, featureGatesString *string)

AddImagesCommonConfigFlags adds the flags that configure kubeadm (and affect the images kubeadm will use)

func AddInitConfigFlags

func AddInitConfigFlags(flagSet *flag.FlagSet, cfg *kubeadmapiv1beta2.InitConfiguration)

AddInitConfigFlags adds init flags bound to the config to the specified flagset

func AddInitOtherFlags

func AddInitOtherFlags(flagSet *flag.FlagSet, initOptions *initOptions)

AddInitOtherFlags adds init flags that are not bound to a configuration file to the given flagset Note: All flags that are not bound to the cfg object should be allowed in cmd/kubeadm/app/apis/kubeadm/validation/validation.go

func AddResetFlags

func AddResetFlags(flagSet *flag.FlagSet, resetOptions *resetOptions)

AddResetFlags adds reset flags

func GetSupportedShells

func GetSupportedShells() []string

GetSupportedShells returns a list of supported shells

func NewCmdCompletion

func NewCmdCompletion(out io.Writer, boilerPlate string) *cobra.Command

NewCmdCompletion returns the "kubeadm completion" command

func NewCmdConfig

func NewCmdConfig(out io.Writer) *cobra.Command

NewCmdConfig returns cobra.Command for "kubeadm config" command

func NewCmdConfigImages

func NewCmdConfigImages(out io.Writer) *cobra.Command

NewCmdConfigImages returns the "kubeadm config images" command

func NewCmdConfigImagesList

func NewCmdConfigImagesList(out io.Writer, mockK8sVersion *string) *cobra.Command

NewCmdConfigImagesList returns the "kubeadm config images list" command

func NewCmdConfigImagesPull

func NewCmdConfigImagesPull() *cobra.Command

NewCmdConfigImagesPull returns the `kubeadm config images pull` command

func NewCmdConfigMigrate

func NewCmdConfigMigrate(out io.Writer) *cobra.Command

NewCmdConfigMigrate returns cobra.Command for "kubeadm config migrate" command

func NewCmdConfigPrint

func NewCmdConfigPrint(out io.Writer) *cobra.Command

NewCmdConfigPrint returns cobra.Command for "kubeadm config print" command

func NewCmdConfigPrintInitDefaults

func NewCmdConfigPrintInitDefaults(out io.Writer) *cobra.Command

NewCmdConfigPrintInitDefaults returns cobra.Command for "kubeadm config print init-defaults" command

func NewCmdConfigPrintJoinDefaults

func NewCmdConfigPrintJoinDefaults(out io.Writer) *cobra.Command

NewCmdConfigPrintJoinDefaults returns cobra.Command for "kubeadm config print join-defaults" command

func NewCmdConfigUpload

func NewCmdConfigUpload(out io.Writer, kubeConfigFile *string) *cobra.Command

NewCmdConfigUpload (Deprecated) returns cobra.Command for "kubeadm config upload" command Deprecated: please see kubeadm init phase upload-config

func NewCmdConfigUploadFromFile

func NewCmdConfigUploadFromFile(out io.Writer, kubeConfigFile *string) *cobra.Command

NewCmdConfigUploadFromFile verifies given Kubernetes config file and returns cobra.Command for "kubeadm config upload from-file" command Deprecated: please see kubeadm init phase upload-config

func NewCmdConfigUploadFromFlags

func NewCmdConfigUploadFromFlags(out io.Writer, kubeConfigFile *string) *cobra.Command

NewCmdConfigUploadFromFlags returns cobra.Command for "kubeadm config upload from-flags" command Deprecated: please see kubeadm init phase upload-config

func NewCmdConfigView

func NewCmdConfigView(out io.Writer, kubeConfigFile *string) *cobra.Command

NewCmdConfigView returns cobra.Command for "kubeadm config view" command

func NewCmdInit

func NewCmdInit(out io.Writer, initOptions *initOptions) *cobra.Command

NewCmdInit returns "kubeadm init" command. NB. initOptions is exposed as parameter for allowing unit testing of

the newInitOptions method, that implements all the command options validation logic

func NewCmdJoin

func NewCmdJoin(out io.Writer, joinOptions *joinOptions) *cobra.Command

NewCmdJoin returns "kubeadm join" command. NB. joinOptions is exposed as parameter for allowing unit testing of

the newJoinData method, that implements all the command options validation logic

func NewCmdReset

func NewCmdReset(in io.Reader, out io.Writer, resetOptions *resetOptions) *cobra.Command

NewCmdReset returns the "kubeadm reset" command

func NewCmdToken

func NewCmdToken(out io.Writer, errW io.Writer) *cobra.Command

NewCmdToken returns cobra.Command for token management

func NewCmdTokenGenerate

func NewCmdTokenGenerate(out io.Writer) *cobra.Command

NewCmdTokenGenerate returns cobra.Command to generate new token

func NewCmdVersion

func NewCmdVersion(out io.Writer) *cobra.Command

NewCmdVersion provides the version information of kubeadm.

func NewKubeadmCommand

func NewKubeadmCommand(in io.Reader, out, err io.Writer) *cobra.Command

NewKubeadmCommand returns cobra.Command to run kubeadm command

func PullControlPlaneImages

func PullControlPlaneImages(runtime utilruntime.ContainerRuntime, cfg *kubeadmapi.ClusterConfiguration) error

PullControlPlaneImages pulls all images that the ImagesPull knows about

func RunCompletion

func RunCompletion(out io.Writer, boilerPlate string, cmd *cobra.Command, args []string) error

RunCompletion checks given arguments and executes command

func RunConfigView

func RunConfigView(out io.Writer, client clientset.Interface) error

RunConfigView gets the configuration persisted in the cluster

func RunCreateToken

func RunCreateToken(out io.Writer, client clientset.Interface, cfgPath string, initCfg *kubeadmapiv1beta2.InitConfiguration, printJoinCommand bool, certificateKey string, kubeConfigFile string) error

RunCreateToken generates a new bootstrap token and stores it as a secret on the server.

func RunDeleteTokens

func RunDeleteTokens(out io.Writer, client clientset.Interface, tokenIDsOrTokens []string) error

RunDeleteTokens removes a bootstrap tokens from the server.

func RunGenerateToken

func RunGenerateToken(out io.Writer) error

RunGenerateToken just generates a random token for the user

func RunListTokens

func RunListTokens(out io.Writer, errW io.Writer, client clientset.Interface, printer output.Printer) error

RunListTokens lists details on all existing bootstrap tokens on the server.

func RunVersion

func RunVersion(out io.Writer, cmd *cobra.Command) error

RunVersion provides the version information of kubeadm in format depending on arguments specified in cobra.Command.

Types

type ImagesList

type ImagesList struct {
	// contains filtered or unexported fields
}

ImagesList defines the struct used for "kubeadm config images list"

func NewImagesList

func NewImagesList(cfgPath string, cfg *kubeadmapiv1beta2.ClusterConfiguration) (*ImagesList, error)

NewImagesList returns the underlying struct for the "kubeadm config images list" command

func (*ImagesList) Run

func (i *ImagesList) Run(out io.Writer, printer output.Printer) error

Run runs the images command and writes the result to the io.Writer passed in

type ImagesPull

type ImagesPull struct {
	// contains filtered or unexported fields
}

ImagesPull is the struct used to hold information relating to image pulling

func NewImagesPull

func NewImagesPull(runtime utilruntime.ContainerRuntime, images []string) *ImagesPull

NewImagesPull initializes and returns the `kubeadm config images pull` command

type Version

type Version struct {
	ClientVersion *apimachineryversion.Info `json:"clientVersion"`
}

Version provides the version information of kubeadm.