cmd

Documentation

Overview

Package cmd implements clusterctl commands.

Index

• Constants
• Variables
• func Examples(s string) string
• func Execute()
• func GetSupportedShells() []string
• func LongDesc(s string) string
• type ReleaseInfo
• type Version
• type VersionState

Constants

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"
)

Variables

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 lifecycle 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.`),
	PersistentPostRunE: func(*cobra.Command, []string) error {
		ctx := context.Background()

		configClient, err := config.New(ctx, cfgFile)
		if err != nil {
			return err
		}
		disable, err := configClient.Variables().Get("CLUSTERCTL_DISABLE_VERSIONCHECK")
		if err == nil && disable == "true" {

			return nil
		}
		checker, err := newVersionChecker(ctx, configClient.Variables())
		if err != nil {
			return err
		}
		output, err := checker.Check(ctx)
		if err != nil {
			return errors.Wrap(err, "unable to verify clusterctl version")
		}
		if output != "" {

			fmt.Fprintf(os.Stderr, "\033[33m%s\033[0m", output)
		}

		configDirectory, err := xdg.ConfigFile(config.ConfigFolderXDG)
		if err != nil {
			return err
		}

		downloadConfigFile := filepath.Join(configDirectory, config.DownloadConfigFile)
		if _, err := os.Stat(downloadConfigFile); err == nil {
			if verbosity != nil && *verbosity >= 5 {
				fmt.Fprintf(os.Stdout, "Removing downloaded clusterctl config file: %s\n", config.DownloadConfigFile)
			}
			_ = os.Remove(downloadConfigFile)
		}

		return nil
	},
}

RootCmd is clusterctl root CLI command.

Functions

func Examples

func Examples(s string) string

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

func Execute

func Execute()

Execute executes the root command.

func GetSupportedShells

func GetSupportedShells() []string

GetSupportedShells returns a list of supported shells.

func LongDesc

func LongDesc(s string) string

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

Types

type ReleaseInfo

type ReleaseInfo struct {
	Version string
	URL     string
}

ReleaseInfo stores information about the release.

type Version

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

Version provides the version information of clusterctl.

type VersionState

type VersionState struct {
	LastCheck     time.Time
	LatestRelease ReleaseInfo
}

VersionState stores the release info and the last time it was updated.