Support start_period for healthcheck in Docker Compose #475

denverdino · 2017-08-28T05:46:35Z

Signed-off-by: Li Yi denverdino@gmail.com

- What I did
The --health-start-period duration is supported by docker run and docker service create since 17.05, but it is missing in the Docker Compose.

The PR adds the start_period for healthcheck to Docker Compose.

- How I did it

Adds the start_period for healthcheck to Docker Compose.

- How to verify it

Using the bellow compose file: docker-compose.yaml

version: "3.4"
services:
  foo:
    image: elasticsearch
    healthcheck:
      test: "curl --silent --fail localhost:9200/_cluster/health || exit 1"
      interval: 10s
      timeout: 2s
      retries: 5
      start_period: 15s

docker stack deploy -c docker-compose.yaml elasticsearch

- Description for the changelog

Support start_period for healthcheck in Docker Compose

- A picture of a cute animal (not mandatory but encouraged)

dnephin

You'll also need to update cli/compose/convert/service.go to accept the new field.

I believe this will require an updated to the swarmkit dependency in vendor.conf, which will probably be blocked on #465

dnephin · 2017-08-28T15:18:15Z

cli/compose/schema/data/config_schema_v3.4.json

@@ -324,7 +324,8 @@
            {"type": "array", "items": {"type": "string"}}
          ]
        },
-        "timeout": {"type": "string"}
+        "timeout": {"type": "string"},
+		"start_period": {"type": "string"}


indentation looks off. This file uses spaces not tabs.

dnephin · 2017-08-28T15:19:27Z

cli/compose/types/types.go

@@ -172,7 +172,7 @@ type HealthCheckConfig struct {
 	Timeout     string
 	Interval    string
 	Retries     *uint64
-	StartPeriod string
+	StartPeriod string `mapstructure:"start_period"`


This field should be a *time.Duration not a string. I just noticed that the other fields here are wrong. We'll need to fix that.

func convertHealthcheck(healthcheck *composetypes.HealthCheckConfig) (*container.HealthConfig, error)

will parse and convert the string into time.Duration

It will yes, but it's an unnecessary step. The config should be of type *time.Duration. This is a mistake that was made in other fields of the HealthCheckConfig (that we need to fix), but there are other fields in the service that use *time.Duration correctly.

codecov-io · 2017-08-28T15:27:03Z

Codecov Report

Merging #475 into master will decrease coverage by 1.2%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##           master     #475      +/-   ##
==========================================
- Coverage   48.62%   47.41%   -1.21%     
==========================================
  Files         199      199              
  Lines       16396    16398       +2     
==========================================
- Hits         7972     7775     -197     
- Misses       8008     8228     +220     
+ Partials      416      395      -21

Signed-off-by: Li Yi <denverdino@gmail.com>

denverdino · 2017-08-30T01:11:42Z

Changed the type of interval, timeout and start_period of healthcheck from string to * time.Duration

Thanks

dnephin

thanks, just one comment

dnephin · 2017-08-30T14:58:42Z

cli/compose/schema/data/config_schema_v3.3.json

        "retries": {"type": "number"},
        "test": {
          "oneOf": [
            {"type": "string"},
            {"type": "array", "items": {"type": "string"}}
          ]
        },
-        "timeout": {"type": "string"}
+        "timeout": {"type": "string", "format": "duration"}


Normally we do not make any changes to previous versions of the schema. They should be frozen. Would you mind reverting this change in the previous versions?

Do you think the change on the datatype will impact the parsing for old version?

Nope, it wont

…from string to * time.Duration Signed-off-by: Li Yi <denverdino@gmail.com>

denverdino · 2017-08-30T15:43:46Z

@dnephin Thanks for your comments, the change on the 3.0~3.3 schema is reverted

vdemeester

LGTM 🐮

dnephin

LGTM

mmariani · 2017-09-27T08:46:12Z

I was waiting for this feature, but I think I am missing something here.

start_period Additional property start_period is not allowed

$ docker version
Client:
 Version:      17.09.0-ce
 API version:  1.32
 Go version:   go1.8.3
 Git commit:   afdb6d4
 Built:        Tue Sep 26 22:42:45 2017
 OS/Arch:      linux/amd64

Server:
 Version:      17.09.0-ce
 API version:  1.32 (minimum version 1.12)
 Go version:   go1.8.3
 Git commit:   afdb6d4
 Built:        Tue Sep 26 22:41:24 2017
 OS/Arch:      linux/amd64
 Experimental: true

     [...]
     healthcheck:
       test: "curl --fail http://localhost:5601/ || exit 1"
       start_period: 10m

I checked the schema file in the 17.09 release of docker-ce and it seems correct.

rdxmb · 2017-10-13T19:48:12Z

// edited: works with docker-compose file version 3.4

denverdino requested review from dnephin and vdemeester as code owners August 28, 2017 05:46

GordonTheTurtle added the status/0-triage label Aug 28, 2017

denverdino mentioned this pull request Aug 28, 2017

Add support for --health-start-period in Compose/Stack file #116

Closed

vdemeester added status/2-code-review and removed status/0-triage labels Aug 28, 2017

dnephin reviewed Aug 28, 2017

View reviewed changes

GordonTheTurtle added the dco/no label Aug 29, 2017

denverdino force-pushed the start_period branch from 68fb22c to e94b6c7 Compare August 29, 2017 03:12

GordonTheTurtle removed the dco/no label Aug 29, 2017

denverdino force-pushed the start_period branch from e94b6c7 to 15d242e Compare August 29, 2017 03:13

Support start_period for healthcheck in Docker Compose

0abdad6

Signed-off-by: Li Yi <denverdino@gmail.com>

denverdino force-pushed the start_period branch from 099e73c to 0abdad6 Compare August 29, 2017 03:19

docker deleted a comment from GordonTheTurtle Aug 29, 2017

dnephin reviewed Aug 30, 2017

View reviewed changes

Change the type of interval, timeout and start_period of healthcheck …

e02fcfd

…from string to * time.Duration Signed-off-by: Li Yi <denverdino@gmail.com>

denverdino force-pushed the start_period branch from e19ef5c to e02fcfd Compare August 30, 2017 15:41

vdemeester approved these changes Aug 30, 2017

View reviewed changes

dnephin approved these changes Aug 30, 2017

View reviewed changes

dnephin merged commit e636a53 into docker:master Aug 30, 2017

GordonTheTurtle added this to the 17.08.0 milestone Aug 30, 2017

mgansler mentioned this pull request Sep 7, 2017

Include Healthcheck MaksymBilenko/docker-oracle-12c#61

Open

colinmollenhour mentioned this pull request Sep 12, 2017

large database problem colinmollenhour/mariadb-galera-swarm#5

Closed

sepich mentioned this pull request Sep 21, 2017

Healthcheck start_period is not supported but documentation says it is docker/compose#5177

Closed

rdxmb mentioned this pull request Oct 13, 2017

Perform first healthcheck on startup without waiting the specified interval moby/moby#33410

Closed

thaJeztah mentioned this pull request Oct 4, 2019

Grace period option to health checks. moby/moby#28938

Merged

t0mtaylor mentioned this pull request Jul 1, 2023

Docker Healthcheck support on Portainer Container portainer/portainer#3572

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support start_period for healthcheck in Docker Compose #475

Support start_period for healthcheck in Docker Compose #475

denverdino commented Aug 28, 2017

dnephin left a comment

dnephin Aug 28, 2017

dnephin Aug 28, 2017

denverdino Aug 29, 2017

dnephin Aug 29, 2017

codecov-io commented Aug 28, 2017 •

edited

Loading

denverdino commented Aug 30, 2017

dnephin left a comment

dnephin Aug 30, 2017

denverdino Aug 30, 2017

dnephin Aug 30, 2017

denverdino commented Aug 30, 2017

vdemeester left a comment

dnephin left a comment

mmariani commented Sep 27, 2017

rdxmb commented Oct 13, 2017 •

edited

Loading

Support start_period for healthcheck in Docker Compose #475

Support start_period for healthcheck in Docker Compose #475

Conversation

denverdino commented Aug 28, 2017

dnephin left a comment

Choose a reason for hiding this comment

dnephin Aug 28, 2017

Choose a reason for hiding this comment

dnephin Aug 28, 2017

Choose a reason for hiding this comment

denverdino Aug 29, 2017

Choose a reason for hiding this comment

dnephin Aug 29, 2017

Choose a reason for hiding this comment

codecov-io commented Aug 28, 2017 • edited Loading

Codecov Report

denverdino commented Aug 30, 2017

dnephin left a comment

Choose a reason for hiding this comment

dnephin Aug 30, 2017

Choose a reason for hiding this comment

denverdino Aug 30, 2017

Choose a reason for hiding this comment

dnephin Aug 30, 2017

Choose a reason for hiding this comment

denverdino commented Aug 30, 2017

vdemeester left a comment

Choose a reason for hiding this comment

dnephin left a comment

Choose a reason for hiding this comment

mmariani commented Sep 27, 2017

rdxmb commented Oct 13, 2017 • edited Loading

codecov-io commented Aug 28, 2017 •

edited

Loading

rdxmb commented Oct 13, 2017 •

edited

Loading