Personnaliser les images de conteneur pour le débogage

Lorsque vous effectuez la génération dans la configuration Débogage, Visual Studio réalise plusieurs optimisations qui facilitent les performances du processus de génération pour les projets conteneurisés. Le processus de génération des applications conteneurisées n’est pas aussi évident que le simple suivi des étapes décrites dans le fichier Dockerfile. La création dans un conteneur est beaucoup plus lente que sur l’ordinateur local. Ainsi, lorsque vous générez dans la configuration Débogage, Visual Studio génère vos projets sur l’ordinateur local, puis partage le dossier de sortie dans le conteneur à l’aide du montage de volume. Une build avec cette optimisation activée est appelée build en mode Rapide.

En mode Rapide, Visual Studio appelle docker build avec un argument qui indique à Docker de générer uniquement le premier index du fichier Dockerfile (normalement l’index base). Vous pouvez modifier cela en définissant la propriété MSBuild, DockerfileFastModeStage, décrite dans Propriétés MSBuild des outils de conteneurs. Visual Studio gère le reste du processus sans tenir compte du contenu du fichier Dockerfile. Par conséquent, lorsque vous modifiez votre fichier Dockerfile, par exemple pour personnaliser l’environnement de conteneur ou installer des dépendances supplémentaires, vous devez placer vos modifications dans la première étape. Les étapes personnalisées placées dans les index build, publish ou final du fichier Dockerfile ne sont pas exécutées.

Cette optimisation des performances se produit normalement uniquement lorsque vous générez dans la configuration Débogage. Dans la configuration Mise en production, la génération se produit dans le conteneur comme spécifié dans le fichier Dockerfile. Vous pouvez activer ce comportement pour la configuration Release en définissant ContainerDevelopmentMode sur Fast dans le fichier projet :

<PropertyGroup Condition="'$(Configuration)' == 'Release'">
   <ContainerDevelopmentMode>Fast</ContainerDevelopmentMode>
</PropertyGroup>

Si vous souhaitez désactiver l’optimisation des performances pour toutes les configurations et générer comme le spécifie le fichier Dockerfile, définissez la propriété ContainerDevelopmentMode sur Regular dans le fichier projet comme suit :

<PropertyGroup>
   <ContainerDevelopmentMode>Regular</ContainerDevelopmentMode>
</PropertyGroup>

Pour restaurer l’optimisation des performances, supprimez la propriété du fichier projet.

Lorsque vous démarrez le débogage (F5), un conteneur démarré précédemment est réutilisé, si possible. Si vous ne souhaitez pas réutiliser le conteneur précédent, vous pouvez utiliser les commandes Régénérer ou Nettoyer dans Visual Studio pour forcer Visual Studio à utiliser un nouveau conteneur.

Le processus d’exécution du débogueur dépend du type de projet et du système d’exploitation de conteneur :

Pour plus d’informations sur vsdbg.exe, consultez Débogage offroad de .NET Core sur Linux et OS X à partir de Visual Studio.

Modifier l’image conteneur pour le débogage et la production

Pour modifier l’image conteneur à la fois pour le débogage et la production, modifiez l’étape base. Ajoutez vos personnalisations au fichier Dockerfile dans la section de l’étape de base, généralement la première section du fichier Dockerfile. Pour plus d’informations sur les commandes Dockerfile, reportez-vous à la référence Dockerfile dans la documentation Docker.

# This stage is used when running from VS in fast mode (Default for Debug configuration)
FROM mcr.microsoft.com/dotnet/aspnet:6.0 AS base
WORKDIR /app
EXPOSE 80
EXPOSE 443
# <add your commands here>

# This stage is used to build the service project
FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build
WORKDIR /src
COPY ["WebApplication3/WebApplication3.csproj", "WebApplication3/"]
RUN dotnet restore "WebApplication3/WebApplication3.csproj"
COPY . .
WORKDIR "/src/WebApplication3"
RUN dotnet build "WebApplication3.csproj" -c Release -o /app/build

# This stage is used to publish the service project to be copied to the final stage
FROM build AS publish
RUN dotnet publish "WebApplication3.csproj" -c Release -o /app/publish

# This stage is used in production or when running from VS in regular mode (Default when not using the Debug configuration)
FROM base AS final
WORKDIR /app
COPY --from=publish /app/publish .
ENTRYPOINT ["dotnet", "WebApplication3.dll"]

Modifier l’image conteneur uniquement pour le débogage

Vous pouvez personnaliser vos conteneurs de certaines façons pour faciliter le débogage, comme l’installation de quelque chose à des fins de diagnostic, sans affecter les builds de production.

Pour modifier le conteneur uniquement pour le débogage, créez une étape, puis utilisez la propriété MSBuild DockerfileFastModeStage pour indiquer à Visual Studio d’utiliser votre étape personnalisée lors du débogage. Pour plus d’informations sur les commandes Dockerfile, reportez-vous à la référence Dockerfile dans la documentation Docker.

Dans l’exemple suivant, nous installons le package procps-ng, mais uniquement en mode débogage. Ce package fournit la commande pidof, dont Visual Studio a besoin (pour .NET Standard 2.0 et versions antérieures), mais qui n’est pas dans l’image Mariner utilisée ici. L’étape que nous utilisons pour le débogage en mode rapide est debug, une étape personnalisée définie ici. L’index du mode rapide n’a pas besoin d’hériter de l’index build ni publish. Il peut hériter directement de l’index base, car Visual Studio monte un volume qui contient tout ce qui est nécessaire pour exécuter l’application, comme décrit plus haut dans cet article.

#See https://aka.ms/containerfastmode to understand how Visual Studio uses this Dockerfile to build your images for faster debugging.

# This stage is used when running from VS in fast mode (Default for Debug configuration)
FROM mcr.microsoft.com/dotnet/aspnet:6.0-cbl-mariner2.0 AS base
WORKDIR /app
EXPOSE 80
EXPOSE 443

FROM base AS debug
RUN tdnf install procps-ng -y

# This stage is used to build the service project
FROM mcr.microsoft.com/dotnet/sdk:6.0-cbl-mariner2.0 AS build
WORKDIR /src
COPY ["WebApplication1/WebApplication1.csproj", "WebApplication1/"]
RUN dotnet restore "WebApplication1/WebApplication1.csproj"
COPY . .
WORKDIR "/src/WebApplication1"
RUN dotnet build "WebApplication1.csproj" -c Release -o /app/build

# This stage is used to publish the service project to be copied to the final stage
FROM build AS publish
RUN dotnet publish "WebApplication1.csproj" -c Release -o /app/publish

# This stage is used in production or when running from VS in regular mode (Default when not using the Debug configuration)
FROM base AS final
WORKDIR /app
COPY --from=publish /app/publish .
ENTRYPOINT ["dotnet", "WebApplication1.dll"]

Dans le fichier projet, ajoutez ce paramètre pour indiquer à Visual Studio d’utiliser votre étape debug personnalisée lors du débogage.

  <PropertyGroup>
     <!-- other property settings -->
     <DockerfileFastModeStage>debug</DockerfileFastModeStage>
  </PropertyGroup>

# These ARGs allow for swapping out the base used to make the final image when debugging from VS
ARG LAUNCHING_FROM_VS
# This sets the base image for final, but only if LAUNCHING_FROM_VS has been defined
ARG FINAL_BASE_IMAGE=${LAUNCHING_FROM_VS:+aotdebug}

# ... (other stages omitted)

# This stage is used as the base for the final stage when launching from VS to support debugging in regular mode (Default when not using the Debug configuration)
FROM base as aotdebug
USER root
# Install GDB to support native debugging
RUN apt-get update \
    && apt-get install -y --no-install-recommends \
    gdb
USER app

# This stage is used in production or when running from VS in regular mode (Default when not using the Debug configuration)
FROM ${FINAL_BASE_IMAGE:-mcr.microsoft.com/dotnet/runtime-deps:8.0} AS final
WORKDIR /app
EXPOSE 8080
COPY --from=publish /app/publish .
ENTRYPOINT ["./WebApplication1"]

Contenu connexe

• Personnaliser des conteneurs Docker dans Visual Studio
• Générer un projet de conteneur depuis la ligne de commande