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

devin-ai-integration · 2025-04-30T17:09:22Z

Support lookup by name or ID for all VM, cluster, and network commands

This PR extends the pattern implemented in the vm ssh-endpoint command to all other VM, cluster, and network commands. Now all these commands can accept either an ID or a name parameter.

Changes

Added helper functions to convert name to ID for VM, cluster, and network resources
Updated all command usage documentation to indicate that they accept either ID or name
Updated tab completion to include both IDs and names
Ensured consistent implementation across all commands

Testing

Successfully built the CLI with make build
Ran all unit tests with make test-unit

Link to Devin run: https://app.devin.ai/sessions/2f0b35eefee241a0bc6c7403f3cc45ef
Requested by: [email protected]

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

devin-ai-integration · 2025-04-30T17:09:28Z

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

Disable automatic comment and CI monitoring

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

squizzi

This generally lgtm, I think we should stop supporting --name since we now offer support for id or name in arg0 and it's more feature-rich as it supports completions. Perhaps we should initially hide --name and guide people to using the arg0 functionality and deprecate it? Your call Devin.

cli/cmd/network_rm.go

…ted in arguments Co-Authored-By: [email protected] <[email protected]>

squizzi · 2025-04-30T18:12:11Z

@AmberAlston do you mind taking a look at this since this means deprecating the --name flag and make sure things look ok here?

devin-ai-integration · 2025-04-30T18:12:54Z

I've implemented the suggested changes to deprecate the --name flags in the VM, cluster, and network rm commands since we now support name lookup directly in the arguments. The flags are marked as deprecated with guidance to use ID_OR_NAME arguments instead, and the documentation has been updated to reflect this change. All CI checks are passing.

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

AmberAlston · 2025-04-30T19:08:25Z

Given this change, explain exactly what the customer experience will be if they still pass the --name flag as part of their command, for example replicated cluster create --distribution k3s --name Test

devin-ai-integration · 2025-04-30T19:10:20Z

When a customer uses a deprecated flag like --name, they will see a deprecation warning message but the command will still work as expected. For example, running replicated cluster rm --name test will show:

Flag --name has been deprecated, use ID_OR_NAME arguments instead

The command will then proceed to execute normally, removing clusters with the specified name. This provides a smooth transition path for users while guiding them toward the new, more consistent usage pattern.

squizzi · 2025-04-30T21:05:10Z

When I pass replicated vm rm <name> and more then 2 VM IDs with given name exist it doesn't appear to work as expected. We get a vm: remove vm: Not found error. Currently the --name flag works by just iterating the given --name's and removing them. We should just copy that functionality here with a useful stderr message indicating removing multiple matches.

./bin/replicated vm rm wonderful_mayer
Error: remove vm: remove vm: Not found

Usage:
  replicated vm rm ID_OR_NAME [ID_OR_NAME …] [flags]

Aliases:
  rm, delete

Example:
  # Remove a VM by ID or name
  replicated vm rm aaaaa11

  # Remove multiple VMs by ID or name
  replicated vm rm aaaaa11 bbbbb22 ccccc33

  # Remove all VMs with a specific tag
  replicated vm rm --tag env=dev

  # Remove all VMs
  replicated vm rm --all

  # Perform a dry run of removing all VMs
  replicated vm rm --all --dry-run

Flags:
      --all                remove all vms
      --dry-run            Dry run
  -h, --help               help for rm
      --name stringArray   Name of the vm to remove (can be specified multiple times) (deprecated: use ID_OR_NAME arguments instead) (DEPRECATED: use ID_OR_NAME arguments instead)
      --tag stringArray    Tag of the vm to remove (key=value format, can be specified multiple times)

Global Flags:
      --app string     The app slug or app id to use in all calls
      --debug          Enable debug output
      --token string   The API token to use to access your app in the Vendor API

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

devin-ai-integration · 2025-04-30T21:07:40Z

I've fixed the issue with handling multiple VMs/clusters/networks with the same name in the rm commands. Now when you run replicated vm rm <name> and multiple VMs have that name, all matching VMs will be removed instead of returning an error. This matches the behavior of the --name flag while providing a more consistent interface. The changes have been pushed to the PR.

squizzi · 2025-04-30T22:25:54Z

We should update the help text where appropriate to ensure we specify that when removing by name and multiple IDs with given name exist they will all be removed if matched.

… with the same name Co-Authored-By: [email protected] <[email protected]>

squizzi

It looks like we're still missing functionality for id/name completion for the following commands:

replicated cluster kubeconfig
replicated cluster update 
replicated cluster shell
replicated cluster upgrade
replicated cluster addon create object-store
replicated vm update

cli/cmd/vm_rm.go

cli/cmd/cluster_rm.go

…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]>

squizzi

Almost there, just a few issues with using deprecated flags in --help.

squizzi · 2025-04-30T23:05:22Z

cli/cmd/cluster_kubeconfig.go


-# Download kubeconfig for a cluster by name
+# Download kubeconfig for a cluster by name using a flag
 replicated cluster kubeconfig --name "My Cluster"


This should be deprecated with the same warning we used for other deprecations in this PR.

squizzi · 2025-04-30T23:05:28Z

cli/cmd/cluster_kubeconfig.go

 replicated cluster kubeconfig --name "My Cluster"

-# Download kubeconfig for a cluster by ID
+# Download kubeconfig for a cluster by ID using a flag


This should be deprecated with the same warning we used for other deprecations in this PR.

squizzi · 2025-04-30T23:06:34Z

cli/cmd/cluster_shell.go

-# Open a shell for a cluster by name
-replicated cluster shell --name "My Cluster"`,
+# Open a shell for a cluster by name using a flag
+replicated cluster shell --name "My Cluster"


This should be deprecated with the same warning we used for other deprecations in this PR.

squizzi · 2025-04-30T23:06:39Z

cli/cmd/cluster_shell.go

+replicated cluster shell --name "My Cluster"
+
+# Open a shell for a cluster by ID using a flag
+replicated cluster shell --id CLUSTER_ID`,


This should be deprecated with the same warning we used for other deprecations in this PR.

squizzi · 2025-04-30T23:09:07Z

cli/cmd/vm_ssh_endpoint.go

@@ -100,8 +100,8 @@ func (r *runners) getVMIDFromArg(arg string) (string, error) {
 	case 1:
 		return matchingVMs[0], nil
 	default:
-		return "", errors.Errorf("Multiple VMs found with name '%s'. Please use the VM ID instead. Matching VMs: %s. To view all VM IDs run `replicated vm ls`", 
-			arg, 
+		return "", errors.Errorf("Multiple VMs found with name '%s'. Please use the VM ID instead. Matching VMs: %s. To view all VM IDs run `replicated vm ls`",


Suggested change

return "", errors.Errorf("Multiple VMs found with name '%s'. Please use the VM ID instead. Matching VMs: %s. To view all VM IDs run `replicated vm ls`",

return "", errors.Errorf("Multiple VMs found with name %q. Please use the VM ID instead. Matching VMs: %s. To view all VM IDs run `replicated vm ls`",

…ate error message format Co-Authored-By: [email protected] <[email protected]>

cli/cmd/cluster_kubeconfig.go

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

squizzi · 2025-04-30T23:21:06Z

Oh sorry, one last thing, the help text for some of the commands is still referencing CLUSTER_ID, but it should say ID_OR_NAME, make sure each command is referencing ID_OR_NAME in the help text.

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

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

c2faecb

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

devin-ai-integration bot added type::feature echoes/effort: S Low effort changes (M * 0.5) team::day1 labels Apr 30, 2025

Fix PR label check by adding required labels

8813ad4

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

squizzi reviewed Apr 30, 2025

View reviewed changes

cli/cmd/network_rm.go Show resolved Hide resolved

Deprecate --name flags in rm commands since name lookup is now suppor…

0ea8a85

…ted in arguments Co-Authored-By: [email protected] <[email protected]>

squizzi requested a review from AmberAlston April 30, 2025 18:12

Update vm_update and vm_update_ttl commands to support lookup by name

76512f2

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

AmberAlston previously approved these changes Apr 30, 2025

View reviewed changes

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

aeb9d3a

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

devin-ai-integration bot dismissed AmberAlston’s stale review via aeb9d3a April 30, 2025 21:07

Update help text to clarify behavior when removing multiple resources…

cec9df1

… with the same name Co-Authored-By: [email protected] <[email protected]>

squizzi requested changes Apr 30, 2025

View reviewed changes

cli/cmd/vm_rm.go Show resolved Hide resolved

cli/cmd/cluster_rm.go Outdated Show resolved Hide resolved

squizzi requested changes Apr 30, 2025

View reviewed changes

Address PR comments: add deprecation warnings to --name flags and upd…

4ce034c

…ate error message format Co-Authored-By: [email protected] <[email protected]>

squizzi reviewed Apr 30, 2025

View reviewed changes

cli/cmd/cluster_kubeconfig.go Show resolved Hide resolved

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

ca97094

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

squizzi previously approved these changes Apr 30, 2025

View reviewed changes

Update help text to use CLUSTER_ID_OR_NAME consistently across all co…

63698c7

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

devin-ai-integration bot dismissed squizzi’s stale review via 63698c7 April 30, 2025 23:22

squizzi approved these changes Apr 30, 2025

View reviewed changes

squizzi merged commit b84e27c into main Apr 30, 2025
5 checks passed

squizzi deleted the devin/1746032617-vm-cluster-network-lookup-by-name branch April 30, 2025 23:25

	return "", errors.Errorf("Multiple VMs found with name '%s'. Please use the VM ID instead. Matching VMs: %s. To view all VM IDs run `replicated vm ls`",
	return "", errors.Errorf("Multiple VMs found with name %q. Please use the VM ID instead. Matching VMs: %s. To view all VM IDs run `replicated vm ls`",

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

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

Uh oh!

Conversation

devin-ai-integration bot commented Apr 30, 2025

Support lookup by name or ID for all VM, cluster, and network commands

Changes

Testing

Uh oh!

devin-ai-integration bot commented Apr 30, 2025

🤖 Devin AI Engineer

Uh oh!

squizzi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

squizzi commented Apr 30, 2025

Uh oh!

devin-ai-integration bot commented Apr 30, 2025

Uh oh!

AmberAlston commented Apr 30, 2025

Uh oh!

devin-ai-integration bot commented Apr 30, 2025

Uh oh!

squizzi commented Apr 30, 2025

Uh oh!

devin-ai-integration bot commented Apr 30, 2025

Uh oh!

squizzi commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

squizzi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

squizzi left a comment

Choose a reason for hiding this comment

Uh oh!

squizzi Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

squizzi Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

squizzi Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

squizzi Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

squizzi Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

squizzi commented Apr 30, 2025

Uh oh!

Uh oh!

Uh oh!

squizzi commented Apr 30, 2025 •

edited

Loading