docker
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
5,360 Commits 22 Branches 282 Tags 52 MiB
Commit Graph

169 Commits

Author SHA1 Message Date
Nicolas De Loof 25671ae622 introduce config --variables to list compose model variables 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2024-03-22 13:51:30 +01:00
Sebastian Correa 0191e69d5b Fix docs on default build image name 
150fd4b8cf changed the default separator from _ to -, but the docker compose build docs still mention _.

Signed-off-by: Sebastian Correa <43179146+sebastian-correa@users.noreply.github.com>
 2024-03-22 13:42:13 +01:00
Nicolas De Loof 8ab8df86e0 introduce --watch 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2024-02-28 19:04:58 +01:00
Guillaume Lours d10a179f3e add support of QuietOption to create command 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2024-02-19 14:19:01 +01:00
David Karlsson b1c06770d4 docs: update cli reference link 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-15 08:20:11 +01:00
Piotr Dąbrowski e330f5905b
docs: unify no trailing dots in docstrings and help (#11301) 2024-02-14 14:02:37 -05:00
David Karlsson 053a560466 docs: update link to use canonical URL for command 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-19 11:38:14 +01:00
Guillaume Lours 7cdc7e15e3 remove watch command from the alpha command 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2024-01-18 10:14:43 +01:00
Wes Higbee 5f4b22ed7c make docs 
Signed-off-by: Wes Higbee <wes.mcclure@gmail.com>
 2024-01-08 17:21:26 -06:00
Nicolas De Loof e105f16527 introduce `stats` command 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-12-22 16:03:02 +01:00
Nicolas De Loof 17da54da20 introduce build --with-dependencies 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-12-20 15:58:54 +01:00
Milas Bowman 85a1aec123 regen docs 
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
 2023-12-05 18:08:38 +01:00
Milas Bowman 7c8ff36d78 move around OCI logic, auto fallback/retry 1.1 -> 1.0 
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
 2023-12-05 18:08:38 +01:00
Amit Saha 750553c866 introduce compose logs --index to select a replica container 
Signed-off-by: Amit Saha <asaha@atlassian.com>
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-11-29 13:56:16 +01:00
Amit Saha f9946127ce Fix docs 
Signed-off-by: Amit Saha <asaha@atlassian.com>
 2023-11-29 13:56:16 +01:00
Amit Saha e981c35863 Add failing test 
Signed-off-by: Amit Saha <asaha@atlassian.com>
 2023-11-29 13:56:16 +01:00
Nicolas De Loof 16c4241c0b log we don't expose service ports when --verbose 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-11-29 11:40:16 +01:00
Nicolas De Loof caa0cbbc4b
Introduce ps --orphans so user can include/exclude services not declared by project 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-11-23 13:43:49 +01:00
Nicolas De Loof 2945532f97 fix --pull documentation 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-11-07 09:03:49 +01:00
Nicolas De Loof 6727908803 introduce --resolve-image-digests for publish to seal service images by digest 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-11-02 10:43:45 +01:00
aevesdocker 4cd61957ed fix build 
Signed-off-by: aevesdocker <allie.sadler@docker.com>
 2023-10-31 10:50:42 +00:00
aevesdocker 0d4cbbdbc9 fix 
Signed-off-by: aevesdocker <allie.sadler@docker.com>
 2023-10-31 10:44:59 +00:00
aevesdocker 9631a49daa ENGDOCS-1764 
Signed-off-by: aevesdocker <allie.sadler@docker.com>
 2023-10-31 10:40:48 +00:00
Nicolas De Loof 44d21280e7 truncate command by default, introduce --no-trunc flag to get the full command 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-09-23 06:34:26 +02:00
Guillaume Lours 6be5f3003a move watch from alpha to main command 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-09-20 18:55:08 +02:00
Nicolas De Loof a697a0690a introduce pull --missing flag to only pull images not present in cache 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-09-15 08:41:27 +02:00
Guillaume Lours 1a98a70b8a add scale command 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-09-13 11:15:14 +02:00
Milas Bowman d7b0b2bd7d
watch: build & launch the project at start (#10957) 
The `alpha watch` command current "attaches" to an already-running
Compose project, so it's necessary to run something like
`docker compose up --wait` first.

Now, we'll do the equivalent of an `up --build` before starting the
watch, so that we know the project is up-to-date and running.

Additionally, unlike an interactive `up`, the services are not stopped
when `watch` exits (e.g. via `Ctrl-C`). This prevents the need to start
from scratch each time the command is run - if some services are already
running and up-to-date, they can be used as-is. A `down` can always be
used to destroy everything, and we can consider introducing a flag like
`--down-on-exit` to `watch` or changing the default.

Signed-off-by: Milas Bowman <milas.bowman@docker.com>
 2023-09-07 13:27:23 -04:00
Nicolas De Loof c9d54f09cf introduce publish (alpha) command 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-09-07 07:27:32 +02:00
Nicolas De Loof 1054792b47 align docker compose ps with docker CLI to support --format 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-08-25 16:36:45 +02:00
Milas Bowman caad72713b 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-18 12:38:38 +02:00
Milas Bowman baea5a48f5 deps: bump docker/cli-docs-tool to v0.6.0 
Required re-running `make docs` to pick up changes.

Signed-off-by: Milas Bowman <milas.bowman@docker.com>
 2023-07-10 12:23:48 +02:00
Nicolas De Loof b0af2deb2b when --index is not set select first service container 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-07-07 14:08:24 +02:00
Guillaume Lours 28301fb1a4 add support of --builder and BUILDX_BUILDER 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-07-03 10:11:18 +02:00
Ulysses Souza edd76bfd70 Add `docker compose wait` 
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
 2023-06-30 16:07:03 +02:00
aroramrinaal 3906a7a67c Updated documentation files for my contribution 
Ran 'make docs' to generate updated doc files from the reference.

Signed-off-by: aroramrinaal <aroramrinaal@gmail.com>
 2023-06-27 22:48:17 +02:00
aroramrinaal 83671db3dd Fix capitalization error in sentence by adding an uppercase letter at beginning 
Signed-off-by: aroramrinaal <aroramrinaal@gmail.com>
 2023-06-27 22:48:17 +02:00
Nicolas De Loof c61b8aa5ac introduce run --cap-add to run maintenance commands using service image 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-06-19 14:20:20 +02:00
Nicolas De Loof cfe91becc7 use `--progress` to configure progress UI stylet push 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-06-12 16:53:42 +02:00
robbert-ef 68bd0eb523
cli: fix timeout behavior on up / restart / stop (#10672) 
Do not set a hardcoded default timeout of 10 seconds when restarting / stopping but use the container `StopTimeout` (defaults to 10 seconds).

Also fixed custom timeout not used when invoking `up`.

Signed-off-by: Robbert Segeren <robbert.segeren@easyflex.nl>
 2023-06-12 09:18:25 -04:00
Allie Sadler 65b714c108 fix build issue 
Signed-off-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
 2023-05-31 10:24:49 +01:00
Allie Sadler 44dd232e97
Merge branch 'v2' into ENGDOCS-1373 2023-05-31 10:18:45 +01:00
Guillaume Lours 15cad92b61 fix display of volumes flag in down help command 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-05-24 22:11:58 +02:00
Nicolas De Loof 93bd27a0cc introduce ability to select service to be stopped by `compose down` 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-05-24 17:32:32 +02:00
Allie Sadler 1e399c271a update docs to reflect dry run mode is feature complete 
Signed-off-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
 2023-05-23 15:53:48 +01:00
Nicolas De Loof 9b5a4588f9 introduce --no-path-resolution to skip relative path to be resolved 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-05-16 13:02:56 +02:00
Guillaume Lours 312f0d1d61 Update dry-run documentation 
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-05-15 09:39:46 +02:00
Guillaume Lours e8caad1903 move dry-run support from alpha to main command 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-05-15 09:39:46 +02:00
Nicolas De loof 0e375a8c61
restore long description to be included in `docker compose help` (#10504) 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-05-11 12:33:45 -04:00
Nicolas De Loof d01ef5887a restore support for `--memory` 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-04-25 15:41:08 +02:00
Benjamín Guzmán 3751c3074b Added docs 
Signed-off-by: Benjamín Guzmán <bg@benjaminguzman.dev>
 2023-04-24 12:18:37 +02:00
Nicolas De Loof a10c4c6df5
restore `--timeout` flag renamed by mistake 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-04-04 08:48:00 +02:00
Guillaume Lours 6bedc196cc update -p project name flag documentation 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-03-22 10:53:54 +01:00
Nicolas De Loof e831ea826b add support for `restart` for `depends_on` 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-02-18 12:55:29 +01:00
Nicolas De Loof 9ac0392baf introduce --timeout on `up` 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-02-14 12:16:41 +01:00
Nicolas De Loof 0612b34c68 introduce --no-deps on restart 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-02-14 11:30:15 +01:00
Nicolas De Loof 41e056341b rename `convert` to `config` to align with compose v1 UX 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-01-30 22:23:53 +01:00
Laura Brehm 69c0a583be
Merge pull request #10208 from laurazard/add-scale-create 2023-01-27 15:26:01 +01:00
maxcleme 634a7d2a7b Support for docker compose build --push when using multiple platforms 
Signed-off-by: maxcleme <maxime.clement@docker.com>
 2023-01-26 16:54:41 +01:00
Laura Brehm a288332fbd
Update docs to add `--scale` argument to `compose create` 
Signed-off-by: Laura Brehm <laurabrehm@hey.com>
 2023-01-26 13:03:49 +01:00
Nicolas De Loof 33c3f4dfad
alias -n for --tail to align with docker CLI 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-01-26 10:00:58 +01:00
Laura Brehm d47f0f31c2 Update docs to mention `COMPOSE_PARALLEL_LIMITS` and ways to configure parallelism 
Signed-off-by: Laura Brehm <laurabrehm@hey.com>
 2023-01-24 17:01:15 +01:00
Nicolas De Loof 4721c01702 fix docs to reflect docker compose ps being aligned with docker ps 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-01-24 11:11:20 +01:00
Guillaume Lours eb59b0e265 add alpha command to test dry-run 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-01-16 11:11:35 +01:00
Guillaume Lours 5081ab0507 create custom CLI when dry-run mode active 
update documentation

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-01-16 11:11:35 +01:00
Guillaume Lours fbf845c5f8 add dry-run flag 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-01-16 11:11:35 +01:00
Nicolas De Loof 8c07fa4d25 mark alpha command as experimental 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-01-12 14:44:18 +01:00
Nicolas De Loof bb9cf32245 introduce experimental watch command (skeletton) 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-01-12 10:52:58 +01:00
Matt Armand dadad01e63 Update docs programatically like you're supposed to 
Signed-off-by: Matt Armand <marmand68@gmail.com>
 2023-01-11 13:20:30 -05:00
Matt Armand 1adc9f54d5 fix docs yaml 
Signed-off-by: Matt Armand <marmand68@gmail.com>
 2023-01-11 12:24:15 -05:00
Matt Armand bd8e57447a Add remove-orphans functionality to run, because it recommends that in error messages 
Signed-off-by: Matt Armand <marmand68@gmail.com>
 2023-01-11 10:31:56 -05:00
Nicolas De Loof cc912c625d introduce --remove-orphans in compose create command 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-01-11 07:16:50 +01:00
Nicolas De Loof d5e4f00644 introduce --no-attach to ignore some service output 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-01-03 18:43:40 +01:00
Nicolas De Loof 8b4ac37f9c introduce `--ignore-buildable` to ignore buildable images on pull 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-01-03 18:43:23 +01:00
Laura Brehm 8a3248d0cd
Update documentation 
Signed-off-by: Laura Brehm <laurabrehm@hey.com>
 2022-12-29 13:32:16 +00:00
Nicolas De Loof 84ea395d5d introduce --timestamp option on compose up 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2022-12-15 12:14:22 +01:00
Gabriel Féron e4850d9c48 Add --include-deps to push command 
Signed-off-by: Gabriel Féron <g@leirbag.net>
 2022-12-15 11:42:14 +01:00
Nicolas De Loof 8c39b5b7fd align `--format` flag and UX with docker cli 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2022-12-14 22:53:43 +01:00
Nicolas De Loof a0acc20d88
introduce --parallel to limit concurrent engine calls 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2022-12-06 08:15:50 +01:00
Umar Faruq Chowdhury 06e71371ff
docs: fix grammatical issues (#9997) 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
Co-authored-by: Milas Bowman <milasb@gmail.com>
 2022-11-29 10:52:22 -05:00
Laura Brehm 88c3aaf1bf
Merge pull request #10007 from laurazard/add-build-run 
Add `--build` to `compose run`
 2022-11-17 20:00:57 +01:00
Laura Brehm 6fe03e935e
Update docs 
Signed-off-by: Laura Brehm <laurabrehm@hey.com>
 2022-11-17 12:29:19 +01:00
Guillaume Lours 32f29b833f add --no-consistency flag to convert command 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2022-11-15 10:31:59 +01:00
Nick Sieger 8bd487ac43
docs: update with result of `make docs` 
Signed-off-by: Nick Sieger <nick@nicksieger.com>
 2022-10-11 15:19:24 -05:00
Laura Brehm a226fe9daf
Update docs for new `compose kill` `--remove-orphans` option 
Signed-off-by: Laura Brehm <laurabrehm@hey.com>
 2022-08-19 04:29:51 +02:00
Khoa Le 8d4846f210
docs: remove extra whitespaces in help text (#9710) 
Remove superfluous whitespaces

Signed-off-by: Khoa Le <ltkhoa2711@gmail.com>
 2022-08-03 16:37:15 -04:00
Sebastiaan van Stijn 9db79856be
update usage strings for consistency 
This updates the format of various usage strings to be more consistent
with other parts of the CLI.

- Use `[OPTIONS]` to indicate where command-specific options should be added
- Use `[SERVICE...]` to indicate zero-or-more services
- Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that
  option is part of the already mentioned `[OPTIONS]` and we don't provide usage
  for each possible option that can be passed.
- Remove `[--]`, which (I think) was needed for the Python implementation, but is
  a general feature to stop processing flag-options.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-08-02 13:32:29 +02:00
Pierre Roux 38a18790ed
cmd: consistent handling no-args commands (#9660) 
Enforce args rejection for commands without args:
* ls
* version

Additionally, docs for `restart` are fixed.

Signed-off-by: piroux <pierre.roux01@gmail.com>
 2022-07-29 09:30:11 -04:00
Guillaume Lours e83d940a3c
add pull & build config to project before create 
add pull flag to create and up documentation

Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-07-27 11:25:53 +02:00
Guillaume Lours 0e6adb2884
update cli-doc-tool and update the doc with this new version 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-07-26 14:58:08 +02:00
Emmanuel Nuiro f06ab29a84 Fix typo in docker_compose_pull 
Signed-off-by: Emmanuel Nuiro <emmanuel@nuiro.me>
 2022-07-04 22:29:06 +02:00
Emmanuel Nuiro 7f5c166ec9 Fix typo in compose pull documentation 
There was an invalid character between the two backticks at the end of the last snippet, causing the styling to break on the online documentation.

Signed-off-by: Emmanuel Nuiro <emmanuel@nuiro.me>
 2022-07-04 21:45:53 +02:00
Guillaume Lours 6d9d75406c update usage of the index flag of the cp command 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-05-10 10:50:40 +02:00
Guillaume Lours a983cf551d cp command: copy to all containers of a service as default behaviour 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-05-10 10:50:40 +02:00
Daniel Lublin d89c143c39 Clarify what default work dir is when multiple compose files 
Signed-off-by: Daniel Lublin <daniel@lublin.se>
 2022-05-03 13:14:34 +02:00
Eric Freese d871cb98e5 Fix search/replace typo in --no-TTY documentation 
Commit abbba74b27 looks to have
accidentally replaced `pseudo-tty` with `pseudo-noTty` in several
places. In other places, it looks like it replaced `pseudo-tty` with
`pseudo-TTY`, so I used the uppercased version in these places as well.

For example, running version 2.3.3, I get this output:

```
% docker-compose run --help

...

Options:
  ...
  -T, --no-TTY                Disable pseudo-noTty allocation. By default docker compose run allocates a TTY
  ...
```

Signed-off-by: Eric Freese <ericdfreese@gmail.com>
 2022-04-04 19:06:03 +02:00
Matthias Schoettle 6dbd6ffe11 fix typo in ssh option description 
Signed-off-by: Matthias Schoettle <git@mattsch.com>
 2022-03-31 10:14:13 -04:00
Guillaume Lours ff73827a6f Add support of ssh authentications defined in compose file or via cli flags 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-03-31 12:47:15 +02:00
Guillaume Lours 099715fb6f update run no-TTY flag description as auto-detected by default 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-03-18 10:42:05 +01:00
Guillaume Lours 35ba6f68e5 generate reference api 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-03-18 10:42:05 +01:00