options

Documentation

Index

• func AddGOPSFlags(flags *pflag.FlagSet)
• func AddKlogFlags(fs *pflag.FlagSet)
• func AddProfilingFlags(flags *pflag.FlagSet)
• func FlushProfiling() error
• func InitGOPS() error
• func InitProfiling() error
• type ArtifactExportOptions
  • func NewArtifactExportOptions() *ArtifactExportOptions
  • func (o ArtifactExportOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)
  • func (o *ArtifactExportOptions) Flags() cliflag.NamedFlagSets
• type ArtifactImagesOptions
  • func NewArtifactImagesOptions() *ArtifactImagesOptions
  • func (o ArtifactImagesOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)
  • func (o *ArtifactImagesOptions) Flags() cliflag.NamedFlagSets
• type CertsRenewOptions
  • func NewCertsRenewOptions() *CertsRenewOptions
  • func (o *CertsRenewOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)
  • func (o *CertsRenewOptions) Flags() cliflag.NamedFlagSets
• type CommonOptions
  • func (o *CommonOptions) Flags() cliflag.NamedFlagSets
• type CreateClusterOptions
  • func NewCreateClusterOptions() *CreateClusterOptions
  • func (o *CreateClusterOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)
  • func (o *CreateClusterOptions) Flags() cliflag.NamedFlagSets
• type InitOSOptions
  • func NewInitOSOptions() *InitOSOptions
  • func (o InitOSOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)
  • func (o *InitOSOptions) Flags() cliflag.NamedFlagSets
• type InitRegistryOptions
  • func NewInitRegistryOptions() *InitRegistryOptions
  • func (o InitRegistryOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)
  • func (o *InitRegistryOptions) Flags() cliflag.NamedFlagSets
• type KubekeyRunOptions
  • func NewKubeKeyRunOptions() *KubekeyRunOptions
  • func (o *KubekeyRunOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)
  • func (o *KubekeyRunOptions) Flags() cliflag.NamedFlagSets
• type PipelineOptions
  • func NewPipelineOption() *PipelineOptions
  • func (o *PipelineOptions) Flags() cliflag.NamedFlagSets
• type PreCheckOptions
  • func NewPreCheckOptions() *PreCheckOptions
  • func (o *PreCheckOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)
  • func (o *PreCheckOptions) Flags() cliflag.NamedFlagSets

Functions

func AddGOPSFlags

func AddGOPSFlags(flags *pflag.FlagSet)

func AddKlogFlags

func AddKlogFlags(fs *pflag.FlagSet)

func AddProfilingFlags

func AddProfilingFlags(flags *pflag.FlagSet)

func FlushProfiling

func FlushProfiling() error

func InitGOPS

func InitGOPS() error

func InitProfiling

func InitProfiling() error

Types

type ArtifactExportOptions

type ArtifactExportOptions struct {
	CommonOptions
}

func NewArtifactExportOptions

func NewArtifactExportOptions() *ArtifactExportOptions

func (ArtifactExportOptions) Complete

func (o ArtifactExportOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)

func (*ArtifactExportOptions) Flags

func (o *ArtifactExportOptions) Flags() cliflag.NamedFlagSets

type ArtifactImagesOptions

type ArtifactImagesOptions struct {
	CommonOptions
}

func NewArtifactImagesOptions

func NewArtifactImagesOptions() *ArtifactImagesOptions

func (ArtifactImagesOptions) Complete

func (o ArtifactImagesOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)

func (*ArtifactImagesOptions) Flags

func (o *ArtifactImagesOptions) Flags() cliflag.NamedFlagSets

type CertsRenewOptions

type CertsRenewOptions struct {
	CommonOptions
}

func NewCertsRenewOptions

func NewCertsRenewOptions() *CertsRenewOptions

func (*CertsRenewOptions) Complete

func (o *CertsRenewOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)

func (*CertsRenewOptions) Flags

func (o *CertsRenewOptions) Flags() cliflag.NamedFlagSets

type CommonOptions

type CommonOptions struct {
	// Playbook which to execute.
	Playbook string
	// HostFile is the path of host file
	InventoryFile string
	// ConfigFile is the path of config file
	ConfigFile string
	// Set value in config
	Set []string
	// WorkDir is the baseDir which command find any resource (project etc.)
	WorkDir string
	// Artifact is the path of offline package for kubekey.
	Artifact string
	// Debug mode, after a successful execution of Pipeline, will retain runtime data, which includes task execution status and parameters.
	Debug bool
	// Namespace for all resources.
	Namespace string
}

func (*CommonOptions) Flags

func (o *CommonOptions) Flags() cliflag.NamedFlagSets

type CreateClusterOptions

type CreateClusterOptions struct {
	CommonOptions
	// kubernetes version which the cluster will install.
	Kubernetes string
	// ContainerRuntime for kubernetes. Such as docker, containerd etc.
	ContainerManager string
}

func NewCreateClusterOptions

func NewCreateClusterOptions() *CreateClusterOptions

func (*CreateClusterOptions) Complete

func (o *CreateClusterOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)

func (*CreateClusterOptions) Flags

func (o *CreateClusterOptions) Flags() cliflag.NamedFlagSets

type InitOSOptions

type InitOSOptions struct {
	CommonOptions
}

func NewInitOSOptions

func NewInitOSOptions() *InitOSOptions

func (InitOSOptions) Complete

func (o InitOSOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)

func (*InitOSOptions) Flags

func (o *InitOSOptions) Flags() cliflag.NamedFlagSets

type InitRegistryOptions

type InitRegistryOptions struct {
	CommonOptions
}

func NewInitRegistryOptions

func NewInitRegistryOptions() *InitRegistryOptions

func (InitRegistryOptions) Complete

func (o InitRegistryOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)

func (*InitRegistryOptions) Flags

func (o *InitRegistryOptions) Flags() cliflag.NamedFlagSets

type KubekeyRunOptions

type KubekeyRunOptions struct {
	CommonOptions
	// ProjectAddr is the storage for executable packages (in Ansible format).
	// When starting with http or https, it will be obtained from a Git repository.
	// When starting with file path, it will be obtained from the local path.
	ProjectAddr string
	// ProjectName is the name of project. it will store to project dir use this name.
	// If empty generate from ProjectAddr
	ProjectName string
	// ProjectBranch is the git branch of the git Addr.
	ProjectBranch string
	// ProjectTag if the git tag of the git Addr.
	ProjectTag string
	// ProjectInsecureSkipTLS skip tls or not when git addr is https.
	ProjectInsecureSkipTLS bool
	// ProjectToken to clone and pull git project
	ProjectToken string
	// Tags is the tags of playbook which to execute
	Tags []string
	// SkipTags is the tags of playbook which skip execute
	SkipTags []string
}

func NewKubeKeyRunOptions

func NewKubeKeyRunOptions() *KubekeyRunOptions

func (*KubekeyRunOptions) Complete

func (o *KubekeyRunOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)

func (*KubekeyRunOptions) Flags

func (o *KubekeyRunOptions) Flags() cliflag.NamedFlagSets

type PipelineOptions

type PipelineOptions struct {
	Name      string
	Namespace string
	WorkDir   string
}

func NewPipelineOption

func NewPipelineOption() *PipelineOptions

func (*PipelineOptions) Flags

func (o *PipelineOptions) Flags() cliflag.NamedFlagSets

type PreCheckOptions

type PreCheckOptions struct {
	CommonOptions
}

func NewPreCheckOptions

func NewPreCheckOptions() *PreCheckOptions

func (*PreCheckOptions) Complete

func (o *PreCheckOptions) Complete(cmd *cobra.Command, args []string) (*kubekeyv1.Pipeline, *kubekeyv1.Config, *kubekeyv1.Inventory, error)

func (*PreCheckOptions) Flags

func (o *PreCheckOptions) Flags() cliflag.NamedFlagSets