Propriedades de build do Docker Compose

Além das propriedades que controlam projetos individuais do Docker, descritas em Propriedades de build das Ferramentas de Contêiner, você também pode personalizar como o Visual Studio compila seus projetos do Docker Compose definindo as propriedades do Docker Compose que o MSBuild usa para compilar a solução. Você também pode controlar como o depurador do Visual Studio executa aplicativos Docker Compose definindo rótulos de arquivo nos arquivos de configuração do Docker Compose.

Como definir as propriedades do MSBuild

Para definir o valor de uma propriedade, edite o arquivo de projeto. Para propriedades do Docker Compose, esse arquivo de projeto é aquele com uma .dcproj extensão, a menos que indicado de outra forma na tabela na próxima seção. Por exemplo, suponha que você queira especificar que o navegador seja iniciado ao iniciar a depuração. Você pode definir a DockerLaunchAction propriedade no arquivo de projeto da .dcproj seguinte maneira.

<PropertyGroup>
   <DockerLaunchAction>LaunchBrowser</DockerLaunchAction>
</PropertyGroup>

Adicione a configuração da propriedade a um elemento PropertyGroup existente ou, se não houver um, crie um elemento PropertyGroup.

Propriedades do Docker Compose no MSBuild

A tabela a seguir mostra as propriedades do MSBuild disponíveis para projetos do Docker Compose (arquivos.dcproj).

Além disso, a propriedade DockerComposeProjectPath em um arquivo de projeto .csproj ou .vbproj especifica o caminho relativo para o arquivo de projeto do Docker Compose (.dcproj). Defina essa propriedade ao publicar o projeto de serviço para localizar as configurações de build de imagem associadas armazenadas no arquivo docker-compose.yml.

Exemplo

Se você alterar o local dos docker-compose arquivos, definindo DockerComposeBaseFilePath um caminho relativo, também precisará garantir que o contexto de build seja alterado para que ele faça referência à pasta da solução. Por exemplo, se o docker-compose arquivo for uma pasta chamada DockerComposeFiles, o arquivo do Docker Compose deverá definir o contexto de compilação como ".." ou ".. /..", dependendo de onde ele está em relação à pasta da solução.

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="15.0" Sdk="Microsoft.Docker.Sdk">
  <PropertyGroup Label="Globals">
    <ProjectVersion>2.1</ProjectVersion>
    <DockerTargetOS>Windows</DockerTargetOS>
    <ProjectGuid>154022c1-8014-4e9d-bd78-6ff46670ffa4</ProjectGuid>
    <DockerLaunchAction>LaunchBrowser</DockerLaunchAction>
    <DockerServiceUrl>{Scheme}://{ServiceIPAddress}{ServicePort}</DockerServiceUrl>
    <DockerServiceName>webapplication1</DockerServiceName>
    <DockerComposeBaseFilePath>DockerComposeFiles\mydockercompose</DockerComposeBaseFilePath>
    <AdditionalComposeFilePaths>AdditionalComposeFiles\myadditionalcompose.yml</AdditionalComposeFilePaths>
  </PropertyGroup>
  <ItemGroup>
    <None Include="DockerComposeFiles\mydockercompose.override.yml">
      <DependentUpon>DockerComposeFiles\mydockercompose.yml</DependentUpon>
    </None>
    <None Include="DockerComposeFiles\mydockercompose.yml" />
    <None Include=".dockerignore" />
  </ItemGroup>
</Project>

O arquivo mydockercompose.yml deve ter esta aparência, com o contexto de build definido como o caminho relativo da pasta da solução (nesse caso, ..).

version: '3.4'

services:
  webapplication1:
    image: ${DOCKER_REGISTRY-}webapplication1
    build:
      context: ..
      dockerfile: WebApplication1\Dockerfile

Substituindo a configuração do Docker Compose do Visual Studio

Normalmente, docker-compose.override.yml é usado para substituir determinadas configurações em docker-compose.yml. Além disso, o Visual Studio gera arquivos de substituição docker-compose.vs.debug.g.yml (para o modo Rápido ) e docker-compose.vs.release.g.yml (para o modo Regular ) com configurações específicas para executar o aplicativo dentro do Visual Studio. Você pode substituir essas configurações do Visual Studio colocando um arquivo chamado docker-compose.vs.debug.yml (para o modo Rápido) ou docker-compose.vs.release.yml (para o modo Regular) no mesmo diretório que o arquivo docker-compose.yml. Clique com o botão direito do mouse no projeto do Docker Compose e selecione Abrir pasta no Explorador de Arquivos e use Adicionar>Item Existente para adicionar o arquivo ao seu projeto do Docker Compose.

Rótulos de arquivo do Docker Compose

Em docker-compose.vs.debug.yml ou docker-compose.vs.release.yml, você pode definir rótulos específicos de substituição da seguinte maneira:

services:
  webapplication1:
    labels:
      com.microsoft.visualstudio.debuggee.workingdirectory: "C:\\my_app_folder"

Use aspas duplas em torno dos valores, como no exemplo anterior, e use a barra invertida como um caractere de escape para barras invertidas em caminhos.

Personalizar o processo de build do Docker

Você pode declarar qual estágio compilar no Dockerfile usando a configuração target na propriedade build. Essa substituição pode ser usada apenas em docker-compose.vs.debug.yml ou docker-compose.vs.release.yml

services:
  webapplication1:
    build:
      target: customStage
    labels:
      ...

Personalizar o processo de inicialização do aplicativo

Você pode executar um comando ou script personalizado antes de iniciar o aplicativo usando a configuração entrypoint e tornando-a dependente do DockerDevelopmentMode. Por exemplo, se você precisar configurar um certificado somente no modo Rápido executando update-ca-certificates, mas não no modo Regular, poderá adicionar o seguinte código apenasdocker-compose.vs.debug.yml:

services:
  webapplication1:
    entrypoint: "sh -c 'update-ca-certificates && tail -f /dev/null'"
    labels:
      ...

Para obter mais informações, consulte Ponto de entrada do contêiner

Próximas etapas

Para obter informações sobre as propriedades do MSBuild em geral, consulte Propriedades do MSBuild.

Confira também

Propriedades de build das Ferramentas de Contêiner

Configurações de inicialização das Ferramentas de Contêiner

Gerenciar perfis de inicialização do Docker Compose no Visual Studio

Propriedades reservadas e conhecidas do MSBuild