cmd

Documentation

Index

• Constants
• Variables
• func Examples(s string) string
• func Execute()
• func LongDesc(s string) string

Constants

const Indentation = `  `

Variables

var RootCmd = &cobra.Command{
	Use:          "metal3ctl",
	SilenceUsage: true,
	Short:        "metal3ctl controls a management cluster for metal-3",
	Long: LongDesc(`
		Get started with metal-3 using metal3ctl for initializing a management cluster by 
		installing Cluster API providers, baremetal-operator and associated packages, and 
		then use metal3ctl for creating yaml templates for your baremetal hosts and 
		workload clusters.`),
}

Functions

func Examples

func Examples(s string) string

Examples normalizes a command's examples to follow the conventions.

func Execute

func Execute()

func LongDesc

func LongDesc(s string) string

LongDesc normalizes a command's long description to follow the conventions.