Libcompose 1.0.0 <-> Compose 1.6.0 features

[vdemeester]

I've tried to come up with a feature grid / missing feature recap' in order to know what to do to achieve a complete compatibility with docker-compose ; and thus making it easy to follow afterwards.

The goal of this issue is to keep track of what is done and what's not. As it might be a little big, we'll probably split this up into small issues for each missing part.

I've created a 1.0.0 milestone (with a cool name I think 😝) to start having some goals and helping us to focus. I also want to follow the releases of the other docker projects (but that's another story).

Anyway, this is what I've got so far. Note there is some stuff that are present in libcompose but not in docker-compose.

ping @docker/libcompose-maintainers @ibuildthecloud @imikushin for feedback.
I probably missed some stuff so, let me know 😉.

---

Composefile

Reference (v1)

• build
• cap_add, cap_drop
• command
• cgroup_parent Add support for missing composefile keys #134 (PR)
• container_name
• devices
• dns
• dns_search
• dockerfile
• env_file
• environment
• expose
• extends
• external_links
• extra_hosts
• image
• labels
• links
• log_driver
• log_opt
• net
• pid
• ports
• security_opt
• ulimits Add support for missing composefile keys #134 (PR)
• volumes, volume_driver
• volumes_from
• cpu_shares
• cpu_quota Add support for missing composefile keys #134 (PR)
• cpuset
• domainname
• entrypoint
• hostname
• ipc
• mac_address Add support for missing composefile keys #134 (PR)
• mem_limit
• memswap_limit
• privileged
• read_only
• restart
• stdin_open
• tty
• user
• working_dir
• uts not supported in docker-compose ?

Reference (v2)

To support 👼

CLI

Commands & flags

Commands

• build
  • --no-cache
  • --pull
  • --force-rm
• config
  • -q, --quiet
  • --services
• create
  • --force-recreate Add flags for create command #135
  • --no-recreate Add flags for create command #135
  • --no-build Add support for --no-build #136
• down (currently an alias to stop)
  • see docker-compose down docker-compose down compose#2646
• help
  • Some help are not working properly (e.g. libcompose-cli help build) — carry Two improvements for command help #102.
• kill
  • -s SIGNAL (libcompose-cli supports --signal)
• logs
  • --no-color
  • --lines support by libcompose-cli but not by docker-compose
• pause Implement pause/unpause commands #128 (PR)
• port
  • --protocol=proto
  • --index=index
• ps
  • -q
• pull
  • --ignore-pull-failures
  • --allow-insecure-ssl deprecated, won't add.
• restart
  • -t, --timeout TIMEOUT
• rm The rm command always require --force #129 (issue), Fixing rm command and API… #130 (PR)
  • -f, --force
  • -v
• run Allow running command #38 (issue), add run command #45 Implement run command #133 (PR)
  • --allow-insecure-ssl deprecated, won't add.
  • -d
  • --name NAME
  • --entrypoint CMD
  • -e KEY=VAL
  • -u, --user=""
  • --no-deps
  • --rm
  • -p, --publish=[]
  • --service-ports
  • -T
• scale
  • -t, --timeout TIMEOUT
• start
  • -d support by libcompose-cli but not by docker-compose
• stop
  • -t, --timeout TIMEOUT
• unpause Implement pause/unpause commands #128 (PR)
• up
  • --allow-insecure-ssl deprecated, won't add.
  • -d
  • --no-color
  • --no-deps
  • --force-recreate
  • --no-recreate
  • --no-build Add support for --no-build #136
  • -t, --timeout TIMEOUT
• migrate-to-labels: to implement ?
• version
  • --short

Global flags

• -f, --file FILE
• -p, --project-name NAME
• --x-networking
• --x-network-driver
• --verbose is also --debug on libcompose-cli
• -v, --version
• TLS related flags (--tls, --tlsverify, --tlscacert,
  --tlscert, --tlskey) : how it is handled in docker-compose (compose#1569)
• --configdir
• --help, -h should move to help only ?
• --version, -v should move to version only

Environment Variables

• COMPOSE_PROJECT_NAME
• COMPOSE_FILE
• COMPOSE_API_VERSION
• DOCKER_* (DOCKER_HOST, DOCKER_TLS_VERIFY,
  DOCKER_CERT_PATH, COMPOSE_HTTP_TIMEOUT)

Miscellaneous

• yaml schema validation Strict yaml validation? #34 (issue) and Strict yaml validation #99 (PR)
• Refactor flag system (switch to cobra or …) ?
• completion support ? (probably re-use docker-compose one but…)
• docker-compose up -d then libcompose-cli ps doesn't work >_<, see issue libcompose{,-cli}/docker-compose "commutable" #132
• What to do about the warn message
• not allow restart: no but require restart: 'no' Compose 1.5+ will not allow restart: no but require restart: 'no' #72
• multiple file (-f and docker-compose.override.yml) Multiple -f #116
• Preserve volume data when containers are created
• Only recreate containers that have changed
• Variables and moving a composition between environments
• Support multiple version of compose.yml (with key version: 2), see Add support for declaring named volumes in compose files compose#2421

Maybe

Those are in discussion / review on docker-compose so as long as they are not merged or completely sure to get in 1.6.0, it probably shouldn't be in 1.0.0 of libcompose. I'll create issues to track them down.

• Epic: Backwards-incompatible changes to the Compose file format Epic: Backwards-incompatible changes to the Compose file format compose#2504
  • Proposal: Make net and volumes_from's container/service support explicit Proposal: Make net and volumes_from's container/service support explicit compose#2501
  • Move logging configuration under logging key Move logging configuration under logging key compose#2503
  • Proposal: new build config section Proposal: new build config section compose#2163
  • Image and build together Image and build together compose#2458
• Epic: Support Docker's new networking model Epic: Support Docker's new networking model compose#1803
  • Specify networks in the Compose file - Proposal: Specify networks in the Compose file compose#2478
  • Move network support out of experimental status and make it the default (or only) means of inter-service communication (see the Epic)
• docker-compose events docker-compose events compose#2392
• Add support for declaring named volumes in compose files Add support for declaring named volumes in compose files compose#2421
• Improvements to docker-compose logs Improvements to docker-compose logs compose#2227 (new flags and updates to the logs command)
• Proposal: make project-name persistent. Proposal: make project-name persistent. compose#745

[ibuildthecloud]

@vdemeester Wow, thanks, this is really helpful. I'll look over it more next year (next week 😄 )

[vdemeester]

I still have to list some stuff that would be in the 1.6.0 milestone for docker-compose, see https://github.com/docker/compose/milestones/1.6.0.

And there is also the test-acceptance tests, imported from docker-compose that should help 😉.

[F21]

The --x-networking flag is now removed. Networks are now automatically created by default: https://docs.docker.com/compose/networking/

[vdemeester]

@F21 Thanks :-) I need to close this issue and split it up to be able to follow the gap and progress better ;-)