VSCode DevContainer与docker-compose变量插值问题求助

核心需求 #

让docker-compose.yml能够绑定主机上仓库根目录下的tools/localstack路径到localstack容器的/etc/localstack/init/ready.d/目录。

当前问题 #

docker-compose.yml中的LOCAL_HOST_PATH变量解析为空，导致Docker尝试挂载无效路径/tools/localstack。临时解决方案是在.devcontainer/.env中添加LOCAL_HOST_PATH=${PWD}/../..，但该方案仅适配本地环境，无法提交到公共仓库。

现有配置 #

.devcontainer/devcontainer.json #

{
    "name": "<>",
    "dockerComposeFile": "docker-compose.yml",
    "service": "main",
    "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
    "features": {
        "<>/ghcr-docker-remote/devcontainers-contrib/features/apt-get-packages": {
            "packages": "bash-completion,pre-commit,vim"
        },
        "<>/ghcr-docker-remote/devcontainers/features/docker-outside-of-docker:1": {},
        "<>/ghcr-docker-remote/devcontainers-contrib/features/poetry:2": {},
        "<>/ghcr-docker-remote/devcontainers/features/aws-cli:1": {}
    },
    "customizations": {
        "vscode": {
            "extensions": [
                "<>"
            ]
        }
    },
    "containerUser": "vscode",
    "remoteUser": "vscode",
    "containerEnv": {
        "<db>_USR": "${<db>_USR}",
        "<db>_PWD": "${<db>_PWD}"
    },
    "remoteEnv": {
        "LOCAL_HOST_PATH": "${localWorkspaceFolder}",
        "LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}"
    },
    "postStartCommand": "make initialize-workspace"
}

docker-compose.yml #

name: <>

services:
  main:
    container_name: <>api-main
    image: <>mcr-docker-remote/devcontainers/python:3.10-bullseye
    hostname: localapi
    env_file:
      - api.env
    networks:
      - <network>
    volumes:
      # Forwards the local Docker socket to the container.
      - /var/run/docker.sock:/var/run/docker-host.sock
      # Update this to wherever you want VS Code to mount the folder of your project
      - ../..:/workspaces:cached

    # Overrides default command so things don't shut down after the process ends.
    entrypoint: /usr/local/share/docker-init.sh
    command: sleep infinity

  localstack:
    container_name: <>api-localstack
    image: localstack/localstack
    hostname: localstack
    networks:
      - <network>
    ports:
      - "127.0.0.1:4566:4566"
      - "127.0.0.1:4510-4559:4510-4559"
    environment:
      - SERVICES=secretsmanager,s3,dynamodb
      - DEBUG=1
      - DATA_DIR=/tmp/localstack/data
      - PORT_WEB_UI=8080
      - DOCKER_HOST=unix:///var/run/docker.sock
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"
      - "${LOCAL_HOST_PATH}/tools/localstack/:/etc/localstack/init/ready.d/"
    restart: unless-stopped

  dynamodb-admin:
    container_name: <>api-dynamodb-admin
    image: <>docker/aaronshaf/dynamodb-admin
    ports:
      - "8001:8001"
    environment:
      - DYNAMO_ENDPOINT=http://localstack:4566
    depends_on:
      - localstack
    networks:
      - <network>
    restart: unless-stopped

networks:
  <network>:
    driver: bridge
    name: <network>

已尝试的无效方案 #

devcontainer.json中设置环境变量 #

// containerEnv 配置，无效
"containerEnv": {
    "LOCAL_HOST_PATH": "${localWorkspaceFolder}" // 提示：LOCAL_HOST_PATH未设置，默认空字符串
    "LOCAL_HOST_PATH": "${workspaceFolder}" // 提示：workspaceFolder未设置，默认空字符串
}

// remoteEnv 配置，无效
"remoteEnv": {
    "LOCAL_HOST_PATH": "${localWorkspaceFolder}" // 提示：LOCAL_HOST_PATH未设置，默认空字符串
    "LOCAL_HOST_PATH": "${workspaceFolder}" // 提示：workspaceFolder未设置，默认空字符串
}

docker-compose.yml直接引用变量 #

volumes:
  - "/var/run/docker.sock:/var/run/docker.sock"
  - "${localWorkspaceFolder}/tools/localstack/:/etc/localstack/init/ready.d/" // 变量无法解析

解决方案 #

方案1：使用相对路径直接挂载（推荐） #

docker-compose的卷路径默认相对于docker-compose.yml所在的主机目录。如果.devcontainer目录位于仓库根目录下，直接用相对路径指定主机端的tools/localstack：

修改docker-compose.yml中localstack服务的volumes配置：

volumes:
  - "/var/run/docker.sock:/var/run/docker.sock"
  - "../tools/localstack/:/etc/localstack/init/ready.d/"

该方案无需环境变量，只要团队成员的仓库目录结构一致即可正常工作，无需额外配置。

方案2：通过本地专属.env文件传递路径（适配特殊目录结构） #

1. 在.devcontainer目录下创建.env.local文件，添加内容：

LOCAL_HOST_PATH=${PWD}/..

（根据你的目录结构调整路径，确保指向主机上的仓库根目录）

2. 修改docker-compose.yml中localstack服务的配置，添加.env.local到env_file：

services:
  localstack:
    # ... 其他配置
    env_file:
      - .env.local
    # ... 其他配置

3. 将.devcontainer/.env.local加入仓库的.gitignore，避免提交到公共仓库：

# .gitignore 添加内容
.devcontainer/.env.local

方案3：利用Dev Container变量自动生成本地.env文件 #

修改devcontainer.json的postCreateCommand，自动生成包含主机工作区路径的本地.env文件：

"postCreateCommand": "echo \"LOCAL_HOST_PATH=${localWorkspaceFolder}\" > .devcontainer/.env.local && make initialize-workspace"

同时按照方案2的步骤2和3，配置docker-compose.yml引用.env.local并忽略该文件。该方案无需用户手动创建.env.local，自动适配主机路径。

内容的提问来源于stack exchange，提问作者mesa_luna