Skip to content

Commit

Permalink
Adding a long description for cluster create
Browse files Browse the repository at this point in the history
  • Loading branch information
jdewinne committed Sep 14, 2023
1 parent ad4c9b5 commit bf45a11
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 10 deletions.
13 changes: 11 additions & 2 deletions cli/cmd/cluster_create.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,17 @@ func (r *runners) InitClusterCreate(parent *cobra.Command) *cobra.Command {
cmd := &cobra.Command{
Use: "create",
Short: "Create test clusters",
Long: `Create test clusters`,
RunE: r.createCluster,
Long: `Create test clusters.
This is a beta feature, with some known limitations:
- K3s, Kind, kurl, helmvm and Openshift clusters only support a single node.
- EKS clusters may report ready before the nodes are completely online.
- kurl is the only supported distribution that can be upgraded.
- Clusters cannot be resized. Create another cluster if you want to make changes, such as add another node.
- On cloud clusters, only one node group per cluster is supported.
- Multi-node support is available only for GKE and EKS.
- There is no support for IPv6.`,
RunE: r.createCluster,
}
parent.AddCommand(cmd)

Expand Down
4 changes: 2 additions & 2 deletions cli/cmd/cluster_ls.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ import (
func (r *runners) InitClusterList(parent *cobra.Command) *cobra.Command {
cmd := &cobra.Command{
Use: "ls",
Short: "list test clusters",
Long: `list test clusters`,
Short: "List test clusters",
Long: `List test clusters`,
RunE: r.listClusters,
}
parent.AddCommand(cmd)
Expand Down
4 changes: 2 additions & 2 deletions cli/cmd/cluster_rm.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ import (
func (r *runners) InitClusterRemove(parent *cobra.Command) *cobra.Command {
cmd := &cobra.Command{
Use: "rm ID [ID …]",
Short: "remove test clusters",
Short: "Remove test clusters",
Long: `Removes a cluster immediately.
You can specify the --all flag to terminate all clusters.`,
RunE: r.removeCluster,
RunE: r.removeCluster,
}
parent.AddCommand(cmd)

Expand Down
8 changes: 4 additions & 4 deletions cli/cmd/cluster_versions.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ import (

func (r *runners) InitClusterVersions(parent *cobra.Command) *cobra.Command {
cmd := &cobra.Command{
Use: "versions",
Short: "list cluster versions",
Long: `list cluster versions`,
RunE: r.listClusterVersions,
Use: "versions",
Short: "List cluster versions",
Long: `List cluster versions`,
RunE: r.listClusterVersions,
}
parent.AddCommand(cmd)

Expand Down

0 comments on commit bf45a11

Please sign in to comment.