Container api port watcher by jandubois · Pull Request #4 · jandubois/lima

jandubois · 2025-07-24T20:31:59Z

No description provided.

Subscribe to the Docker API to monitor container creation and deletion events. Upon receiving these events, the event monitor immediately sends them as API events down the aggregated event channel. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Subscribe to the containerd API to monitor published ports for containers. Upon receiving these events, the event monitor immediately sends them as API events down the aggregated event channel. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Subscribes to kube API for the published ports from NodePort and Loadbalancer type. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

The Kubernetes service is not needed since it has been replaced by the event-driven process. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Also, handle the defaults for Docker, Containerd Signed-off-by: Nino Kodabande <nkodabande@suse.com>

This changes the Docker event monitor to accept socket and create a per socket client to monitor events. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

This will start a containerd client per socket Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Changes the kubernetes service watcher to accept a list of config paths. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Copilot

Pull Request Overview

This PR adds container API port monitoring functionality to Lima, enabling automatic detection and forwarding of dynamically exposed container ports. The implementation introduces port monitors for Docker, Containerd, and Kubernetes services that watch for port exposure events and notify the host agent.

Key changes:

Adds port monitoring configuration to YAML templates for Docker, Containerd, and Kubernetes
Implements event monitoring systems for container engines and Kubernetes services
Integrates port monitors into the guest agent architecture with proper configuration handling

Reviewed Changes

Copilot reviewed 24 out of 25 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
templates/*.yaml	Adds portMonitors configuration sections for k8s, k3s, docker, and docker-rootful templates
pkg/limayaml/limayaml.go	Defines PortMonitor, Engine, and Kubernetes structs for configuration
pkg/limayaml/validate.go	Adds validation logic for Docker and Containerd socket paths
pkg/limayaml/defaults.go	Implements default handling and template processing for port monitors
pkg/guestagent/guestagent_linux.go	Refactors guest agent to use new Config struct and integrate event monitors
pkg/guestagent/events/*.go	Implements Docker, Containerd, and Kubernetes event monitoring systems
pkg/cidata/*.go	Updates template arguments and boot scripts to support port monitor configuration
cmd/lima-guestagent/*.go	Adds command-line flags for port monitor socket and config paths

Copilot · 2025-07-24T20:33:42Z

+		if out, err := executeGuestTemplate(y.PortMonitors.Containerd.Sockets[i], instDir, y.User, y.Param); err == nil {
+			y.PortMonitors.Containerd.Sockets[i] = out.String()
+		} else {
+			logrus.WithError(err).Warnf("Couldn't process Containerd socket %q as a template", y.PortMonitors.Docker.Sockets[i])


The warning message references Docker sockets but should reference Containerd sockets. This will confuse users when debugging template processing errors.

Suggested change

logrus.WithError(err).Warnf("Couldn't process Containerd socket %q as a template", y.PortMonitors.Docker.Sockets[i])

logrus.WithError(err).Warnf("Couldn't process Containerd socket %q as a template", y.PortMonitors.Containerd.Sockets[i])

Copilot · 2025-07-24T20:33:42Z

+type DockerEventMonitor struct{}
+
+func NewDockerEventMonitor(_ []string) (*DockerEventMonitor, error) {
+	panic("Dockert event monitoring is not implemented on this platform")


There's a typo in the panic message: 'Dockert' should be 'Docker'.

Suggested change

panic("Dockert event monitoring is not implemented on this platform")

panic("Docker event monitoring is not implemented on this platform")

Copilot · 2025-07-24T20:33:43Z

+
+type KubeServiceWatcher struct{}
+
+func NewKubeServiceWatcher() *KubeServiceWatcher {


The function signature doesn't match the Linux implementation which takes cfgPaths []string parameter. This inconsistency could cause compilation issues when the stub is used.

Suggested change

func NewKubeServiceWatcher() *KubeServiceWatcher {

func NewKubeServiceWatcher(cfgPaths []string) *KubeServiceWatcher {

Copilot · 2025-07-24T20:33:43Z

+	if !errors.As(err, &timeoutError) {
+		return timeoutError != nil && timeoutError.Timeout()
+	}
+
+	return false


The logic is inverted. When errors.As returns false, timeoutError will be nil, so the function should return errors.As(err, &timeoutError) && timeoutError.Timeout().

Suggested change

if !errors.As(err, &timeoutError) {

return timeoutError != nil && timeoutError.Timeout()

}

return false

return errors.As(err, &timeoutError) && timeoutError.Timeout()

Copilot · 2025-07-24T20:33:43Z

+--docker-sockets \"${LIMA_CIDATA_DOCKER_PORT_MONITOR_SOCKETS}" \
+--containerd-sockets \"{LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}" \
+--kubernetes-configs \"{LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}" \


Missing closing quote. The line should end with " but has " \ which leaves the quote unclosed.

Suggested change

--docker-sockets \"${LIMA_CIDATA_DOCKER_PORT_MONITOR_SOCKETS}" \

--containerd-sockets \"{LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}" \

--kubernetes-configs \"{LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}" \

--docker-sockets "${LIMA_CIDATA_DOCKER_PORT_MONITOR_SOCKETS}" \

--containerd-sockets "${LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}" \

--kubernetes-configs "${LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}" \

Copilot · 2025-07-24T20:33:44Z

-pidfile="/run/lima-guestagent.pid"
+command_args="daemon --debug=${LIMA_CIDATA_DEBUG} \
+--docker-sockets \"${LIMA_CIDATA_DOCKER_PORT_MONITOR_SOCKETS}" \
+--containerd-sockets \"{LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}" \


Missing $ before the environment variable. Should be "${LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}".

Suggested change

--containerd-sockets \"{LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}" \

--containerd-sockets \"${LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}" \

Copilot · 2025-07-24T20:33:44Z

+command_args="daemon --debug=${LIMA_CIDATA_DEBUG} \
+--docker-sockets \"${LIMA_CIDATA_DOCKER_PORT_MONITOR_SOCKETS}" \
+--containerd-sockets \"{LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}" \
+--kubernetes-configs \"{LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}" \


Missing $ before the environment variable. Should be "${LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}".

Suggested change

--kubernetes-configs \"{LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}" \

--kubernetes-configs \"${LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}" \

Copilot · 2025-07-24T20:33:44Z

+--kubernetes-configs \"{LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}" \
+--vsock-port \"${LIMA_CIDATA_VSOCK_PORT}\" \
+--virtio-port \"${LIMA_CIDATA_VIRTIO_PORT}\""
+command_background=true pidfile="/run/lima-guestagent.pid"


[nitpick] Multiple variable assignments on a single line reduce readability. Consider separating them into individual lines for better maintainability.

Suggested change

command_background=true pidfile="/run/lima-guestagent.pid"

command_background=true

pidfile="/run/lima-guestagent.pid"

Copilot · 2025-07-24T20:33:44Z

 		p.listenersRW.Unlock()
 		return
 	}
+	defer p.Remove(ctx, "tcp", hostAddress, guestAddress)


The defer statement is placed before the mutex unlock, which could cause the Remove method to be called while the mutex is still locked, potentially leading to deadlock.

Nino-K added 15 commits July 11, 2025 00:14

Monitor docker event API

067ed46

Subscribe to the Docker API to monitor container creation and deletion events. Upon receiving these events, the event monitor immediately sends them as API events down the aggregated event channel. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Monitor containerd event API

f5d59ea

Subscribe to the containerd API to monitor published ports for containers. Upon receiving these events, the event monitor immediately sends them as API events down the aggregated event channel. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Add kubernetes service watcher

fbfbf24

Subscribes to kube API for the published ports from NodePort and Loadbalancer type. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Removes kuberneteservice

e13a413

The Kubernetes service is not needed since it has been replaced by the event-driven process. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Fixes go lint issues

f9f37f1

Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Add PortMonitor to limayaml

0b27f2c

Also, handle the defaults for Docker, Containerd Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Update docker event monitor

d0d5167

This changes the Docker event monitor to accept socket and create a per socket client to monitor events. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Pass multiple sockets to containerd

764e77b

This will start a containerd client per socket Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Update kubernetes Service Watcher

531ede0

Changes the kubernetes service watcher to accept a list of config paths. Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Add PortMonitors to template that generates ISO

8c0583f

Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Fixes build issue for other platforms

fb0dcd1

Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Add Port Watcher configs to install systemd

98a2ccf

Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Add retry to create docker client

4cb8177

Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Add retry to containerd client creation

ff06f88

Signed-off-by: Nino Kodabande <nkodabande@suse.com>

Add portMonitor property to appropriate templates

c5c68f2

Signed-off-by: Nino Kodabande <nkodabande@suse.com>

jandubois requested a review from Copilot July 24, 2025 20:32

Copilot AI reviewed Jul 24, 2025

View reviewed changes

jandubois mentioned this pull request Jul 24, 2025

Container api port watcher Nino-K/lima#2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Container api port watcher#4

Container api port watcher#4
jandubois wants to merge 15 commits into
masterfrom
container-api-port-watcher

jandubois commented Jul 24, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	logrus.WithError(err).Warnf("Couldn't process Containerd socket %q as a template", y.PortMonitors.Docker.Sockets[i])
	logrus.WithError(err).Warnf("Couldn't process Containerd socket %q as a template", y.PortMonitors.Containerd.Sockets[i])

	panic("Dockert event monitoring is not implemented on this platform")
	panic("Docker event monitoring is not implemented on this platform")


		type KubeServiceWatcher struct{}

		func NewKubeServiceWatcher() *KubeServiceWatcher {

	func NewKubeServiceWatcher() *KubeServiceWatcher {
	func NewKubeServiceWatcher(cfgPaths []string) *KubeServiceWatcher {

	--containerd-sockets \"{LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}" \
	--containerd-sockets \"${LIMA_CIDATA_CONTAINERD_PORT_MONITOR_SOCKETS}" \

	--kubernetes-configs \"{LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}" \
	--kubernetes-configs \"${LIMA_CIDATA_KUBERNETES_SERVICE_WATCHER_CONFIGS}" \

	command_background=true pidfile="/run/lima-guestagent.pid"
	command_background=true
	pidfile="/run/lima-guestagent.pid"

Conversation

jandubois commented Jul 24, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants