Containerisera en .NET-app med dotnet publish

• .NET 8+ SDK
  Om du har .NET installerat använder dotnet --info du kommandot för att avgöra vilken SDK du använder.
• Docker Community Edition

• .NET 7+ SDK
  Om du har .NET installerat använder dotnet --info du kommandot för att avgöra vilken SDK du använder.
• Docker Community Edition

Lägg till NuGet-paket

NuGet-paketet Microsoft.NET.Build.Containers krävs för närvarande för att publicera icke-webbprojekt som en container. Om du vill lägga till Microsoft.NET.Build.Containers NuGet-paketet i arbetsmallen kör du följande dotnet add package-kommando :

dotnet add package Microsoft.NET.Build.Containers

Som standard är containeravbildningen namnet på AssemblyName projektet. Om namnet är ogiltigt som ett containeravbildningsnamn kan du åsidosätta det genom att ange ett ContainerRepository som visas i följande projektfil:

<Project Sdk="Microsoft.NET.Sdk.Worker">

  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
    <UserSecretsId>dotnet-DotNet.ContainerImage-2e40c179-a00b-4cc9-9785-54266210b7eb</UserSecretsId>
    <ContainerRepository>dotnet-worker-image</ContainerRepository>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
  </ItemGroup>
</Project>

Mer information finns i ContainerRepository.

Som standard är containeravbildningen namnet på AssemblyName projektet. Om namnet är ogiltigt som ett containeravbildningsnamn kan du åsidosätta det genom att ange ett (ContainerImageName föråldrat) eller önskat ContainerRepository som det visas i följande projektfil:

<Project Sdk="Microsoft.NET.Sdk.Worker">

  <PropertyGroup>
    <TargetFramework>net7.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
    <UserSecretsId>dotnet-DotNet.ContainerImage-2e40c179-a00b-4cc9-9785-54266210b7eb</UserSecretsId>
    <ContainerImageName>dotnet-worker-image</ContainerImageName>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.Extensions.Hosting" Version="7.0.1" />
    <PackageReference Include="Microsoft.NET.Build.Containers" Version="7.0.401" />
  </ItemGroup>
</Project>

Mer information finns i ContainerImageName.

Determining projects to restore...
  All projects are up-to-date for restore.
  DotNet.ContainerImage -> .\Worker\bin\Release\net8.0\linux-x64\DotNet.ContainerImage.dll
  DotNet.ContainerImage -> .\Worker\bin\Release\net8.0\linux-x64\publish\
  Building image 'dotnet-worker-image' with tags latest on top of base image mcr.microsoft.com/dotnet/aspnet:8.0
  Pushed container 'dotnet-worker-image:latest' to Docker daemon

Determining projects to restore...
  All projects are up-to-date for restore.
  DotNet.ContainerImage -> .\Worker\bin\Release\net7.0\linux-x64\DotNet.ContainerImage.dll
  DotNet.ContainerImage -> .\Worker\bin\Release\net7.0\linux-x64\publish\
  Building image 'dotnet-worker-image' with tags 1.0.0 on top of base image mcr.microsoft.com/dotnet/aspnet:7.0
  Pushed container 'dotnet-worker-image:1.0.0' to Docker daemon

ContainerArchiveOutputPath

Från och med .NET 8 kan du skapa en container direkt som ett tar.gz arkiv. Den här funktionen är användbar om arbetsflödet inte är enkelt och kräver att du till exempel kör ett genomsökningsverktyg över dina bilder innan du push-överför dem. När arkivet har skapats kan du flytta det, skanna det eller läsa in det i en lokal Docker-verktygskedja.

Om du vill publicera i ett arkiv lägger du till egenskapen i ContainerArchiveOutputPath kommandot dotnet publish , till exempel:

dotnet publish \
  -p PublishProfile=DefaultContainer \
  -p ContainerArchiveOutputPath=./images/sdk-container-demo.tar.gz

Du kan ange antingen ett mappnamn eller en sökväg med ett specifikt filnamn. Om du anger mappnamnet blir $(ContainerRepository).tar.gzfilnamnet som genereras för avbildningsarkivfilen . Dessa arkiv kan innehålla flera taggar inuti dem, bara när en enda fil skapas för alla ContainerImageTags.

<PropertyGroup>
    <ContainerBaseImage>mcr.microsoft.com/dotnet/runtime:8.0</ContainerBaseImage>
</PropertyGroup>

<PropertyGroup>
    <ContainerBaseImage>mcr.microsoft.com/dotnet/runtime:7.0</ContainerBaseImage>
</PropertyGroup>

ContainerFamily

Från och med .NET 8 kan du använda ContainerFamily egenskapen MSBuild för att välja en annan familj med Microsoft-tillhandahållna containeravbildningar som basavbildning för din app. När det här värdet anges läggs det till i slutet av den valda TFM-specifika taggen, vilket ändrar taggen som anges. Om du till exempel vill använda Alpine Linux-varianterna av .NET-basavbildningarna kan du ange ContainerFamily till alpine:

<PropertyGroup>
    <ContainerFamily>alpine</ContainerFamily>
</PropertyGroup>

Den föregående projektkonfigurationen resulterar i en slutlig tagg för 8.0-alpine en .NET 8-målapp.

Det här fältet är fritt format och kan ofta användas för att välja olika operativsystemdistributioner, standardpaketkonfigurationer eller någon annan smak av ändringar i en basavbildning. Det här fältet ignoreras när ContainerBaseImage har angetts. Mer information finns i .NET-containeravbildningar.

ContainerRepository

Containerlagringsplatsen är namnet på själva avbildningen, dotnet/runtime till exempel eller my-app. Som standard AssemblyName används projektet.

<PropertyGroup>
    <ContainerRepository>my-app</ContainerRepository>
</PropertyGroup>

ContainerImageName

Containeravbildningens namn styr namnet på själva avbildningen, dotnet/runtime till exempel eller my-app. Som standard AssemblyName används projektet.

<PropertyGroup>
    <ContainerImageName>my-app</ContainerImageName>
</PropertyGroup>

Från och med .NET 8, när en tagg inte anges är lateststandardvärdet .

Som standard Version används projektet som taggvärde.

Från och med .NET 8 härleds den när den ContainerPort inte uttryckligen anges baserat på flera välkända ASP.NET miljövariabler:

• ASPNETCORE_URLS
• ASPNETCORE_HTTP_PORTS
• ASPNETCORE_HTTPS_PORTS

Om dessa miljövariabler finns parsas deras värden och konverteras till TCP-portmappningar. Dessa miljövariabler läse från basavbildningen, om de finns, eller från miljövariablerna som definieras i projektet via ContainerEnvironmentVariable objekt. Mer information finns i ContainerEnvironmentVariable.

Du kan dock styra hur appen körs med hjälp av en kombination av ContainerAppCommand, ContainerAppCommandArgs, ContainerDefaultArgsoch ContainerAppCommandInstruction.

Dessa olika konfigurationsplatser finns eftersom olika basavbildningar använder olika kombinationer av containern ENTRYPOINT och COMMAND egenskaperna, och du vill kunna stödja dem alla. Standardvärdena bör vara användbara för de flesta appar, men om du vill anpassa appstartbeteendet bör du:

• Identifiera binärfilen som ska köras och ange den som ContainerAppCommand
• Identifiera vilka argument som krävs för att programmet ska kunna köras och ange dem som ContainerAppCommandArgs
• Identifiera vilka argument (om några) som är valfria och kan åsidosättas av en användare och ange dem som ContainerDefaultArgs
• Ställ in ContainerAppCommandInstruction på DefaultArgs

Mer information finns i följande konfigurationsobjekt.

ContainerAppCommand

Konfigurationsobjektet för appkommandot är appens logiska startpunkt. För de flesta appar är detta AppHost, den genererade körbara binärfilen för din app. Om din app inte genererar en AppHost blir det här kommandot vanligtvis dotnet <your project dll>. Dessa värden tillämpas efter någon ENTRYPOINT i bascontainern, eller direkt om nej ENTRYPOINT har definierats.

Konfigurationen ContainerAppCommand har en enda Include egenskap som representerar kommandot, alternativet eller argumentet som ska användas i kommandot entrypoint:

<ItemGroup Label="ContainerAppCommand Assignment">
  <!-- This is how you would start the dotnet ef tool in your container -->
  <ContainerAppCommand Include="dotnet" />
  <ContainerAppCommand Include="ef" />

  <!-- This shorthand syntax means the same thing, note the semicolon separating the tokens. -->
  <ContainerAppCommand Include="dotnet;ef" />
</ItemGroup>

ContainerAppCommandArgs

Det här appkommandot args-konfigurationsobjektet representerar alla logiskt obligatoriska argument för din app som ska tillämpas på ContainerAppCommand. Som standard genereras ingen för en app. När det är dags tillämpas args på containern när den körs.

Konfigurationen ContainerAppCommandArgs har en enda Include egenskap som representerar alternativet eller argumentet som ska tillämpas på ContainerAppCommand kommandot.

<ItemGroup>
  <!-- Assuming the ContainerAppCommand defined above, 
       this would be the way to force the database to update.
  -->
  <ContainerAppCommandArgs Include="database" />
  <ContainerAppCommandArgs Include="update" />

  <!-- This is the shorthand syntax for the same idea -->
  <ContainerAppCommandArgs Include="database;update" />
</ItemGroup>

ContainerDefaultArgs

Det här standardinställningsobjektet args representerar alla användaröversidosättbara argument för din app. Det här är ett bra sätt att tillhandahålla standardvärden som din app kan behöva köra på ett sätt som gör det enkelt att starta, men ändå enkelt att anpassa.

Konfigurationen ContainerDefaultArgs har en enda Include egenskap som representerar alternativet eller argumentet som ska tillämpas på ContainerAppCommand kommandot.

<ItemGroup>
  <!-- Assuming the ContainerAppCommand defined above, 
       this would be the way to force the database to update.
  -->
  <ContainerDefaultArgs Include="database" />
  <ContainerDefaultArgs Include="update" />

  <!-- This is the shorthand syntax for the same idea -->
  <ContainerDefaultArgs Include="database;update" />
</ItemGroup>

ContainerAppCommandInstruction

Konfigurationen för appkommandoinstruktioner hjälper dig att styra hur ContainerEntrypoint, ContainerEntrypointArgs, ContainerAppCommand, ContainerAppCommandArgsoch ContainerDefaultArgs kombineras för att bilda det slutliga kommandot som körs i containern. Detta beror mycket på om en ENTRYPOINT finns i basavbildningen. Den här egenskapen tar ett av tre värden: "DefaultArgs", "Entrypoint"eller "None".

• Entrypoint:
  • I det här läget definieras startpunkten av ContainerAppCommand, ContainerAppCommandArgsoch ContainerDefaultArgs.
• None:
  • I det här läget definieras startpunkten av ContainerEntrypoint, ContainerEntrypointArgsoch ContainerDefaultArgs.
• DefaultArgs:
  • Det här är det mest komplexa läget – om inget av objekten ContainerEntrypoint[Args] finns används ContainerAppCommand[Args] och ContainerDefaultArgs för att skapa startpunkten och kommandot. Basavbildningens startpunkt för basavbildningar som har hårdkodad till dotnet eller /usr/bin/dotnet hoppas över så att du har fullständig kontroll.
  • Om både ContainerEntrypoint och ContainerAppCommand finns blir det ContainerEntrypoint startpunkten och ContainerAppCommand blir kommandot .

ContainerUser

Egenskapen för användarkonfiguration styr standardanvändaren som containern körs som. Detta används ofta för att köra containern som en icke-root-användare, vilket är bästa praxis för säkerhet. Det finns några begränsningar för den här konfigurationen att känna till:

• Den kan ha olika former – användarnamn, linux-användar-ID: er, gruppnamn, linux-grupp-ID username:groupnameoch andra ID-varianter.
• Det finns ingen verifiering av att den angivna användaren eller gruppen finns på bilden.
• Att ändra användaren kan ändra appens beteende, särskilt när det gäller saker som filsystembehörigheter .

Standardvärdet för det här fältet varierar beroende på projektets TFM och måloperativsystemet:

• Om du riktar in dig på .NET 8 eller senare och använder Microsoft Runtime-avbildningarna:
  • på Linux används den rotlösa användaren app (även om den refereras av dess användar-ID)
  • i Windows används den rotlösa användaren ContainerUser
• Annars används inget standardvärde ContainerUser

<PropertyGroup>
  <ContainerUser>my-existing-app-user</ContainerUser>
</PropertyGroup>

Du kan dock styra hur appen körs med hjälp ContainerEntrypoint av och ContainerEntrypointArgs.

ContainerEntrypoint

Containerns startpunkt kan användas för att anpassa ENTRYPOINT containerns, vilket är den körbara fil som anropas när containern startas. För versioner som skapar en appvärd anges den som ContainerEntrypointsom standard . För versioner som inte skapar en körbar fil används den dotnet path/to/app.dll som ContainerEntrypoint.

Noden ContainerEntrypoint har ett enda attribut:

• Include: Kommandot, alternativet eller argumentet som ska användas i ContainerEntrypoint kommandot.

Tänk till exempel på följande exempel på .NET-projektobjektgrupp:

<ItemGroup Label="Entrypoint Assignment">
  <!-- This is how you would start the dotnet ef tool in your container -->
  <ContainerEntrypoint Include="dotnet" />
  <ContainerEntrypoint Include="ef" />

  <!-- This shorthand syntax means the same thing.
       Note the semicolon separating the tokens. -->
  <ContainerEntrypoint Include="dotnet;ef" />
</ItemGroup>

ContainerEntrypointArgs

Containerns startpunkt args-noden styr standardargumenten som tillhandahålls ContainerEntrypointtill . Detta bör användas när ContainerEntrypoint är ett program som användaren kanske vill använda på egen hand. Som standard skapas inga ContainerEntrypointArgs för din räkning.

Noden ContainerEntrypointArg har ett enda attribut:

• Include: Alternativet eller argumentet som ska tillämpas på ContainerEntrypoint kommandot.

Överväg följande exempel på .NET-projektobjektgrupp:

<ItemGroup>
  <!-- Assuming the ContainerEntrypoint defined above,
       this would be the way to update the database by
       default, but let the user run a different EF command. -->
  <ContainerEntrypointArgs Include="database" />
  <ContainerEntrypointArgs Include="update" />

  <!-- This is the shorthand syntax for the same idea -->
  <ContainerEntrypointArgs Include="database;update" />
</ItemGroup>