Address PR comments

Signed-off-by: Arjun Raja Yogidas <[email protected]>

Author: coderbirju

cmd/nerdctl/container/container_health_check_linux_test.go

@@ -19,6 +19,7 @@ package container
 import (
 	"encoding/json"
 	"errors"
+	"fmt"
 	"strings"
 	"testing"
 	"time"
@@ -37,9 +38,6 @@ import (
 )
 
 func TestContainerHealthCheckBasic(t *testing.T) {
-	if rootlessutil.IsRootless() {
-		t.Skip("healthcheck tests are skipped in rootless environment")
-	}
 
 	testCase := nerdtest.Setup()
 
@@ -138,10 +136,6 @@ func TestContainerHealthCheckBasic(t *testing.T) {
 }
 
 func TestContainerHealthCheckAdvance(t *testing.T) {
-	if rootlessutil.IsRootless() {
-		t.Skip("healthcheck tests are skipped in rootless environment")
-	}
-
 	testCase := nerdtest.Setup()
 
 	// Docker CLI does not provide a standalone healthcheck command.
@@ -399,6 +393,43 @@ func TestContainerHealthCheckAdvance(t *testing.T) {
 				}
 			},
 		},
+		{
+			Description: "Healthcheck emits large output repeatedly",
+			Setup: func(data test.Data, helpers test.Helpers) {
+				helpers.Ensure("run", "-d", "--name", data.Identifier(),
+					"--health-cmd", "yes X | head -c 60000",
+					"--health-interval", "1s", "--health-timeout", "2s",
+					testutil.CommonImage, "sleep", nerdtest.Infinity)
+				nerdtest.EnsureContainerStarted(helpers, data.Identifier())
+			},
+			Cleanup: func(data test.Data, helpers test.Helpers) {
+				helpers.Anyhow("rm", "-f", data.Identifier())
+			},
+			Command: func(data test.Data, helpers test.Helpers) test.TestableCommand {
+				for i := 0; i < 3; i++ {
+					helpers.Ensure("container", "healthcheck", data.Identifier())
+					time.Sleep(2 * time.Second)
+				}
+				return helpers.Command("inspect", data.Identifier())
+			},
+			Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
+				return &test.Expected{
+					ExitCode: 0,
+					Output: expect.All(func(_ string, t tig.T) {
+						inspect := nerdtest.InspectContainer(helpers, data.Identifier())
+						h := inspect.State.Health
+						debug, _ := json.MarshalIndent(h, "", "  ")
+						t.Log(string(debug))
+						assert.Assert(t, h != nil, "expected health state")
+						assert.Equal(t, h.Status, healthcheck.Healthy)
+						assert.Assert(t, len(h.Log) >= 3, "expected at least 3 health log entries")
+						for _, log := range h.Log {
+							assert.Assert(t, len(log.Output) >= 1024, fmt.Sprintf("each output should be >= 1024 bytes, was: %s", log.Output))
+						}
+					}),
+				}
+			},
+		},
 		{
 			Description: "Health log in inspect keeps only the latest 5 entries",
 			Setup: func(data test.Data, helpers test.Helpers) {

docs/healthchecks.md

@@ -1,6 +1,6 @@
 # Health Check Support in nerdctl
 
-`nerdctl` supports Docker-compatible health checks for containers, allowing you to monitor container health through user-defined commands.
+`nerdctl` supports Docker-compatible health checks for containers, allowing users to monitor container health via a user-defined command.
 
 ## Configuration Options
 
@@ -15,7 +15,8 @@ Health checks can be configured in multiple ways:
    - `--no-healthcheck`: Disable any container-specified HEALTHCHECK
 
 2. At image build time using HEALTHCHECK in a Dockerfile
-3. In docker-compose.yaml files when using nerdctl compose
+
+**Note:** The `--health-start-interval` option is currently not supported by nerdctl.
 
 ## Configuration Priority
 
@@ -25,6 +26,25 @@ When a container is created, nerdctl determines the health check configuration b
 2. If no CLI flags are set, nerdctl will use any health check defined in the image
 3. If neither is present, no health check will be configured
 
+### Disabling Health Checks
+
+You can disable health checks using the following flag during container create/run:
+
+```bash
+--no-healthcheck
+```
+
+### Running Health Checks Manually
+
+nerdctl provides a container healthcheck command that can be manually triggered by the user. This command runs the
+configured health check inside the container and reports the result. It serves as the entry point for executing
+health checks, especially in scenarios where external scheduling is used.
+
+Example:
+```
+nerdctl container healthcheck <container-id>
+```
+
 ## Automatic Health Checks with systemd
 
 On Linux systems with systemd, nerdctl automatically creates and manages systemd timer units to execute health checks at the configured intervals. This provides reliable scheduling and execution of health checks without requiring a persistent daemon.
@@ -71,4 +91,4 @@ nerdctl run -d --name app \
 3. Disable health checks:
 ```bash
 nerdctl run --no-healthcheck myapp
-```
+```

pkg/containerutil/containerutil.go

@@ -359,11 +359,6 @@ func Stop(ctx context.Context, container containerd.Container, timeout *time.Dur
 		}
 	}()
 
-	// Clean up healthcheck units if configured.
-	// if err := healthcheck.RemoveTransientHealthCheckFiles(ctx, container); err != nil {
-	// 	return fmt.Errorf("failed to clean up healthcheck units for container %s", container.ID())
-	// }
-
 	if timeout == nil {
 		t, ok := l[labels.StopTimeout]
 		if !ok {
@@ -502,11 +497,6 @@ func Pause(ctx context.Context, client *containerd.Client, id string) error {
 		return err
 	}
 
-	// Clean up healthcheck units if configured.
-	// if err := healthcheck.RemoveTransientHealthCheckFiles(ctx, container); err != nil {
-	// 	return fmt.Errorf("failed to clean up healthcheck units for container %s", container.ID())
-	// }
-
 	switch status.Status {
 	case containerd.Paused:
 		return fmt.Errorf("container %s is already paused", id)

pkg/healthcheck/healthcheck_manager_linux.go

@@ -50,9 +50,6 @@ func CreateTimer(ctx context.Context, container containerd.Container) error {
 	logrus.Debugf("Creating healthcheck timer unit: %s", hcName)
 
 	cmd := []string{}
-	if rootlessutil.IsRootless() {
-		cmd = append(cmd, "--user")
-	}
 	if path := os.Getenv("PATH"); path != "" {
 		cmd = append(cmd, "--setenv=PATH="+path)
 	}
@@ -81,7 +78,6 @@ func CreateTimer(ctx context.Context, container containerd.Container) error {
 }
 
 // StartTimer starts the healthcheck timer unit.
-// TODO if we persist hcName to container state, pass that to this function.
 func StartTimer(ctx context.Context, container containerd.Container) error {
 	hc := extractHealthcheck(ctx, container)
 	if hc == nil {