Add documentation for Compose service profiles

[acran]

Proposed changes

This adds documentation on the new service profiles feature in docker-compose introduced with docker/compose#7930.

Since I didn't find a good place to fit in the detailed explanation of the profiles concept this adds a new dedicated page for this.

Unreleased project version

The feature was just merged with docker/compose#7930 and is not included in a released version yet.

(But since there is no vnext-compose branch I hope this PR against master is correct?)

Related issues (optional)

• feature introduced in docker-compose: Implement service profiles compose#7930
• profiles introduced in compose-spec: Introduce profiles for services compose-spec/compose-spec#110
• proposal and discussion in compose-spec: Proposal: profiles compose-spec/compose-spec#97

[netlify]

Deploy preview for docsdocker ready!

Built with commit fab7cf6

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

[chris-crone]

Some minor changes but content LGTM

@usha-mandya @nebuk89 @thaJeztah How can we structure this content and where should we put it?

[usha-mandya]

@chris-crone How about placing this above the 'Extend services in Compose" topic

[chris-crone]

@usha-mandya That sounds good to me!

[acran]

I incorporated the change suggestions and added profiles to the navigation at the suggested place

[acran]

Now also rebased on latest master, preview at https://deploy-preview-11844--docsdocker.netlify.app/compose/profiles/

[chris-crone]

LGTM

[aiordache]

LGTM! Thank you

[acran]

Thanks for merging!
But I just saw I did the rebase not careful enough which broke a link. I created a new PR to fix it: #12191

[SvenDowideit]

I just stumbled across this, and wondered - what does this do to compose files that are used for both compose and Swarm?

[chris-crone]

@SvenDowideit AFAIK the CLI needs to be updated for stack deploy to use the new version of the Compose spec. We don't have this on the backlog but will accept help doing it

[SvenDowideit]

TBH, the real issue is that its not addressed in the docs.

[ndeloof]

@SvenDowideit this is indeed highly confusing. With Mirantis beeing now in charge for Swarm maintenance, getting it to embrace compose-spec or document divergence is challenging for documentation hosted on docker.com. I wonder how we could get Mirantis team to "own" the stack command and related
documentation. For sure, we could at least add a note that this one doesn't support (yet) the Compose specification and still uses compose v3 file format.

IMHO a possible way to manage this would be to extract stack command into a CLI-plugin and transfert to Mirantis, so that they own both the code and the reference docs.

[SvenDowideit]

I took a little time to consider my feelings on this

TBH, I don't think its on Mirantis - Docker made changes to the compose spec - and the minimum change Docker should need to do, is to note (in the docs for the new profiles) that using it will cause the compose file to not work using Docker Swarm. The Next better thing, is a patch to the Swarm code to ignore this new keyword, as Swarm currently just stops.

Yes, we users of Swarm realise that actual implementation is now not something we can expect from Docker - but needlessly breaking things isn't a good look.

@thaJeztah what do you recon?

[ndeloof]

@SvenDowideit as compose support in stack deploy relies on 3.9 version header, you for sure are not left behind. Once you know stack deploy does not use the compose spec, just keep using 3.9 file format. Nothing has been "needlessly broken". You just won't be able to benefit improvements made to the compose spec and available on implementations to adopt it and being maintained accordingly (docker-compose, compose v2, ECS/ACI integrations, nerdclt, okteto...).