Support lookup by name or ID for all VM, cluster, and network commands (#543)

* Add support for lookup by name or ID for all VM, cluster, and network commands

Co-Authored-By: [email protected] <[email protected]>

* Fix PR label check by adding required labels

Co-Authored-By: [email protected] <[email protected]>

* Deprecate --name flags in rm commands since name lookup is now supported in arguments

Co-Authored-By: [email protected] <[email protected]>

* Update vm_update and vm_update_ttl commands to support lookup by name

Co-Authored-By: [email protected] <[email protected]>

* Fix handling of multiple resources with the same name in rm commands

Co-Authored-By: [email protected] <[email protected]>

* Update help text to clarify behavior when removing multiple resources with the same name

Co-Authored-By: [email protected] <[email protected]>

* Add ID/name completion for additional commands and fix VM completion function

- Added ID/name lookup to cluster_kubeconfig, cluster_shell, cluster_update, cluster_upgrade, and cluster_addon_create_objectstore commands
- Fixed VM completion function to include resources outside of 'running' state
- Updated help text to clarify behavior with multiple resources with the same name
- Ensured consistent implementation across all commands

Co-Authored-By: [email protected] <[email protected]>

* Address PR comments: add deprecation warnings to --name flags and update error message format

Co-Authored-By: [email protected] <[email protected]>

* Address PR comments: add deprecation warnings to --id flags

Co-Authored-By: [email protected] <[email protected]>

* Update help text to use CLUSTER_ID_OR_NAME consistently across all commands

Co-Authored-By: [email protected] <[email protected]>

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: [email protected] <[email protected]>

Author: devin-ai-integration[bot]

cli/cmd/cluster.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"fmt"
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/replicated/pkg/credentials"
 	"github.com/replicatedhq/replicated/pkg/kotsclient"
@@ -143,3 +144,61 @@ func (r *runners) completeClusterInstanceTypes(cmd *cobra.Command, args []string
 	}
 	return instanceTypes, cobra.ShellCompDirectiveNoFileComp
 }
+
+func (r *runners) completeClusterIDsAndNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	err := r.initClusterClient()
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveNoFileComp
+	}
+
+	var completions []string
+	clusters, err := r.kotsAPI.ListClusters(false, nil, nil)
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveNoFileComp
+	}
+
+	for _, cluster := range clusters {
+		completions = append(completions, cluster.ID)
+		if cluster.Name != "" {
+			completions = append(completions, cluster.Name)
+		}
+	}
+	return completions, cobra.ShellCompDirectiveNoFileComp
+}
+
+func (r *runners) getClusterIDFromArg(arg string) (string, error) {
+	_, err := r.kotsAPI.GetCluster(arg)
+	if err == nil {
+		return arg, nil
+	}
+
+	cause := errors.Cause(err)
+	if cause != platformclient.ErrNotFound && cause != platformclient.ErrForbidden {
+		return "", errors.Wrap(err, "get cluster")
+	}
+
+	clusters, err := r.kotsAPI.ListClusters(false, nil, nil)
+	if errors.Cause(err) == platformclient.ErrForbidden {
+		return "", ErrCompatibilityMatrixTermsNotAccepted
+	} else if err != nil {
+		return "", errors.Wrap(err, "list clusters")
+	}
+
+	var matchingClusters []string
+	for _, cluster := range clusters {
+		if cluster.Name == arg {
+			matchingClusters = append(matchingClusters, cluster.ID)
+		}
+	}
+
+	switch len(matchingClusters) {
+	case 0:
+		return "", errors.Errorf("Cluster with name or ID '%s' not found", arg)
+	case 1:
+		return matchingClusters[0], nil
+	default:
+		return "", errors.Errorf("Multiple clusters found with name '%s'. Please use the cluster ID instead. Matching clusters: %s. To view all cluster IDs run `replicated cluster ls`",
+			arg,
+			fmt.Sprintf("%s (and %d more)", matchingClusters[0], len(matchingClusters)-1))
+	}
+}

cli/cmd/cluster_addon.go

@@ -17,16 +17,16 @@ func (r *runners) InitClusterAddon(parent *cobra.Command) *cobra.Command {
 
 You can use various subcommands to create, list, remove, or check the status of add-ons on a cluster. This command is useful for adding databases, object storage, monitoring, security, or other specialized tools to your cluster environment.`,
 		Example: `# List all add-ons installed on a cluster
-replicated cluster addon ls CLUSTER_ID
+replicated cluster addon ls CLUSTER_ID_OR_NAME
 
 # Remove an add-on from a cluster
-replicated cluster addon rm CLUSTER_ID --id ADDON_ID
+replicated cluster addon rm CLUSTER_ID_OR_NAME --id ADDON_ID
 
 # Create an object store bucket add-on for a cluster
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
 
 # List add-ons with JSON output
-replicated cluster addon ls CLUSTER_ID --output json`,
+replicated cluster addon ls CLUSTER_ID_OR_NAME --output json`,
 	}
 	parent.AddCommand(cmd)
 

cli/cmd/cluster_addon_create.go

@@ -10,10 +10,10 @@ func (r *runners) InitClusterAddonCreate(parent *cobra.Command) *cobra.Command {
 		Short: "Create cluster add-ons.",
 		Long:  `Create new add-ons for a cluster. This command allows you to add functionality or services to a cluster by provisioning the required add-ons.`,
 		Example: `# Create an object store bucket add-on for a cluster
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
 
 # Perform a dry run for creating an object store add-on
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket --dry-run`,
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --dry-run`,
 	}
 	parent.AddCommand(cmd)
 

cli/cmd/cluster_addon_create_objectstore.go

@@ -15,28 +15,33 @@ import (
 
 func (r *runners) InitClusterAddonCreateObjectStore(parent *cobra.Command) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "object-store CLUSTER_ID --bucket-prefix BUCKET_PREFIX",
+		Use:   "object-store CLUSTER_ID_OR_NAME --bucket-prefix BUCKET_PREFIX",
 		Short: "Create an object store bucket for a cluster.",
 		Long:  `Creates an object store bucket for a cluster, requiring a bucket name prefix. The bucket name will be auto-generated using the format "[BUCKET_PREFIX]-[ADDON_ID]-cmx". This feature provisions an object storage bucket that can be used for storage in your cluster environment.`,
 		Example: `# Create an object store bucket with a specified prefix
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
 
 # Create an object store bucket and wait for it to be ready (up to 5 minutes)
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --wait 5m
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --wait 5m
 
 # Perform a dry run to validate inputs without creating the bucket
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --dry-run
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --dry-run
 
 # Create an object store bucket and output the result in JSON format
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --output json
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --output json
 
 # Create an object store bucket with a custom prefix and wait for 10 minutes
-replicated cluster addon create object-store 05929b24 --bucket-prefix custom-prefix --wait 10m`,
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix custom-prefix --wait 10m`,
 		Args: cobra.ExactArgs(1),
 		RunE: func(_ *cobra.Command, cmdArgs []string) error {
-			r.args.clusterAddonCreateObjectStoreClusterID = cmdArgs[0]
+			clusterID, err := r.getClusterIDFromArg(cmdArgs[0])
+			if err != nil {
+				return errors.Wrap(err, "get cluster id from arg")
+			}
+			r.args.clusterAddonCreateObjectStoreClusterID = clusterID
 			return r.clusterAddonCreateObjectStoreCreateRun()
 		},
+		ValidArgsFunction: r.completeClusterIDsAndNames,
 	}
 	parent.AddCommand(cmd)
 

cli/cmd/cluster_addon_ls.go

@@ -14,20 +14,20 @@ func (r *runners) InitClusterAddonLs(parent *cobra.Command) *cobra.Command {
 	args := clusterAddonLsArgs{}
 
 	cmd := &cobra.Command{
-		Use:     "ls CLUSTER_ID",
+		Use:     "ls CLUSTER_ID_OR_NAME",
 		Aliases: []string{"list"},
 		Short:   "List cluster add-ons for a cluster.",
 		Long: `The 'cluster addon ls' command allows you to list all add-ons for a specific cluster. This command provides a detailed overview of the add-ons currently installed on the cluster, including their status and any relevant configuration details.
 
 This can be useful for monitoring the health and configuration of add-ons or performing troubleshooting tasks.`,
 		Example: `# List add-ons for a cluster with default table output
-replicated cluster addon ls CLUSTER_ID
+replicated cluster addon ls CLUSTER_ID_OR_NAME
 
 # List add-ons for a cluster with JSON output
-replicated cluster addon ls CLUSTER_ID --output json
+replicated cluster addon ls CLUSTER_ID_OR_NAME --output json
 
 # List add-ons for a cluster with wide table output
-replicated cluster addon ls CLUSTER_ID --output wide`,
+replicated cluster addon ls CLUSTER_ID_OR_NAME --output wide`,
 		Args: cobra.ExactArgs(1),
 		RunE: func(_ *cobra.Command, cmdArgs []string) error {
 			args.clusterID = cmdArgs[0]

cli/cmd/cluster_addon_rm.go

@@ -15,10 +15,10 @@ func (r *runners) InitClusterAddonRm(parent *cobra.Command) *cobra.Command {
 	args := clusterAddonRmArgs{}
 
 	cmd := &cobra.Command{
-		Use:     "rm CLUSTER_ID --id ADDON_ID",
+		Use:     "rm CLUSTER_ID_OR_NAME --id ADDON_ID",
 		Aliases: []string{"delete"},
 		Short:   "Remove cluster add-on by ID.",
-		Long: `The 'cluster addon rm' command allows you to remove a specific add-on from a cluster by specifying the cluster ID and the add-on ID.
+		Long: `The 'cluster addon rm' command allows you to remove a specific add-on from a cluster by specifying the cluster ID or name and the add-on ID.
 
 This command is useful when you want to deprovision an add-on that is no longer needed or when troubleshooting issues related to specific add-ons. The add-on will be removed immediately, and you will receive confirmation upon successful removal.`,
 		Example: `# Remove an add-on with ID 'abc123' from cluster 'cluster456'

cli/cmd/cluster_kubeconfig.go

@@ -22,37 +22,39 @@ const (
 
 func (r *runners) InitClusterKubeconfig(parent *cobra.Command) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "kubeconfig [ID]",
+		Use:   "kubeconfig [ID_OR_NAME]",
 		Short: "Download credentials for a test cluster.",
 		Long: `The 'cluster kubeconfig' command downloads the credentials (kubeconfig) required to access a test cluster. You can either merge these credentials into your existing kubeconfig file or save them as a new file.
 
-This command ensures that the kubeconfig is correctly configured for use with your Kubernetes tools. You can specify the cluster by ID or by name. Additionally, the kubeconfig can be written to a specific file path or printed to stdout.
+This command ensures that the kubeconfig is correctly configured for use with your Kubernetes tools. You can specify the cluster by ID or name directly as an argument, or by using the '--id' or '--name' flags. Additionally, the kubeconfig can be written to a specific file path or printed to stdout.
 
 You can also use this command to automatically update your current Kubernetes context with the downloaded credentials.`,
 		Example: `# Download and merge kubeconfig into your existing configuration
-replicated cluster kubeconfig CLUSTER_ID
+replicated cluster kubeconfig CLUSTER_ID_OR_NAME
 
 # Save the kubeconfig to a specific file
-replicated cluster kubeconfig CLUSTER_ID --output-path ./kubeconfig
+replicated cluster kubeconfig CLUSTER_ID_OR_NAME --output-path ./kubeconfig
 
 # Print the kubeconfig to stdout
-replicated cluster kubeconfig CLUSTER_ID --stdout
+replicated cluster kubeconfig CLUSTER_ID_OR_NAME --stdout
 
-# Download kubeconfig for a cluster by name
+# Download kubeconfig for a cluster by name using a flag
 replicated cluster kubeconfig --name "My Cluster"
 
-# Download kubeconfig for a cluster by ID
+# Download kubeconfig for a cluster by ID using a flag
 replicated cluster kubeconfig --id CLUSTER_ID`,
 		RunE:              r.kubeconfigCluster,
-		ValidArgsFunction: r.completeClusterIDs,
+		ValidArgsFunction: r.completeClusterIDsAndNames,
 	}
 	parent.AddCommand(cmd)
 
 	cmd.Flags().StringVar(&r.args.kubeconfigClusterName, "name", "", "name of the cluster to download credentials for (when id is not provided)")
 	cmd.RegisterFlagCompletionFunc("name", r.completeClusterNames)
+	cmd.Flag("name").Deprecated = "use ID_OR_NAME arguments instead"
 
 	cmd.Flags().StringVar(&r.args.kubeconfigClusterID, "id", "", "id of the cluster to download credentials for (when name is not provided)")
 	cmd.RegisterFlagCompletionFunc("id", r.completeClusterIDs)
+	cmd.Flag("id").Deprecated = "use ID_OR_NAME arguments instead"
 
 	cmd.Flags().StringVar(&r.args.kubeconfigPath, "output-path", "", "path to kubeconfig file to write to, if not provided, it will be merged into your existing kubeconfig")
 	cmd.Flags().BoolVar(&r.args.kubeconfigStdout, "stdout", false, "write kubeconfig to stdout")
@@ -61,12 +63,15 @@ replicated cluster kubeconfig --id CLUSTER_ID`,
 }
 
 func (r *runners) kubeconfigCluster(_ *cobra.Command, args []string) error {
-	// by default, we look at args[0] as the id
-	// but if it's not provided, we look for a viper flag named "name" and use it
-	// as the name of the cluster, not the id
+	// by default, we look at args[0] as the id or name
+	// but if it's not provided, we look for a flag named "name" or "id"
 	clusterID := ""
 	if len(args) > 0 {
-		clusterID = args[0]
+		var err error
+		clusterID, err = r.getClusterIDFromArg(args[0])
+		if err != nil {
+			return errors.Wrap(err, "get cluster id from arg")
+		}
 	} else if r.args.kubeconfigClusterName != "" {
 		clusters, err := r.kotsAPI.ListClusters(false, nil, nil)
 		if errors.Cause(err) == platformclient.ErrForbidden {

cli/cmd/cluster_nodegroup.go

@@ -12,7 +12,7 @@ func (r *runners) InitClusterNodeGroup(parent *cobra.Command) *cobra.Command {
 
 Node groups define a set of nodes with specific configurations, such as instance types, node counts, or scaling rules. You can use subcommands to perform various actions on node groups.`,
 		Example: `# List all node groups for a cluster
-replicated cluster nodegroup ls CLUSTER_ID`,
+replicated cluster nodegroup ls CLUSTER_ID_OR_NAME`,
 	}
 	parent.AddCommand(cmd)
 

cli/cmd/cluster_nodegroup_ls.go

@@ -9,22 +9,22 @@ import (
 
 func (r *runners) InitClusterNodeGroupList(parent *cobra.Command) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "ls [ID]",
+		Use:     "ls [ID_OR_NAME]",
 		Aliases: []string{"list"},
 		Short:   "List node groups for a cluster.",
 		Long: `The 'cluster nodegroup ls' command lists all the node groups associated with a given cluster. Each node group defines a specific set of nodes with particular configurations, such as instance types and scaling options.
 
 You can view information about the node groups within the specified cluster, including their ID, name, node count, and other configuration details.
 
-You must provide the cluster ID to list its node groups.`,
+You must provide the cluster ID or name to list its node groups.`,
 		Example: `# List all node groups in a cluster with default table output
-replicated cluster nodegroup ls CLUSTER_ID
+replicated cluster nodegroup ls CLUSTER_ID_OR_NAME
 
 # List node groups with JSON output
-replicated cluster nodegroup ls CLUSTER_ID --output json
+replicated cluster nodegroup ls CLUSTER_ID_OR_NAME --output json
 
 # List node groups with wide table output
-replicated cluster nodegroup ls CLUSTER_ID --output wide`,
+replicated cluster nodegroup ls CLUSTER_ID_OR_NAME --output wide`,
 		Args:              cobra.ExactArgs(1),
 		RunE:              r.listNodeGroups,
 		ValidArgsFunction: r.completeClusterIDs,

cli/cmd/cluster_port.go

@@ -12,13 +12,13 @@ func (r *runners) InitClusterPort(parent *cobra.Command) *cobra.Command {
 
 This command provides flexibility for handling ports in various test clusters, ensuring efficient management of cluster networking settings.`,
 		Example: `# List all exposed ports in a cluster
-replicated cluster port ls [CLUSTER_ID]
+replicated cluster port ls [CLUSTER_ID_OR_NAME]
 
 # Remove an exposed port from a cluster
-replicated cluster port rm [CLUSTER_ID] [PORT]
+replicated cluster port rm [CLUSTER_ID_OR_NAME] [PORT]
 
 # Expose a new port in a cluster
-replicated cluster port expose [CLUSTER_ID] [PORT]`,
+replicated cluster port expose [CLUSTER_ID_OR_NAME] [PORT]`,
 		SilenceUsage: true,
 		Hidden:       false,
 	}