Merge pull request moby#3998 from cpuguy83/health-start-interval

Add support for health start interval

Author: tonistiigi

exporter/containerimage/image/docker_image.go

@@ -19,9 +19,10 @@ type HealthConfig struct {
 	Test []string `json:",omitempty"`
 
 	// Zero means to inherit. Durations are expressed as integer nanoseconds.
-	Interval    time.Duration `json:",omitempty"` // Interval is the time to wait between checks.
-	Timeout     time.Duration `json:",omitempty"` // Timeout is the time to wait before considering the check to have hung.
-	StartPeriod time.Duration `json:",omitempty"` // The start period for the container to initialize before the retries starts to count down.
+	Interval      time.Duration `json:",omitempty"` // Interval is the time to wait between checks.
+	Timeout       time.Duration `json:",omitempty"` // Timeout is the time to wait before considering the check to have hung.
+	StartPeriod   time.Duration `json:",omitempty"` // The start period for the container to initialize before the retries starts to count down.
+	StartInterval time.Duration `json:",omitempty"` // StartInterval is the time to wait between checks during the start period.
 
 	// Retries is the number of consecutive failures needed to consider a container as unhealthy.
 	// Zero means inherit.

frontend/dockerfile/dockerfile2llb/convert.go

@@ -1274,11 +1274,12 @@ func dispatchEntrypoint(d *dispatchState, c *instructions.EntrypointCommand) err
 
 func dispatchHealthcheck(d *dispatchState, c *instructions.HealthCheckCommand) error {
 	d.image.Config.Healthcheck = &image.HealthConfig{
-		Test:        c.Health.Test,
-		Interval:    c.Health.Interval,
-		Timeout:     c.Health.Timeout,
-		StartPeriod: c.Health.StartPeriod,
-		Retries:     c.Health.Retries,
+		Test:          c.Health.Test,
+		Interval:      c.Health.Interval,
+		Timeout:       c.Health.Timeout,
+		StartPeriod:   c.Health.StartPeriod,
+		StartInterval: c.Health.StartInterval,
+		Retries:       c.Health.Retries,
 	}
 	return commitToHistory(&d.image, fmt.Sprintf("HEALTHCHECK %q", d.image.Config.Healthcheck), false, nil, d.epoch)
 }

frontend/dockerfile/docs/reference.md

@@ -2400,6 +2400,7 @@ The options that can appear before `CMD` are:
 - `--interval=DURATION` (default: `30s`)
 - `--timeout=DURATION` (default: `30s`)
 - `--start-period=DURATION` (default: `0s`)
+- `--start-interval=DURATION` (default: `5s`)
 - `--retries=N` (default: `3`)
 
 The health check will first run **interval** seconds after the container is
@@ -2416,6 +2417,8 @@ Probe failure during that period will not be counted towards the maximum number
 However, if a health check succeeds during the start period, the container is considered
 started and all consecutive failures will be counted towards the maximum number of retries.
 
+**start interval** is the time between health checks during the start period.
+
 There can only be one `HEALTHCHECK` instruction in a Dockerfile. If you list
 more than one then only the last `HEALTHCHECK` will take effect.
 

frontend/dockerfile/instructions/parse.go

@@ -544,6 +544,7 @@ func parseHealthcheck(req parseRequest) (*HealthCheckCommand, error) {
 		flInterval := req.flags.AddString("interval", "")
 		flTimeout := req.flags.AddString("timeout", "")
 		flStartPeriod := req.flags.AddString("start-period", "")
+		flStartInterval := req.flags.AddString("start-interval", "")
 		flRetries := req.flags.AddString("retries", "")
 
 		if err := req.flags.Parse(); err != nil {
@@ -584,6 +585,12 @@ func parseHealthcheck(req parseRequest) (*HealthCheckCommand, error) {
 		}
 		healthcheck.StartPeriod = startPeriod
 
+		startInterval, err := parseOptInterval(flStartInterval)
+		if err != nil {
+			return nil, err
+		}
+		healthcheck.StartInterval = startInterval
+
 		if flRetries.Value != "" {
 			retries, err := strconv.ParseInt(flRetries.Value, 10, 32)
 			if err != nil {

frontend/dockerfile/parser/testfiles/health/Dockerfile

@@ -8,4 +8,4 @@ HEALTHCHECK CMD
 HEALTHCHECK   CMD   a b
 HEALTHCHECK --timeout=3s CMD ["foo"]
 HEALTHCHECK CONNECT TCP 7000
-HEALTHCHECK --start-period=0s --interval=5s --timeout=0s --retries=0 CMD ["foo"]
+HEALTHCHECK --start-period=0s --start-interval=0s --interval=5s --timeout=0s --retries=0 CMD ["foo"]

frontend/dockerfile/parser/testfiles/health/result

@@ -7,4 +7,4 @@
 (healthcheck "CMD" "a b")
 (healthcheck ["--timeout=3s"] "CMD" "foo")
 (healthcheck "CONNECT" "TCP 7000")
-(healthcheck ["--start-period=0s" "--interval=5s" "--timeout=0s" "--retries=0"] "CMD" "foo")
+(healthcheck ["--start-period=0s" "--start-interval=0s" "--interval=5s" "--timeout=0s" "--retries=0"] "CMD" "foo")

go.mod

@@ -28,7 +28,7 @@ require (
 	github.com/coreos/go-systemd/v22 v22.5.0
 	github.com/docker/cli v24.0.2+incompatible
 	github.com/docker/distribution v2.8.2+incompatible
-	github.com/docker/docker v24.0.2+incompatible
+	github.com/docker/docker v24.0.0-rc.2.0.20230706181717-98d3da79ef9c+incompatible
 	github.com/docker/go-connections v0.4.0
 	github.com/docker/go-units v0.5.0
 	github.com/gofrs/flock v0.8.1

go.sum

@@ -445,8 +445,8 @@ github.com/docker/docker v1.4.2-0.20180531152204-71cd53e4a197/go.mod h1:eEKB0N0r
 github.com/docker/docker v1.4.2-0.20190924003213-a8608b5b67c7/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
 github.com/docker/docker v17.12.0-ce-rc1.0.20200730172259-9f28837c1d93+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
 github.com/docker/docker v20.10.0-beta1.0.20201110211921-af34b94a78a1+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
-github.com/docker/docker v24.0.2+incompatible h1:eATx+oLz9WdNVkQrr0qjQ8HvRJ4bOOxfzEo8R+dA3cg=
-github.com/docker/docker v24.0.2+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
+github.com/docker/docker v24.0.0-rc.2.0.20230706181717-98d3da79ef9c+incompatible h1:XccikgvtGCEZE9ZQoaEApdx9ZvruGYakfi2tw4d/vUg=
+github.com/docker/docker v24.0.0-rc.2.0.20230706181717-98d3da79ef9c+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
 github.com/docker/docker-credential-helpers v0.6.3/go.mod h1:WRaJzqw3CTB9bk10avuGsjVBZsD05qeibJ1/TYlvc0Y=
 github.com/docker/docker-credential-helpers v0.7.0 h1:xtCHsjxogADNZcdv1pKUHXryefjlVRqWqIhk/uXJp0A=
 github.com/docker/docker-credential-helpers v0.7.0/go.mod h1:rETQfLdHNT3foU5kuNkFR1R1V12OJRRO5lzt2D1b5X0=