Support docker-compose 3.9 profiles

[yamamoto-works]

https://docs.docker.com/compose/profiles/

microsoft/vscode-docker#2777

[chrmarti]

Could you explain how you would like to see this supported? Would a "profiles" property to list the profiles in the devcontainer.json be sufficient?

[yamamoto-works]

Could you explain how you would like to see this supported? Would a "profiles" property to list the profiles in the devcontainer.json be sufficient?

Yes.
VScode Docker plugin supports docker-compose profiles properties and can choose which service will run.
But remote plugin can't do that.

[max-mulawa]

Christof Marti (@chrmarti) any plans of supporting profiles for docker compose in the near future?

[leorochael]

Hi,

Before I start, a big thank you to all involved for providing a wonderful service. The language below should not be construed as criticism of the work done so far.

I lost a significant amount of time trying to understand an error derived from lack of support for profiles in docker-compose:

If you:

• call the command Dev Containers: Add Dev Container Configuration Files...
• then chose From 'docker-compose.yml'
• then in Select a service you select a service from your docker-compose.yml file that has a profiles entry like

version: "3"
services:
  myservice:
    profiles:
      - development
    build:
      context: "."

Then when you call Dev Containers: Reopen in Container, you'll hit an error like:

[2022-12-09T13:04:06.542Z] Start: Run: docker inspect --type image my-project-myservice
[2022-12-09T13:04:06.561Z] Stop (19 ms): Run: docker inspect --type image myproject-myservice
[2022-12-09T13:04:07.487Z] Error fetching image details: No manifest found for docker.io/library/myproject-myservice.
[2022-12-09T13:04:07.487Z] Start: Run: docker pull myproject-myservice
[2022-12-09T13:04:07.615Z] Using default tag: latest
[2022-12-09T13:04:09.459Z] Error response from daemon: pull access denied for myproject-myservice, repository does not exist or may require 'docker login': denied: requested access to the resource is denied
[2022-12-09T13:04:09.461Z] Stop (1974 ms): Run: docker pull myproject-myservice
[2022-12-09T13:04:09.461Z] []
[2022-12-09T13:04:09.461Z] Error: No such image: myproject-myservice

[2022-12-09T13:04:09.463Z] Error: Command failed: docker inspect --type image myproject-myservice

This is caused by the profiles clause in the yaml. VS.Code selected a service that docker-compose will not try to build unless --profile <profile name> is added as an option to docker-compose, like:

• docker-compose --profile developmet build -f docker-compose.yml ...

But dev-containters doesn't pass that option, despite allowing you to select a service that can only be built or brought up by specifying a profile.

Until profiles are supported, I suggest that a service from docker-compose.yml that has profiles should not be offered. Only those services with no profile attached should be offered. And when the Dev Containers: Reopen in Container command is called, it should check that the selected service has no profiles: attached

As for adding support, adding a profiles: [] setting (as array of string) would be a very important first step that should be done as soon as possible. Even better if it checks that at least one of the profiles of the selected service, if it has one, is present in the profiles of devcontainer.json

A second step would be on the Dev Containers: Add Dev Container Configuration Files...: it should offer to select profiles, if there are any in the docker-compose.yml, before offering to select a service, and then only offering services that have no profile, or that belong to the selected profiles.

A more friendly alternative would be to offer all services, even those with profiles, before requesting profiles. But then if the user requests a service that has only one profile, automatically select the profile for the user. I the service has more than one profile in docker-compose.yml then request the user to select at least one of the profiles attached to the service, or cancel the generation of the devcontainer.json file unless the user selects at least one.

[josegonzalez]

I'd like to second Leonardo Rochael Almeida (@leorochael)'s comment.

I have an app that runs a few different services - datastores but also apis/background processes - and it would be useful to be able to say "only run these services when running in devcontainer mode". For instance, with a devcontainer, I might want to start my datastores but not the default set of services and instead an all-in-one container that runs all the app processes in the background via a Procfile and gives me a normal terminal otherwise. I'm unable to do so without duplicating the docker-compose file, making the development experience a bit more annoying.

[ajvirgona]

I also have the same use case as Leonardo Rochael Almeida (@leorochael) where I have a dev profile that I wish to use in conjuntion with the devcontainer feature that contains a service I would not run when deploying the system. I hit the same confusing error Error fetching image details: No manifest found for docker.io/library/... after adding profiles to my compose.yaml

I support Leonardo Rochael Almeida (@leorochael)'s proposals and think adding a profiles key to the devcontainer.json is the best way to go here. An even simpler fix that would get me going would be to ignore profiles all together and just start the specified service in the same way that I can using docker compose up dev

[leesiongchan]

One workaround is to use .env file.

COMPOSE_PROFILES=xyz

[nikelborm]

I did another workaround

I moved devcontainer to a different file
https://github.com/nikelborm/project-boilerplate/blob/main/.devcontainer/devcontainer.docker-compose.yaml

and I placed other dev containers to a different file
https://github.com/nikelborm/project-boilerplate/blob/main/.devcontainer/docker-compose.dev.yaml

And I added to my devcontainer json

{
  "dockerComposeFile": "docker-compose.built.yaml",
  "service": "vscode-devcontainer",
  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
	"initializeCommand": "DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker compose --env-file ./env/dev.env -f ./.devcontainer/docker-compose.dev.yaml -f ./.devcontainer/devcontainer.docker-compose.yaml convert > .devcontainer/docker-compose.built.yaml"
}

So it freeze state of docker compose file and then run it. But by default if I'll run docker-compose.dev.yaml it will start without dev container. And this is desirable behavior for me