cluster

Documentation

Index

• Variables
• type Arguments

Variables

var (
	// Command performs the "upgrade cluster" function
	Command = &cobra.Command{
		Use:   "cluster",
		Short: "Upgrades a cluster to a newer release version",
		Long: fmt.Sprintf(`Upgrades a cluster to a newer release version.

Upgrades mean the stepwise replacement of the workers, the master nodes and other
building blocks of a cluster with newer versions. See details at

    ` + upgradeDocsURL + `

A cluster will always be upgraded to the subsequent release. To find out what
release version is used currently, use

    gsctl show cluster <cluster-name/cluster-id>

To find out what is the subsequent version, list all available versions using

    gsctl list releases

When in doubt, please contact the Giant Swarm support team before upgrading.

Example:
  gsctl upgrade cluster 6iec4
  gsctl upgrade cluster "Cluster name"
  gsctl upgrade cluster "Cluster name" --release "13.0.0"
`),

		PreRun: upgradeClusterValidationOutput,

		Run: upgradeClusterExecutionOutput,
	}
)

Types

type Arguments

type Arguments struct {
	APIEndpoint       string
	AuthToken         string
	ClusterNameOrID   string
	Force             bool
	Release           string
	UserProvidedToken string
	Verbose           bool
}

Arguments is the struct to pass to our business function and to the validation function.