Missing docs for new update_config order option

[hairyhenderson]

Problem description

In Docker 17.09, support was added for a new order option in the update_config section in the Docker Compose v3.4 file.

See docker/cli#360 for details.

Problem location

• I couldn't find the information I wanted. I expected to find it near the following URL: https://docs.docker.com/compose/compose-file/#update_config

[hairyhenderson]

Here's a fix for this: #5089

[londoncalling]

@shin- @gbarr01 I'm working on a contribution to @hairyhenderson PR #5089 , but as I look at it more closely, we need to add the following:

• add a section in about versions and upgrading under Versioning about Version 3.4 (just pushed to the current branch for this PR)

• add examples and mention of all the new v3.4 supported parameters to their associated topics in the Compose file reference.

@hairyhenderson has done this for order, but we'll need examples and mention of the other new 3.4 options listed [here](Compose file version 3.4).

@shin- is someone planning on adding those examples to the docs or should @gbarr01 or I do it? If the latter, I think we might need some help.

[shin-]

Version 3.4 was introduced in Docker Engine 17.09.0, but it hasn't made it yet in a Compose release. Those changes would have ideally been made at that time by whoever is responsible for documenting Engine features.

I did have a versioning section written out and ready to go in vnext-compose for when we release Compose 1.17.0 (#5019), as well as documentation for extension fields.

• For the fields in the build section, they're no-ops with docker stack (it ignores the build section entirely), but they should be documented in the v2 reference and examples can probably be copied over.
• Volume name is also documented in the v2 reference.

[mdlinville]

Oh no, maybe I should revert that merge....

[hairyhenderson]

@mstanleyjones since the fix has been reverted, can this bug be reopened? It's not ideal that the option remains undocumented for Swarm users...

[mdlinville]

It is documented in the vnext-compose branch, which will be merged with master when Compose is released. cc/ @shin- in case I am misunderstanding.

[hairyhenderson]

Ok, just to be clear, I didn't run into the lack of documentation while using docker-compose, but while using docker stack deploy.

In fact, docker-compose doesn't even support the deploy section, and logs the following when it encounters it:

$ docker-compose up
...
WARNING: Some services (foo, bar) use the 'deploy' key, which will be ignored. Compose does not support 'deploy' configuration - use `docker stack deploy` to deploy to a swarm.
...

[mdlinville]

OK, I am confused about where this content should live. @londoncalling @shin- PTAL and advise.

[londoncalling]

@hairyhenderson that is correct, docker-compose does not support the deploy key, as is detailed here: https://docs.docker.com/compose/compose-file/#deploy. You have to use docker stack deploy for those options.

@mstanleyjones the information should still live at https://docs.docker.com/compose/compose-file/#update_config, which is a subtopic under deploy.

cc: @shin-

[docker-robott]

Closed issues are locked after 30 days of inactivity.
This helps our team focus on active issues.

If you have found a problem that seems similar to this, please open a new issue.

/lifecycle locked