如何解决Azure流水线部署时docker-compose卷挂载变量替换异常问题

问题根因 #

1. docker-compose.yaml中的env_file配置仅用于给启动后的容器内部注入环境变量，不会用来解析yaml文件本身的${变量名}占位符。这类占位符是docker-compose命令在执行阶段读取宿主机（即Azure Pipeline代理）的环境变量、默认.env文件来解析的。
2. 本地运行正常大概率是因为本地执行命令的目录下有对应.env文件，或是变量已经提前写入本地环境变量，因此解析时能正确读取。
3. Azure Pipeline的DockerCompose@0任务存在参数拼接逻辑：你之前将--env-file参数写在dockerComposeCommand字段中，会被拼接到up子命令之后，属于子命令参数，无法作为全局参数生效，因此docker-compose在解析yaml阶段读取不到对应变量。

解决方案 #

方案一：调整任务参数配置（推荐，改动最小） #

将--env-file参数放到专门的全局参数字段additionalDockerComposeArguments中，调整后的任务配置如下：

- task: DockerCompose@0
  displayName: Run a Docker Compose command
  inputs:
    containerregistrytype: 'Container Registry'
    action: Run a Docker Compose command
    #azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    #azureContainerRegistry: $(azureContainerRegistry)
    dockerComposeFile: '$(Pipeline.Workspace)/s/docker_compose/docker-compose.yaml'
    # 全局参数放该字段
    additionalDockerComposeArguments: '--env-file $(Pipeline.Workspace)/s/docker_compose/test.env'
    # 仅保留子命令及子命令参数
    dockerComposeCommand: 'up -d'

方案二：提前导出变量到流水线环境 #

在DockerCompose任务前新增一个Bash任务，将test.env中的变量加载到流水线当前环境：

- bash: |
    cd $(Pipeline.Workspace)/s/docker_compose
    # 加载env文件变量
    source test.env
    # 导出为流水线全局变量
    echo "##vso[task.setvariable variable=BASE_MOUNT_PATH]$BASE_MOUNT_PATH"
    echo "##vso[task.setvariable variable=BASE_FILEPROCESSING_PATH]$BASE_FILEPROCESSING_PATH"
  displayName: Load mount variables from test.env

后续执行docker-compose时会自动读取当前环境的变量完成解析。

方案三：使用默认.env文件 #

将test.env重命名为.env，放到docker-compose.yaml的同级目录下，同时指定任务的工作目录为docker_compose文件夹：

- task: DockerCompose@0
  displayName: Run a Docker Compose command
  inputs:
    containerregistrytype: 'Container Registry'
    action: Run a Docker Compose command
    #azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    #azureContainerRegistry: $(azureContainerRegistry)
    workingDirectory: '$(Pipeline.Workspace)/s/docker_compose'
    dockerComposeFile: 'docker-compose.yaml'
    dockerComposeCommand: 'up -d'

docker-compose默认会读取执行工作目录下的.env文件来解析yaml占位符，无需额外传参。

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