Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention Docker 19.03 and its compose file version - and add max_repli… #10273

Merged

Conversation

SvenDowideit
Copy link
Contributor

it looks to me like 19.03's effect on swarm more compose wasn't documented.

this is an attempt at starting

@thaJeztah
Copy link
Member

I think the reason for this would be that docker-compose (stand-alone, so not docker stack deploy) did not yet have support for the 3.8 spec. This was merged into compose master in docker/compose#7217

@SvenDowideit
Copy link
Contributor Author

that really makes no sense - the 19.03 docker release supported a set of functionality that uses 'version: 3.8' - and there are many compose file things that aren't supported in docker-compose.

I'm hoping that whoever is the release manager for 20.03 also has responsibility to make sure that all features that are in that release, are sufficiently documented .....

@thaJeztah
Copy link
Member

I agree it's a bit hairy; both the docker cli and docker-compose use the compose-file format, but the "compose file reference" section here is part of the compose docs. The intent was to have both compose and the docker cli be "in sync" w.r.t. the schema that's supported, but compose lagged behind on the 3.8 schema; the compose_file_v3 variable is used in the docs to set the version in all examples, so updating it right now would break those examples for docker-compose users.

As to the general issue of the spec being maintained in both locations; ideally, the compose file specification would live in a separate repository (the format is now used by various projects, so having a canonical location for the specification would be good); there's a tracking issue for that here; docker/compose#2089. For documentation, ideally it would be possible to generate the docs directly from the schema (docker/cli#1058) but so far I haven't found a proper solution for that (@SvenDowideit if you run into something that works well for that, I'm all ears 😅)

I'll check with @ulyssessouza and @ndeloof to see if a new version of compose with support for the 3.8 schema can be released soon, to unblock this PR.

@ndeloof
Copy link
Contributor

ndeloof commented Feb 12, 2020

3.8 is on it's way into docker-compose: docker/compose#7217

About schema being duplicated, see docker/compose#7047

@SvenDowideit
Copy link
Contributor Author

think of it this way - for the last 9+months, the compose file docs have been broken for swarm users, as the v3.8 format was released then. The sad reality that docker-compose lagged in its support doesn't change the fact that v3.8 was released a long time ago.

@SvenDowideit
Copy link
Contributor Author

so to quote @ndeloof from 7047:

Docker Compose schema on https://github.com/docker/cli/tree/master/cli/compose/schema/data is considered by maintainers as the leading one, and should be the place we use to any proposal for schame enhancements.

that really strongly suggests that the documentation should also deal with that information, and not block on the secondary docker-compose version.

the "updating it right now would break those examples for docker-compose users" just goes to show how utterly broken things are - examples shouldn't autoupdate to use the latest version, they should really indicate the minimum version that the example is tested for.... which also would show the user how old that feature is, and that it may well be stale.

@ulyssessouza
Copy link
Contributor

@SvenDowideit LGTM.
It just needs a rebase.

@thaJeztah thaJeztah force-pushed the document-some-missing-19.03-things branch from 5d23d8f to d5e7a26 Compare April 17, 2020 06:50
@thaJeztah
Copy link
Member

I rebased; should be good to go now 👍

@thaJeztah thaJeztah added the area/compose Relates to docker-compose.yml spec or docker-compose binary label Apr 17, 2020
Copy link
Member

@usha-mandya usha-mandya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

@netlify
Copy link

netlify bot commented Apr 17, 2020

Deploy preview for docsdocker ready!

Built with commit d5e7a26

https://deploy-preview-10273--docsdocker.netlify.app

1 similar comment
@netlify
Copy link

netlify bot commented Apr 17, 2020

Deploy preview for docsdocker ready!

Built with commit d5e7a26

https://deploy-preview-10273--docsdocker.netlify.app

@usha-mandya usha-mandya merged commit a173d1b into docker:master Apr 17, 2020
@SvenDowideit SvenDowideit deleted the document-some-missing-19.03-things branch April 19, 2020 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/compose Relates to docker-compose.yml spec or docker-compose binary
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants