Skip to content

Commit

Permalink
Add compatibility list page for compose command
Browse files Browse the repository at this point in the history
Signed-off-by: Guillaume Tardif <[email protected]>
  • Loading branch information
gtardif committed Mar 5, 2021
1 parent c773cb8 commit 7bacff3
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 3 deletions.
2 changes: 1 addition & 1 deletion _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1187,7 +1187,7 @@ manuals:
- path: /compose/
title: Overview of Docker Compose
- path: /compose/cli-command/
title: Docker Compose in the Docker CLI
title: Compose command Tech Preview
- path: /compose/install/
title: Install Compose
- path: /compose/gettingstarted/
Expand Down
49 changes: 49 additions & 0 deletions compose/cli-command-compatibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
description: Docker Compose command compatibility with docker-compose
keywords: documentation, docs, docker, compose, containers
title: Docker Compose command compatibility with docker-compose
---

In the current state, the compose command in the Docker CLI supports most of the docker-compose commands and flags. It is expected to be a drop in replacement for docker-compose. However, there are a few remaining flags that have not been implemented yet. We are prioritizing the implementation of those based on usage metrics and user feedback.

You can follow progress on the implementation of the remaining commands and flags [here](https://github.com/docker/compose-cli/issues/1283){:target="_blank" rel="noopener" class="_"}.

If you see some compose functionality that is not available in the compose command, please [let us know](https://github.com/docker/compose-cli/issues){:target="_blank" rel="noopener" class="_"} so we can prioritize it.

## Commands or flags not yet implemented

The following commands have not been implemented yet, and maybe implemented at a later time.
Please let us know if these commands are a higher priority for your usecases.

* `compose build --memory`
* `compose build --no-cache`
* `compose config --no-interpolate`
* `compose config --services`
* `compose config --volumes`
* `compose config --hash`
* `compose events`
* `compose images`
* `compose port`
* `compose pull --ignore-pull-failures`
* `compose push --ignore-push-failures`
* `compose run --service-ports`

## Flags that will not be implemented

The list below includes the flags that we are not planning to support in Compose in Docker CLI,
either because they are already deprecated in docker-compose, or because they are not relevant for the Compose in Docker CLI.

* `compose build --compress` Not relevant as commpose command is using buildkit by default.
* `compose build --force-rm` Not relevant as commpose command is using buildkit by default.
* `compose build --no-rm` Not relevant as commpose command is using buildkit by default.
* `compose build --parallel` Not relevant as commpose command is using buildkit by default.
* `compose ps --filter KEY-VALUE` Not relevant as cumbersome usage with the service command and not documented properly in docker-compose.
* `compose pull --parallel` Deprecated in docker-compose
* `compose pull --no-parallel` Deprecated in docker-compose
* `compose rm --all` Deprecated in docker-compose.
* `compose scale` Deprecated in docker-compose (use `compose up --scale` instead)

Global flags:

* `compose --no-ansi` Deprecated in docker-compose.
* `compose --compatibility` Deprecated in docker-compose.
6 changes: 4 additions & 2 deletions compose/cli-command.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Docker Compose in the Docker CLI
description: Compose in the Docker CLI Tech Preview
keywords: documentation, docs, docker, compose, containers
title: Docker Compose in the Docker CLI
title: Compose in the Docker CLI Tech Preview
---

The Docker CLI now supports the compose command to include (most of) the docker-compose features and flags in the Docker CLI, without the need for a separate tool.
Expand All @@ -10,3 +10,5 @@ You can just replace the dash with a space when you use docker-compose to just a

With the introduction of the [Compose specification](https://github.com/compose-spec/compose-spec){:target="_blank" rel="noopener" class="_"}, a clean distinction has been made between the Compose YAML file model and the docker-compose implementation. This made it possible to introduce [Amazon ECS](/cloud/ecs-integration) and [Microsoft ACI](/cloud/aci-integration) support in the Docker CLI so one can “up” a Compose application on cloud platforms just by switching Docker context. With this solid backbone in place, we have added compose in the Docker CLI as a first class command.
As the Compose specification evolves, new features will land in the Docker CLI faster. While docker-compose is still alive and will be maintained, Compose in the Docker CLI Go implementation relies directly on the compose-go bindings which are maintained as part of the specification. This will allow it to more quickly include community proposals, experimental implementations by the Docker CLI and/or Engine, and deliver features to end-users. Compose in the Docker CLI already supports some of the newer additions to the Compose specification: profiles and GPU devices.

You can check the [docker-compose compatibility list](cli-command-compatibility.md) for more details about flags that are not supported yet in the new compose command.

0 comments on commit 7bacff3

Please sign in to comment.