kubernetes
/
kops
mirror of https://github.com/kubernetes/kops.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Implement completion for "kops get clusters"

This commit is contained in:
John Gardiner Myers 2021-07-19 14:31:25 -07:00
parent c68da24d21
commit abd95d14f4
16 changed files with 35 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/kops/delete_cluster.go
View File

@ -71,7 +71,7 @@ func NewCmdDeleteCluster(f *util.Factory, out io.Writer) *cobra.Command {
Long: deleteClusterLong,
Example: deleteClusterExample,
Args: rootCommand.clusterNameArgsNoKubeconfig(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
return RunDeleteCluster(context.TODO(), f, out, options)
},

2
cmd/kops/edit_cluster.go
View File

@ -79,7 +79,7 @@ func NewCmdEditCluster(f *util.Factory, out io.Writer) *cobra.Command {
Long: editClusterLong,
Example: editClusterExample,
Args: rootCommand.clusterNameArgs(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
return RunEditCluster(context.TODO(), f, out, options)
},

2
cmd/kops/export_kubeconfig.go
View File

@ -88,7 +88,7 @@ func NewCmdExportKubeconfig(f *util.Factory, out io.Writer) *cobra.Command {
return rootCommand.clusterNameArgs(&options.ClusterName)(cmd, args)
}
},
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
return RunExportKubeconfig(context.TODO(), f, out, options, args)
},

2
cmd/kops/get.go
View File

@ -75,7 +75,7 @@ func NewCmdGet(f *util.Factory, out io.Writer) *cobra.Command {
Long: getLong,
Example: getExample,
Args: rootCommand.clusterNameArgs(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
return RunGet(context.TODO(), &rootCommand, out, options)
},

2
cmd/kops/get_assets.go
View File

@ -89,7 +89,7 @@ func NewCmdGetAssets(f *util.Factory, out io.Writer, getOptions *GetOptions) *co
Long: getAssetsLong,
Example: getAssetsExample,
Args: rootCommand.clusterNameArgs(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
return RunGetAssets(context.TODO(), f, out, &options)
},

27
cmd/kops/get_cluster.go
View File

@ -90,29 +90,26 @@ func NewCmdGetCluster(f *util.Factory, out io.Writer, getOptions *GetOptions) *c
}
cmd := &cobra.Command{
Use: "clusters",
Use: "clusters [CLUSTER]...",
Aliases: []string{"cluster"},
Short: getClusterShort,
Long: getClusterLong,
Example: getClusterExample,
Run: func(cmd *cobra.Command, args []string) {
ctx := context.TODO()
Args: func(cmd *cobra.Command, args []string) error {
if len(args) != 0 {
options.ClusterNames = append(options.ClusterNames, args...)
}
if rootCommand.clusterName != "" {
if len(args) != 0 {
exitWithError(fmt.Errorf("cannot mix --name for cluster with positional arguments"))
if rootCommand.clusterName != "" {
return fmt.Errorf("cannot mix --name for cluster with positional arguments")
}
options.ClusterNames = append(options.ClusterNames, rootCommand.clusterName)
options.ClusterNames = append(options.ClusterNames, args...)
} else {
options.ClusterNames = append(options.ClusterNames, rootCommand.ClusterName(true))
}
err := RunGetClusters(ctx, &rootCommand, os.Stdout, &options)
if err != nil {
exitWithError(err)
}
return nil
},
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, false, true),
RunE: func(cmd *cobra.Command, args []string) error {
return RunGetClusters(context.TODO(), &rootCommand, os.Stdout, &options)
},
}

2
cmd/kops/rollingupdate_cluster.go
View File

@ -167,7 +167,7 @@ func NewCmdRollingUpdateCluster(f *util.Factory, out io.Writer) *cobra.Command {
Long: rollingupdateLong,
Example: rollingupdateExample,
Args: rootCommand.clusterNameArgs(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
return RunRollingUpdateCluster(context.TODO(), f, out, &options)
},

2
cmd/kops/root.go
View File

@ -140,7 +140,7 @@ func NewCmdRoot(f *util.Factory, out io.Writer) *cobra.Command {
defaultClusterName := os.Getenv("KOPS_CLUSTER_NAME")
cmd.PersistentFlags().StringVarP(&rootCommand.clusterName, "name", "", defaultClusterName, "Name of cluster. Overrides KOPS_CLUSTER_NAME environment variable")
cmd.RegisterFlagCompletionFunc("name", commandutils.CompleteClusterName(&rootCommand, false))
cmd.RegisterFlagCompletionFunc("name", commandutils.CompleteClusterName(&rootCommand, false, false))
// create subcommands
cmd.AddCommand(NewCmdCreate(f, out))

2
cmd/kops/toolbox_dump.go
View File

@ -82,7 +82,7 @@ func NewCmdToolboxDump(f *util.Factory, out io.Writer) *cobra.Command {
Long: toolboxDumpLong,
Example: toolboxDumpExample,
Args: rootCommand.clusterNameArgs(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
return RunToolboxDump(context.TODO(), f, out, options)
},

2
cmd/kops/toolbox_template.go
View File

@ -86,7 +86,7 @@ func NewCmdToolboxTemplate(f *util.Factory, out io.Writer) *cobra.Command {
Long: toolboxTemplatingLong,
Example: toolboxTemplatingExample,
Args: rootCommand.clusterNameArgs(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
return RunToolBoxTemplate(f, out, options)
},

2
cmd/kops/update_cluster.go
View File

@ -106,7 +106,7 @@ func NewCmdUpdateCluster(f *util.Factory, out io.Writer) *cobra.Command {
Long: updateClusterLong,
Example: updateClusterExample,
Args: rootCommand.clusterNameArgs(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
_, err := RunUpdateCluster(context.TODO(), f, out, options)
return err

2
cmd/kops/upgrade_cluster.go
View File

@ -70,7 +70,7 @@ func NewCmdUpgradeCluster(f *util.Factory, out io.Writer) *cobra.Command {
Long: upgradeClusterLong,
Example: upgradeClusterExample,
Args: rootCommand.clusterNameArgs(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
ctx := context.TODO()

2
cmd/kops/validate_cluster.go
View File

@ -83,7 +83,7 @@ func NewCmdValidateCluster(f *util.Factory, out io.Writer) *cobra.Command {
Long: validateClusterLong,
Example: validateClusterExample,
Args: rootCommand.clusterNameArgs(&options.ClusterName),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true),
ValidArgsFunction: commandutils.CompleteClusterName(&rootCommand, true, false),
RunE: func(cmd *cobra.Command, args []string) error {
result, err := RunValidateCluster(context.TODO(), f, out, options)
if err != nil {

2
docs/cli/kops_get_clusters.md generated
View File

@ -10,7 +10,7 @@ Get one or many clusters.
Display one or many cluster resources.
```
kops get clusters [flags]
kops get clusters [CLUSTER]... [flags]
```
### Examples

1
pkg/commands/commandutils/BUILD.bazel generated
View File

@ -16,6 +16,7 @@ go_library(
"//pkg/client/simple:go_default_library",
"//vendor/github.com/spf13/cobra:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/util/sets:go_default_library",
"//vendor/k8s.io/klog/v2:go_default_library",
],
)

11
pkg/commands/commandutils/cluster.go
View File

@ -21,10 +21,11 @@ import (
"github.com/spf13/cobra"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/sets"
)
// CompleteClusterName returns a Cobra completion function for cluster names.
func CompleteClusterName(f Factory, suppressIfArgs bool) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
func CompleteClusterName(f Factory, suppressIfArgs bool, suppressArgs bool) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
if suppressIfArgs && len(args) > 0 {
return nil, cobra.ShellCompDirectiveNoFileComp
@ -43,8 +44,14 @@ func CompleteClusterName(f Factory, suppressIfArgs bool) func(cmd *cobra.Command
}
var clusterNames []string
alreadySelected := sets.NewString()
if suppressArgs {
alreadySelected = alreadySelected.Insert(args...)
}
for _, cluster := range list.Items {
clusterNames = append(clusterNames, cluster.Name)
if !alreadySelected.Has(cluster.Name) {
clusterNames = append(clusterNames, cluster.Name)
}
}
return clusterNames, cobra.ShellCompDirectiveNoFileComp