Depends_on condition service_completed_successfully #8154

jruizvar · 2021-02-24T22:06:19Z

Description of the Issue

I wrote a compose file docker-compose.yml with two services and the option depends_on in one of the services:

version: "3.9"
services:
  second:
    depends_on:
      first:
        condition: service_completed_successfully
    image: second
  first:
    image: first

According to compose-spec:

condition: condition under which dependency is considered satisfied

service_started: is an equivalent of the short syntax described above

service_healthy: specifies that a dependency is expected to be "healthy"
(as indicated by healthcheck) before starting a dependent service.

service_completed_successfully: specifies that a dependency is expected to run
to successful completion before starting a dependent service.

However, the execution of docker-compose up yields:

ERROR: The Compose file './docker-compose.yml' is invalid because:
services.second.depends_on.first.condition contains "service_completed_successfully", which is an invalid type, it should be a service_started, or a service_healthy

Environment

docker-compose version 1.28.4, build cabd5cfb
docker-py version: 4.4.3
CPython version: 3.7.10
OpenSSL version: OpenSSL 1.1.0l  10 Sep 2019

Client: Docker Engine - Community
 Version:           20.10.3
 API version:       1.41
 Go version:        go1.13.15
 Git commit:        48d30b5
 Built:             Fri Jan 29 14:33:21 2021
 OS/Arch:           linux/amd64
 Context:           default
 Experimental:      true

Server: Docker Engine - Community
 Engine:
  Version:          20.10.3
  API version:      1.41 (minimum version 1.12)
  Go version:       go1.13.15
  Git commit:       46229ca
  Built:            Fri Jan 29 14:31:32 2021
  OS/Arch:          linux/amd64
  Experimental:     false
 containerd:
  Version:          1.4.3
  GitCommit:        269548fa27e0089a8b8278fc4fc781d7f65a939b
 runc:
  Version:          1.0.0-rc92
  GitCommit:        ff819c7e9184c13b7c2607fe6c30ae19403a7aff
 docker-init:
  Version:          0.19.0
  GitCommit:        de40ad0

The text was updated successfully, but these errors were encountered:

portiaove · 2021-03-04T17:40:27Z

Stumbled with the same problem on a service running Node.

My docker-compose.yml looks similar

version: "3.7"
services:
  test:
  dist:
    depends_on:
      test:
        condition: service_completed_successfully

The message prompt by the terminal:

ERROR: The Compose file './docker-compose.yml' is invalid because: services.dist.depends_on.test.condition contains "service_completed_successfully", which is an invalid type, it should be a service_started, or a service_healthy

Any ideas?

ashishchandr70 · 2021-03-12T21:22:33Z

Same issue with the following docker-compose.yml:

version: '3'

services:

 ...(other services defined)...

  fyx_cashier:
    build:
      context: krono-stacks/docker/cashier
      dockerfile: Dockerfile
    container_name: fyx_cashier
    depends_on: 
      fyx_mock:
        condition: service_completed_successfully
    restart: unless-stopped
    env_file: .env
    environment:
      - API=http://172.17.0.1:8080
      - NETWORK=testnet
     
networks:
  app-network:
    driver: bridge

volumes:
  dbdata:

Got this error:

ERROR: The Compose file './docker-compose.yml' is invalid because:
services.cryptofights.depends_on.fyx_mock.condition contains "service_completed_successfully", which is an invalid type, it should be a service_started, or a service_healthy
services.fyx_cashier.depends_on.fyx_mock.condition contains "service_completed_successfully", which is an invalid type, it should be a service_started, or a service_healthy
Fri Mar 12 15:17:51 CST 2021 Could not build containers for local testing. Cannot continue. Exiting

peterroelants · 2021-03-15T16:07:40Z

I ran into the same issue.
After doing some research it seems that the docker-compose implementation sometimes lags the docker-compose spec: compose-spec/compose-spec#144

JakeUrban · 2021-04-07T23:18:56Z

@ulyssessouza @aiordache any chance either of you could look at this?

devopscoder331 · 2021-04-12T12:15:07Z

@jruizvar @ashishchandr70 @peterroelants You have used docker-compose.yml file with string version: "3"

Version 3+ have changes:

There are several things to be aware of when using depends_on:

depends_on does not wait for db and redis to be “ready” before starting web - only until they have been started. If you need to wait for a service to be ready, see Controlling startup order for more on this problem and strategies for solving it.

Version 3 no longer supports the condition form of depends_on.

Look at https://docs.docker.com/compose/compose-file/compose-file-v3/#depends_on

peterroelants · 2021-04-12T12:29:50Z

@devopscoder331 I've been using version: '3.8'

devopscoder331 · 2021-04-12T12:37:09Z

@devopscoder331 I've been using version: '3.8'

Okey, but Compose file versions 3+ don't support the condition form of depends_on.

jruizvar · 2021-04-12T12:52:54Z

That is why I labeled the issue as kind/feature, in order to have the feature back.

devopscoder331 · 2021-04-12T13:08:49Z

That is why I labeled the issue as kind/feature, in order to have the feature back.

Ooops :) now I get it

peterroelants · 2021-04-12T13:09:19Z

Okey, but Compose file versions 3+ don't support the condition form of depends_on.

Weird, because I can use things like:

    depends_on:
      <service-name>:
        condition: service_healthy

It's just that the service_completed_successfully does not work (what I understood this issue to be about).

aiordache · 2021-04-12T14:17:33Z

Hi. Support for service_completed_successfully has been added in the latest version of docker-compose. Give it a try please: https://github.com/docker/compose/releases/tag/1.29.0

peterroelants · 2021-04-12T14:33:27Z

Cool, I wasn't aware of the new release a few days ago. I can confirm that with 1.29.0 using condition: service_completed_successfully works as expected.

augustsaintfreytag · 2021-04-27T19:21:57Z

I was looking for exactly this and defined an app_dependencies service that sets up prerequisites and a corresponding app service that depends on it, to run only on service_completed_successfully. However, it seems the dependencies service is kicked off and the app service is started long before I eventually see…

app_dependencies exited with code 0

…in the log output. I'm using the docker compose command, though docker-compose --version confirms I'm on the version 1.29.0 mentioned here. What am I overlooking here?

ndeloof · 2021-06-17T05:04:28Z

@augustsaintfreytag docker compose issues are tracked on https://github.com/docker/compose-cli/issues

rf-0 · 2021-06-29T20:46:27Z

Can anyone confirm service_completed_successfully works in version 2.0.0-beta.4? Dosent seem to be working for me.

ndeloof · 2021-06-30T05:33:48Z

@rf-0 at least there's an end-to-end test to check it works :P https://github.com/docker/compose-cli/blob/main/pkg/e2e/compose_test.go#L167

Please report issue on docker/compose-cli repo, and if possible attach a reproduction scenario demonstrating your issue.

Without this docker-compose complains about depends_on config settings: > ERROR: The Compose file './docker-compose.yml' is invalid because: > services.tink-server.depends_on.generate-tls-certs.condition contains "service_completed_successfully", which is an invalid type, it should be a service_started, or a service_healthy > services.web-assets-server.depends_on.fetch-and-convert-ubuntu-img.condition contains "service_completed_successfully", which is an invalid type, it should be a service_started, or a service_healthy > services.registry.depends_on.generate-tls-certs.condition contains "service_completed_successfully", which is an invalid type, it should be a service_started, or a service_healthy This was due to docker/compose#8154. Signed-off-by: Manuel Mendez <github@i.m.mmlb.dev>

snoseeds · 2022-07-06T09:21:52Z

Okey, but Compose file versions 3+ don't support the condition form of depends_on.

Weird, because I can use things like:
    depends_on:
      <service-name>:
        condition: service_healthy
It's just that the service_completed_successfully does not work (what I understood this issue to be about).

In what version (3.?) did service_healthy work correctly as claimed here, please?

dolfinus · 2022-07-19T16:04:09Z

In what version (3.?) did service_healthy work correctly as claimed here, please?

3.9

The `depends_on` `service_completed_successfully` config in the compose file requires docker compose 1.29.0 actually. See https://github.com/docker/compose/releases/tag/1.29.0 and docker/compose#8154 Closes #230

zioalex · 2023-08-27T18:02:40Z

In what version (3.?) did service_healthy work correctly as claimed here, please?

3.9
Version 3.9 doesn't work for me.
Can you specify which Docker version do you have?

ndeloof · 2023-08-27T19:53:54Z

In what version (3.?) did service_healthy work correctly as claimed here, please?

version attribute is deprecated in Docker Compose v2 as we adopted the Compose Specification

ramya-1000 · 2023-12-02T09:11:44Z

As v1 is depricated what version of docker compose is supporting for depends on condition service_completed_successfully ?

ndeloof · 2023-12-04T15:55:54Z

Docker Compose v2 supports service_completed_successfully since v2.0.0 (see 15a21a4)

jhf · 2023-12-09T12:37:23Z

When I follow the standard installation of docker, I get both a docker compose and a docker-compose command.
Notice the version difference.

$ docker-compose version
docker-compose version 1.26.0, build d4451659
docker-py version: 4.2.1
CPython version: 3.7.7
OpenSSL version: OpenSSL 1.1.0l  10 Sep 2019

and

$ docker compose version
Docker Compose version v2.21.0

When I try with the docker-compose command, it fails, as you say @jruizvar , however, when I use the docker compose it works.

ndeloof · 2023-12-09T13:49:17Z

@jhf check which docker-compose. This is running obsolete docker-compose v1, maybe installed manually or via pip

jhf · 2023-12-18T10:09:08Z

@jhf check which docker-compose. This is running obsolete docker-compose v1, maybe installed manually or via pip

True @ndeloof , I have since removed that obsolete docker-compose, however the comment was for this thread, such that other people are not confused about docker compose vs docker-compose and that they check their version.
Since, as you say, the support is in recent versions of docker.
Do also note that it depends on the declared docker compose file version, as the attribute service_completed_successfully is only supported in version 2 of the syntax, and not in version 3. So one might use version: "2.4" at the beginning of the docker-compose.yml file.

ndeloof · 2023-12-18T10:13:53Z

@jhf version: "x.y" in your compose file is obsolete, since Compose Specification was introduced 3 years ago. Forget about "version 2 of the syntax, and not in version 3" logic, all attributes are now supported.

jhf · 2023-12-18T11:56:51Z

@jhf version: "x.y" in your compose file is obsolete, since Compose Specification was introduced 3 years ago. Forget about "version 2 of the syntax, and not in version 3" logic, all attributes are now supported.

Good news indeed 👍

ramya-1000 · 2023-12-19T22:54:34Z

That's great to hear!

…

On Mon, 18 Dec, 2023, 5:27 pm Jørgen H. Fjeld, ***@***.***> wrote: @jhf <https://github.com/jhf> version: "x.y" in your compose file is obsolete, since Compose Specification was introduced 3 years ago. Forget about "*version 2 of the syntax, and not in version 3*" logic, all attributes are now supported. Good news indeed 👍 — Reply to this email directly, view it on GitHub <#8154 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A3LILYSRA5I36NG2KXT6AYDYKAVRDAVCNFSM4YFKTYOKU5DIOJSWCZC7NNSXTN2JONZXKZKDN5WW2ZLOOQ5TCOBWGAZDSMBZGYYQ> . You are receiving this because you commented.Message ID: ***@***.***>

jruizvar added the kind/feature label Feb 24, 2021

jruizvar changed the title ~~Missing condition to express dependency between services~~ Missing condition service_completed_successfully Feb 25, 2021

jruizvar changed the title ~~Missing condition service_completed_successfully~~ Missing condition **service_completed_successfully** Feb 25, 2021

jruizvar changed the title Missing condition **service_completed_successfully** depends_on is missing condition service_completed_successfully Feb 25, 2021

jruizvar changed the title ~~depends_on is missing condition service_completed_successfully~~ Missing condition for "depends_on" Feb 25, 2021

jruizvar changed the title ~~Missing condition for "depends_on"~~ Missing condition for depends_on Feb 25, 2021

jruizvar changed the title ~~Missing condition for depends_on~~ Missing condition using depends_on Feb 25, 2021

jruizvar changed the title ~~Missing condition using depends_on~~ Missing condition indicating service_completed_successfully Feb 25, 2021

jruizvar changed the title ~~Missing condition indicating service_completed_successfully~~ Depends_on condition service_completed_successfully Feb 25, 2021

ndeloof closed this as completed Jun 17, 2021

Luap99 mentioned this issue Aug 27, 2021

Add support for depends_on condition type of "service_completed_successfully" containers/podman#11335

Closed

xjlin0 mentioned this issue Jan 16, 2022

Race condition causing celerybeat and celeryworker to fail cookiecutter/cookiecutter-django#2727

Closed

SbloodyS mentioned this issue Jan 17, 2022

[Feature-7993][E2E] Replace HDFS image with MinIO S3 image apache/dolphinscheduler#8066

Merged

baflo mentioned this issue Apr 3, 2022

Update Docker Compose (and Docker) client) portainer/portainer#6720

Closed

quartztester mentioned this issue Jul 9, 2022

FATAL: database "docker" does not exist LibrePhotos/librephotos-docker#59

Closed

jgehrcke mentioned this issue Nov 22, 2022

ci: docker-compose: rethink startup dependencies via condition service_healthy conbench/conbench#449

Closed

bjoernricks mentioned this issue Dec 16, 2022

Change: Update docker compose requirement to 1.29.0 greenbone/docs#231

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Depends_on condition service_completed_successfully #8154

Depends_on condition service_completed_successfully #8154

jruizvar commented Feb 24, 2021 •

edited

Loading

portiaove commented Mar 4, 2021 •

edited

Loading

ashishchandr70 commented Mar 12, 2021

peterroelants commented Mar 15, 2021

JakeUrban commented Apr 7, 2021 •

edited

Loading

devopscoder331 commented Apr 12, 2021 •

edited

Loading

peterroelants commented Apr 12, 2021

devopscoder331 commented Apr 12, 2021

jruizvar commented Apr 12, 2021

devopscoder331 commented Apr 12, 2021 •

edited

Loading

peterroelants commented Apr 12, 2021

aiordache commented Apr 12, 2021

peterroelants commented Apr 12, 2021

augustsaintfreytag commented Apr 27, 2021 •

edited

Loading

ndeloof commented Jun 17, 2021

rf-0 commented Jun 29, 2021

ndeloof commented Jun 30, 2021

snoseeds commented Jul 6, 2022

dolfinus commented Jul 19, 2022

zioalex commented Aug 27, 2023

ndeloof commented Aug 27, 2023

ramya-1000 commented Dec 2, 2023

ndeloof commented Dec 4, 2023

jhf commented Dec 9, 2023

ndeloof commented Dec 9, 2023

jhf commented Dec 18, 2023 •

edited

Loading

ndeloof commented Dec 18, 2023

jhf commented Dec 18, 2023

ramya-1000 commented Dec 19, 2023 via email

Depends_on condition service_completed_successfully #8154

Depends_on condition service_completed_successfully #8154

Comments

jruizvar commented Feb 24, 2021 • edited Loading

Description of the Issue

Environment

portiaove commented Mar 4, 2021 • edited Loading

ashishchandr70 commented Mar 12, 2021

peterroelants commented Mar 15, 2021

JakeUrban commented Apr 7, 2021 • edited Loading

devopscoder331 commented Apr 12, 2021 • edited Loading

peterroelants commented Apr 12, 2021

devopscoder331 commented Apr 12, 2021

jruizvar commented Apr 12, 2021

devopscoder331 commented Apr 12, 2021 • edited Loading

peterroelants commented Apr 12, 2021

aiordache commented Apr 12, 2021

peterroelants commented Apr 12, 2021

augustsaintfreytag commented Apr 27, 2021 • edited Loading

ndeloof commented Jun 17, 2021

rf-0 commented Jun 29, 2021

ndeloof commented Jun 30, 2021

snoseeds commented Jul 6, 2022

dolfinus commented Jul 19, 2022

zioalex commented Aug 27, 2023

ndeloof commented Aug 27, 2023

ramya-1000 commented Dec 2, 2023

ndeloof commented Dec 4, 2023

jhf commented Dec 9, 2023

ndeloof commented Dec 9, 2023

jhf commented Dec 18, 2023 • edited Loading

ndeloof commented Dec 18, 2023

jhf commented Dec 18, 2023

ramya-1000 commented Dec 19, 2023 via email

jruizvar commented Feb 24, 2021 •

edited

Loading

portiaove commented Mar 4, 2021 •

edited

Loading

JakeUrban commented Apr 7, 2021 •

edited

Loading

devopscoder331 commented Apr 12, 2021 •

edited

Loading

devopscoder331 commented Apr 12, 2021 •

edited

Loading

augustsaintfreytag commented Apr 27, 2021 •

edited

Loading

jhf commented Dec 18, 2023 •

edited

Loading