cmd

Documentation

Index

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

Constants

const (
	// ComponentsOutputYaml is an option used to print the components in yaml format.
	ComponentsOutputYaml = "yaml"
	// ComponentsOutputText is an option used to print the components in text format.
	ComponentsOutputText = "text"
)

const (
	// RepositoriesOutputYaml is an option used to print the repository list in yaml format.
	RepositoriesOutputYaml = "yaml"
	// RepositoriesOutputText is an option used to print the repository list in text format.
	RepositoriesOutputText = "text"
)

const Indentation = `  `

Variables

var (
	// ComponentsOutputs is a list of valid components outputs.
	ComponentsOutputs = []string{ComponentsOutputText, ComponentsOutputYaml}
)

var (
	// RepositoriesOutputs is a list of valid repository list outputs.
	RepositoriesOutputs = []string{RepositoriesOutputYaml, RepositoriesOutputText}
)

var RootCmd = &cobra.Command{
	Use:          "clusterctl",
	SilenceUsage: true,
	Short:        "clusterctl controls the lifecyle of a Cluster API management cluster",
	Long: LongDesc(`
		Get started with Cluster API using clusterctl to create a management cluster,
		install providers, and create templates for your workload cluster.`),
}

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.

Types

type Version

type Version struct {
	ClientVersion *version.Info `json:"clusterctl"`
}

Version provides the version information of clusterctl