2021-03-08 15:47:24 +01:00
|
|
|
|
command: docker compose up
|
|
|
|
|
|
short: Create and start containers
|
2021-09-13 17:41:21 +02:00
|
|
|
|
long: |-
|
2022-07-26 14:58:08 +02:00
|
|
|
|
Builds, (re)creates, starts, and attaches to containers for a service.
|
2021-09-13 17:41:21 +02:00
|
|
|
|
|
2022-07-26 14:58:08 +02:00
|
|
|
|
Unless they are already running, this command also starts any linked services.
|
2021-09-13 17:41:21 +02:00
|
|
|
|
|
2022-07-26 14:58:08 +02:00
|
|
|
|
The `docker compose up` command aggregates the output of each container (like `docker compose logs --follow` does).
|
2023-01-03 15:35:24 +01:00
|
|
|
|
One can optionally select a subset of services to attach to using `--attach` flag, or exclude some services using
|
|
|
|
|
|
`--no-attach` to prevent output to be flooded by some verbose services.
|
|
|
|
|
|
|
2022-07-26 14:58:08 +02:00
|
|
|
|
When the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the
|
|
|
|
|
|
background and leaves them running.
|
2021-09-13 17:41:21 +02:00
|
|
|
|
|
2022-07-26 14:58:08 +02:00
|
|
|
|
If there are existing containers for a service, and the service’s configuration or image was changed after the
|
|
|
|
|
|
container’s creation, `docker compose up` picks up the changes by stopping and recreating the containers
|
|
|
|
|
|
(preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag.
|
2021-09-13 17:41:21 +02:00
|
|
|
|
|
2022-07-26 14:58:08 +02:00
|
|
|
|
If you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag.
|
2021-09-13 17:41:21 +02:00
|
|
|
|
|
2022-07-26 14:58:08 +02:00
|
|
|
|
If the process encounters an error, the exit code for this command is `1`.
|
|
|
|
|
|
If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`.
|
2022-08-02 13:11:57 +02:00
|
|
|
|
usage: docker compose up [OPTIONS] [SERVICE...]
|
2021-03-08 15:47:24 +01:00
|
|
|
|
pname: docker compose
|
|
|
|
|
|
plink: docker_compose.yaml
|
|
|
|
|
|
options:
|
2022-07-26 14:58:08 +02:00
|
|
|
|
- option: abort-on-container-exit
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: |
|
|
|
|
|
|
Stops all containers if any container was stopped. Incompatible with -d
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: always-recreate-deps
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Recreate dependent containers. Incompatible with --no-recreate.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: attach
|
|
|
|
|
|
value_type: stringArray
|
|
|
|
|
|
default_value: '[]'
|
up: handle various attach use cases better
By default, `compose up` attaches to all services (i.e.
shows log output from every associated container). If
a service is specified, e.g. `compose up foo`, then
only `foo`'s logs are tailed. The `--attach-dependencies`
flag can also be used, so that if `foo` depended upon
`bar`, then `bar`'s logs would also be followed. It's
also possible to use `--no-attach` to filter out one
or more services explicitly, e.g. `compose up --no-attach=noisy`
would launch all services, including `noisy`, and would
show log output from every service _except_ `noisy`.
Lastly, it's possible to use `up --attach` to explicitly
restrict to a subset of services (or their dependencies).
How these flags interact with each other is also worth
thinking through.
There were a few different connected issues here, but
the primary issue was that running `compose up foo` was
always attaching dependencies regardless of `--attach-dependencies`.
The filtering logic here has been updated so that it
behaves predictably both when launching all services
(`compose up`) or a subset (`compose up foo`) as well
as various flag combinations on top of those.
Notably, this required making some changes to how it
watches containers. The logic here between attaching
for logs and monitoring for lifecycle changes is
tightly coupled, so some changes were needed to ensure
that the full set of services being `up`'d are _watched_
and the subset that should have logs shown are _attached_.
(This does mean faking the attach with an event but not
actually doing it.)
While handling that, I adjusted the context lifetimes
here, which improves error handling that gets shown to
the user and should help avoid potential leaks by getting
rid of a `context.Background()`.
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
2023-08-17 23:43:13 +02:00
|
|
|
|
description: |
|
|
|
|
|
|
Restrict attaching to the specified services. Incompatible with --attach-dependencies.
|
2022-07-26 14:58:08 +02:00
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: attach-dependencies
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
up: handle various attach use cases better
By default, `compose up` attaches to all services (i.e.
shows log output from every associated container). If
a service is specified, e.g. `compose up foo`, then
only `foo`'s logs are tailed. The `--attach-dependencies`
flag can also be used, so that if `foo` depended upon
`bar`, then `bar`'s logs would also be followed. It's
also possible to use `--no-attach` to filter out one
or more services explicitly, e.g. `compose up --no-attach=noisy`
would launch all services, including `noisy`, and would
show log output from every service _except_ `noisy`.
Lastly, it's possible to use `up --attach` to explicitly
restrict to a subset of services (or their dependencies).
How these flags interact with each other is also worth
thinking through.
There were a few different connected issues here, but
the primary issue was that running `compose up foo` was
always attaching dependencies regardless of `--attach-dependencies`.
The filtering logic here has been updated so that it
behaves predictably both when launching all services
(`compose up`) or a subset (`compose up foo`) as well
as various flag combinations on top of those.
Notably, this required making some changes to how it
watches containers. The logic here between attaching
for logs and monitoring for lifecycle changes is
tightly coupled, so some changes were needed to ensure
that the full set of services being `up`'d are _watched_
and the subset that should have logs shown are _attached_.
(This does mean faking the attach with an event but not
actually doing it.)
While handling that, I adjusted the context lifetimes
here, which improves error handling that gets shown to
the user and should help avoid potential leaks by getting
rid of a `context.Background()`.
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
2023-08-17 23:43:13 +02:00
|
|
|
|
description: Automatically attach to log output of dependent services.
|
2022-07-26 14:58:08 +02:00
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: build
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Build images before starting containers.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: detach
|
|
|
|
|
|
shorthand: d
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: 'Detached mode: Run containers in the background'
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: exit-code-from
|
|
|
|
|
|
value_type: string
|
|
|
|
|
|
description: |
|
|
|
|
|
|
Return the exit code of the selected service container. Implies --abort-on-container-exit
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: force-recreate
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: |
|
|
|
|
|
|
Recreate containers even if their configuration and image haven't changed.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2023-01-03 15:35:24 +01:00
|
|
|
|
- option: no-attach
|
|
|
|
|
|
value_type: stringArray
|
|
|
|
|
|
default_value: '[]'
|
up: handle various attach use cases better
By default, `compose up` attaches to all services (i.e.
shows log output from every associated container). If
a service is specified, e.g. `compose up foo`, then
only `foo`'s logs are tailed. The `--attach-dependencies`
flag can also be used, so that if `foo` depended upon
`bar`, then `bar`'s logs would also be followed. It's
also possible to use `--no-attach` to filter out one
or more services explicitly, e.g. `compose up --no-attach=noisy`
would launch all services, including `noisy`, and would
show log output from every service _except_ `noisy`.
Lastly, it's possible to use `up --attach` to explicitly
restrict to a subset of services (or their dependencies).
How these flags interact with each other is also worth
thinking through.
There were a few different connected issues here, but
the primary issue was that running `compose up foo` was
always attaching dependencies regardless of `--attach-dependencies`.
The filtering logic here has been updated so that it
behaves predictably both when launching all services
(`compose up`) or a subset (`compose up foo`) as well
as various flag combinations on top of those.
Notably, this required making some changes to how it
watches containers. The logic here between attaching
for logs and monitoring for lifecycle changes is
tightly coupled, so some changes were needed to ensure
that the full set of services being `up`'d are _watched_
and the subset that should have logs shown are _attached_.
(This does mean faking the attach with an event but not
actually doing it.)
While handling that, I adjusted the context lifetimes
here, which improves error handling that gets shown to
the user and should help avoid potential leaks by getting
rid of a `context.Background()`.
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
2023-08-17 23:43:13 +02:00
|
|
|
|
description: Do not attach (stream logs) to the specified services.
|
2023-01-03 15:35:24 +01:00
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2022-07-26 14:58:08 +02:00
|
|
|
|
- option: no-build
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
2023-09-07 16:36:22 +02:00
|
|
|
|
description: Don't build an image, even if it's policy.
|
2022-07-26 14:58:08 +02:00
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: no-color
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Produce monochrome output.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: no-deps
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Don't start linked services.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: no-log-prefix
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Don't print prefix in logs.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: no-recreate
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: |
|
|
|
|
|
|
If containers already exist, don't recreate them. Incompatible with --force-recreate.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: no-start
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Don't start the services after creating them.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2022-07-27 11:25:53 +02:00
|
|
|
|
- option: pull
|
|
|
|
|
|
value_type: string
|
2023-09-07 16:36:22 +02:00
|
|
|
|
default_value: policy
|
2023-11-07 08:21:19 +01:00
|
|
|
|
description: Pull image before running ("always"|"missing"|"never")
|
2022-07-27 11:25:53 +02:00
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2022-07-26 14:58:08 +02:00
|
|
|
|
- option: quiet-pull
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Pull without printing progress information.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: remove-orphans
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Remove containers for services not defined in the Compose file.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: renew-anon-volumes
|
|
|
|
|
|
shorthand: V
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: |
|
|
|
|
|
|
Recreate anonymous volumes instead of retrieving data from the previous containers.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
- option: scale
|
|
|
|
|
|
value_type: stringArray
|
|
|
|
|
|
default_value: '[]'
|
|
|
|
|
|
description: |
|
|
|
|
|
|
Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2023-04-04 08:12:14 +02:00
|
|
|
|
- option: timeout
|
|
|
|
|
|
shorthand: t
|
|
|
|
|
|
value_type: int
|
2023-06-12 15:18:25 +02:00
|
|
|
|
default_value: "0"
|
2023-04-04 08:12:14 +02:00
|
|
|
|
description: |
|
|
|
|
|
|
Use this timeout in seconds for container shutdown when attached or when containers are already running.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2022-12-13 19:01:08 +01:00
|
|
|
|
- option: timestamps
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Show timestamps.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2022-07-26 14:58:08 +02:00
|
|
|
|
- option: wait
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Wait for services to be running|healthy. Implies detached mode.
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2023-02-13 17:42:11 +01:00
|
|
|
|
- option: wait-timeout
|
|
|
|
|
|
value_type: int
|
|
|
|
|
|
default_value: "0"
|
up: handle various attach use cases better
By default, `compose up` attaches to all services (i.e.
shows log output from every associated container). If
a service is specified, e.g. `compose up foo`, then
only `foo`'s logs are tailed. The `--attach-dependencies`
flag can also be used, so that if `foo` depended upon
`bar`, then `bar`'s logs would also be followed. It's
also possible to use `--no-attach` to filter out one
or more services explicitly, e.g. `compose up --no-attach=noisy`
would launch all services, including `noisy`, and would
show log output from every service _except_ `noisy`.
Lastly, it's possible to use `up --attach` to explicitly
restrict to a subset of services (or their dependencies).
How these flags interact with each other is also worth
thinking through.
There were a few different connected issues here, but
the primary issue was that running `compose up foo` was
always attaching dependencies regardless of `--attach-dependencies`.
The filtering logic here has been updated so that it
behaves predictably both when launching all services
(`compose up`) or a subset (`compose up foo`) as well
as various flag combinations on top of those.
Notably, this required making some changes to how it
watches containers. The logic here between attaching
for logs and monitoring for lifecycle changes is
tightly coupled, so some changes were needed to ensure
that the full set of services being `up`'d are _watched_
and the subset that should have logs shown are _attached_.
(This does mean faking the attach with an event but not
actually doing it.)
While handling that, I adjusted the context lifetimes
here, which improves error handling that gets shown to
the user and should help avoid potential leaks by getting
rid of a `context.Background()`.
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
2023-08-17 23:43:13 +02:00
|
|
|
|
description: Maximum duration to wait for the project to be running|healthy.
|
2023-02-13 17:42:11 +01:00
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2023-05-05 12:43:27 +02:00
|
|
|
|
inherited_options:
|
|
|
|
|
|
- option: dry-run
|
|
|
|
|
|
value_type: bool
|
|
|
|
|
|
default_value: "false"
|
|
|
|
|
|
description: Execute command in dry run mode
|
|
|
|
|
|
deprecated: false
|
|
|
|
|
|
hidden: false
|
|
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
2021-03-08 15:47:24 +01:00
|
|
|
|
deprecated: false
|
2023-07-07 14:27:14 +02:00
|
|
|
|
hidden: false
|
2021-03-08 15:47:24 +01:00
|
|
|
|
experimental: false
|
|
|
|
|
|
experimentalcli: false
|
|
|
|
|
|
kubernetes: false
|
|
|
|
|
|
swarm: false
|
|
|
|
|
|
|
