pkg/hostagent: Add GuestIPAddress field to GET /v1/info endpoint`

Update to use guestIPAddress:
- `limactl shell`
- `limactl show-ssh`
- `limactl tunnel`

pkg/limatype:
- Add `GuestIPAddress string` to `Instance`
- Add `Instance.SSHAddressPort()` helper to provide ipAddress and port for SSH

Signed-off-by: Norio Nomura <[email protected]>

Author: norio-nomura

cmd/limactl/shell.go

@@ -267,10 +267,11 @@ func shellAction(cmd *cobra.Command, args []string) error {
 	if olderSSH {
 		logLevel = "QUIET"
 	}
+	sshAddress, sshPort := inst.SSHAddressPort()
 	sshArgs = append(sshArgs, []string{
 		"-o", fmt.Sprintf("LogLevel=%s", logLevel),
-		"-p", strconv.Itoa(inst.SSHLocalPort),
-		inst.SSHAddress,
+		"-p", strconv.Itoa(sshPort),
+		sshAddress,
 		"--",
 		script,
 	}...)

cmd/limactl/show-ssh.go

@@ -109,8 +109,9 @@ func showSSHAction(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	opts = append(opts, "Hostname=127.0.0.1")
-	opts = append(opts, fmt.Sprintf("Port=%d", inst.SSHLocalPort))
+	sshAddress, sshPort := inst.SSHAddressPort()
+	opts = append(opts, fmt.Sprintf("Hostname=%s", sshAddress))
+	opts = append(opts, fmt.Sprintf("Port=%d", sshPort))
 	return sshutil.Format(w, "ssh", instName, format, opts)
 }
 

cmd/limactl/tunnel.go

@@ -103,13 +103,14 @@ func tunnelAction(cmd *cobra.Command, args []string) error {
 	}
 	sshArgs := append([]string{}, sshExe.Args...)
 	sshArgs = append(sshArgs, sshutil.SSHArgsFromOpts(sshOpts)...)
+	sshAddress, sshPort := inst.SSHAddressPort()
 	sshArgs = append(sshArgs, []string{
 		"-q", // quiet
 		"-f", // background
 		"-N", // no command
 		"-D", fmt.Sprintf("127.0.0.1:%d", port),
-		"-p", strconv.Itoa(inst.SSHLocalPort),
-		inst.SSHAddress,
+		"-p", strconv.Itoa(sshPort),
+		sshAddress,
 	}...)
 	sshCmd := exec.CommandContext(ctx, sshExe.Exe, sshArgs...)
 	sshCmd.Stdout = stderr

pkg/hostagent/api/api.go

@@ -4,5 +4,8 @@
 package api
 
 type Info struct {
+	// Guest IP address directly accessible from the host.
+	GuestIPAddress string `json:"guestIPAddress,omitempty"`
+	// SSH local port on the host forwarded to the guest's port 22.
 	SSHLocalPort int `json:"sshLocalPort,omitempty"`
 }

pkg/hostagent/hostagent.go

@@ -504,8 +504,11 @@ func (a *HostAgent) startRoutinesAndWait(ctx context.Context, errCh <-chan error
 }
 
 func (a *HostAgent) Info(_ context.Context) (*hostagentapi.Info, error) {
+	a.guestIPAddressMu.RLock()
+	defer a.guestIPAddressMu.RUnlock()
 	info := &hostagentapi.Info{
-		SSHLocalPort: a.sshLocalPort,
+		GuestIPAddress: a.guestIPAddress,
+		SSHLocalPort:   a.sshLocalPort,
 	}
 	return info, nil
 }

pkg/limatype/lima_instance.go

@@ -47,6 +47,8 @@ type Instance struct {
 	Protected       bool              `json:"protected"`
 	LimaVersion     string            `json:"limaVersion"`
 	Param           map[string]string `json:"param,omitempty"`
+	// Guest IP address directly accessible from the host.
+	GuestIPAddress string `json:"guestIPAddress,omitempty"`
 }
 
 // Protect protects the instance to prohibit accidental removal.
@@ -107,3 +109,13 @@ func (inst *Instance) UnmarshalJSON(data []byte) error {
 	}
 	return nil
 }
+
+func (inst *Instance) SSHAddressPort() (string, int) {
+	sshAddress := inst.SSHAddress
+	sshPort := inst.SSHLocalPort
+	if inst.GuestIPAddress != "" {
+		sshAddress = inst.GuestIPAddress
+		sshPort = 22
+	}
+	return sshAddress, sshPort
+}

pkg/store/instance.go

@@ -82,6 +82,7 @@ func Inspect(ctx context.Context, instName string) (*limatype.Instance, error) {
 				inst.Status = limatype.StatusBroken
 				inst.Errors = append(inst.Errors, fmt.Errorf("failed to get Info from %q: %w", haSock, err))
 			} else {
+				inst.GuestIPAddress = info.GuestIPAddress
 				inst.SSHLocalPort = info.SSHLocalPort
 			}
 		}
@@ -346,10 +347,11 @@ func PrintInstances(w io.Writer, instances []*limatype.Instance, format string,
 			if strings.HasPrefix(dir, homeDir) {
 				dir = strings.Replace(dir, homeDir, "~", 1)
 			}
+			sshAddress, sshPort := instance.SSHAddressPort()
 			fmt.Fprintf(w, "%s\t%s\t%s",
 				instance.Name,
 				instance.Status,
-				fmt.Sprintf("%s:%d", instance.SSHAddress, instance.SSHLocalPort),
+				fmt.Sprintf("%s:%d", sshAddress, sshPort),
 			)
 			if !hideType {
 				fmt.Fprintf(w, "\t%s",