tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
4,806 Commits 25 Branches 264 Tags 67 MiB
Commit Graph

128 Commits

Author SHA1 Message Date
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
Sebastiaan van Stijn 2d32d7450c ps: un-deprecate --filter, and enhance docs 
Compose currently only supports a single filter options on --filter,
for which reason the --status flag was added, which is more convenient
to use.

However, the `--filter` flag is common among various docker commands, and
it's possible that additional filters get added at some point (which may
be less "commonly" used, and not warrant a dedicated flag).

This PR removes the "deprecated" mention from the flag, to keep consistency
with other commands, but adds documentation to explain how they relate to
eachother.

Also added a short example for the `--format` flag.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-10 20:39:19 +01:00
Sebastiaan van Stijn 42710b7c43 docs: also generate "usage" in MarkDown files 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-09 14:40:35 +01:00
Sebastiaan van Stijn b9b3a3d91f docs: update cli-docs-tool to v0.4.0 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-09 14:40:35 +01:00
Sebastiaan van Stijn 1d06741032 docs: fix trailing whitespace from markdown and regenerate 
Trailing whitespace in Markdown can force line-breaks, which doesn't seem to
be the intent on these;

    find . -type f -print0 | xargs -0 perl -pi -e 's/ +$//'

The trailing whitespace also can cause the YAML to go wonky (although the
cli-docs-tool now takes that into account), and caused the "examples" section
to be missed in the `docker compose pull` page (something we should fix in
the tool).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-09 14:40:35 +01:00
Sebastiaan van Stijn 35b790dcdf docs: fix "source" path for YAML generator, and regenerate 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-09 14:40:35 +01:00
Zixuan James Li fcff39631a Add documentation for COMPOSE_IGNORE_ORPHANS 
Signed-off-by: Zixuan James Li <359101898@qq.com>
 2022-03-05 22:54:16 +01:00
Dan Bámíkíyá 336b825fdd Fix the typo in the corresponding Yaml file also 
Signed-off-by: Dan Bámíkíyá <dudeawesome732@gmail.com>
 2022-02-11 15:10:08 +01:00
Dan Bámíkíyá 213d9166dc Fix typo in reference/compose_up 
Signed-off-by: Dan Bámíkíyá <dudeawesome732@gmail.com>
 2022-02-11 15:08:33 +01:00
Sebastiaan van Stijn 0b896c69ce [v2] docs: fix stray backtick, and add compose_version yaml 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-14 07:49:29 +02:00
Sebastiaan van Stijn 3678deed14 [v2] use "docker/cli-docs-tool" to generate docs 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-13 21:54:26 +02:00
Sebastiaan van Stijn fdc362bf55 [v2] docs: markdown and link fixes 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-13 21:54:26 +02:00
Sebastiaan van Stijn 1c01e9d00f [v2] docs: regenerate yaml docs 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-13 21:54:26 +02:00
Manu 90a879fa3f Fix references to docker-compose command 
Signed-off-by: Manuel Grabowski <git@manuelgrabowski.de>
 2021-06-28 16:45:44 +02:00
Nicolas De Loof abbba74b27
update reference docs 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2021-06-08 09:39:49 +02:00
Guillaume Tardif d61e62563e Update compose docs 
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
 2021-05-05 17:37:08 +02:00
Guillaume Tardif e0344ea7b4
Merge pull request #1415 from ulyssessouza/add-restart 
Add restart command
 2021-03-19 15:04:57 +01:00
Nicolas De Loof 3271801681
reference documentation 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2021-03-17 09:11:23 +01:00
Ulysses Souza 2fdc3bad48 Add restart command 
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
 2021-03-16 02:02:36 -03:00
Nicolas De Loof 59d4382f3c
generate reference documentation 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2021-03-09 13:44:13 +01:00