pkg/hostagent/events: Add GuestIPAddress string field to Status

Support printing "Guest IP Address: %s" on `limactl start`

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

Author: norio-nomura

pkg/hostagent/events/events.go

@@ -16,6 +16,9 @@ type Status struct {
 
 	Errors []string `json:"errors,omitempty"`
 
+	// 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"`
 
 	// Cloud-init progress information

pkg/hostagent/hostagent.go

@@ -362,6 +362,17 @@ func (a *HostAgent) emitCloudInitProgressEvent(ctx context.Context, progress *ev
 	a.emitEvent(ctx, ev)
 }
 
+func (a *HostAgent) emitGuestIPAddressEvent(ctx context.Context, ip string) {
+	a.statusMu.RLock()
+	currentStatus := a.currentStatus
+	a.statusMu.RUnlock()
+
+	currentStatus.GuestIPAddress = ip
+
+	ev := events.Event{Status: currentStatus}
+	a.emitEvent(ctx, ev)
+}
+
 func generatePassword(length int) (string, error) {
 	// avoid any special symbols, to make it easier to copy/paste
 	return password.Generate(length, length/4, 0, false, false)

pkg/hostagent/requirements.go

@@ -359,7 +359,9 @@ func (a *HostAgent) detectGuestIPAddress(stdout string) error {
 					a.guestIPAddressMu.Lock()
 					a.guestIPAddress = addr.Local
 					a.guestIPAddressMu.Unlock()
-					a.WriteSSHConfigFile(context.Background())
+					ctx := context.Background()
+					a.WriteSSHConfigFile(ctx)
+					a.emitGuestIPAddressEvent(ctx, addr.Local)
 					logrus.Infof("The guest IP address on the interface %q is %q", a.guestIfnameOnSameSubnetAsHost, addr.Local)
 					return nil
 				}

pkg/instance/start.go

@@ -277,10 +277,11 @@ func watchHostAgentEvents(ctx context.Context, inst *limatype.Instance, haStdout
 	defer cancel()
 
 	var (
-		printedSSHLocalPort  bool
-		receivedRunningEvent bool
-		cloudInitCompleted   bool
-		err                  error
+		printedSSHLocalPort   bool
+		printedGuestIPAddress bool
+		receivedRunningEvent  bool
+		cloudInitCompleted    bool
+		err                   error
 	)
 
 	onEvent := func(ev hostagentevents.Event) bool {
@@ -292,6 +293,14 @@ func watchHostAgentEvents(ctx context.Context, inst *limatype.Instance, haStdout
 			inst.SSHLocalPort = ev.Status.SSHLocalPort
 		}
 
+		if !printedGuestIPAddress && ev.Status.GuestIPAddress != "" {
+			logrus.Infof("Guest IP Address: %s", ev.Status.GuestIPAddress)
+			printedGuestIPAddress = true
+
+			// Update the instance's Guest IP address
+			inst.GuestIPAddress = ev.Status.GuestIPAddress
+		}
+
 		if showProgress && ev.Status.CloudInitProgress != nil {
 			progress := ev.Status.CloudInitProgress
 			if progress.Active && progress.LogLine == "" {