Контейнеризация приложения .NET с помощью dotnet publish

• Пакет SDK для .NET 8+
  Если у вас установлена платформа .NET, воспользуйтесь командой dotnet --info, чтобы определить используемую версию пакета SDK.
• Docker Community Edition.

• Пакет SDK для .NET 7+
  Если у вас установлена платформа .NET, воспользуйтесь командой dotnet --info, чтобы определить используемую версию пакета SDK.
• Docker Community Edition.

Добавление пакета NuGet

Пакет NuGet Microsoft.NET.Build.Container в настоящее время требуется для публикации не веб-проектов в качестве контейнера. Чтобы добавить пакет NuGet в рабочий Microsoft.NET.Build.Containers шаблон, выполните следующую команду dotnet add package :

dotnet add package Microsoft.NET.Build.Containers

По умолчанию имя образа контейнера — это AssemblyName проект. Если это имя недопустимо в качестве имени образа контейнера, его можно переопределить, указав следующий ContainerRepository файл проекта:

<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>

Дополнительные сведения см. в разделе ContainerRepository.

По умолчанию имя образа контейнера — это AssemblyName проект. Если это имя недопустимо в качестве имени образа контейнера, его можно переопределить, указав (ContainerImageName устаревшее) или предпочтительный ContainerRepository , как показано в следующем файле проекта:

<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>

Дополнительные сведения см. в разделе 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

Начиная с .NET 8, можно создать контейнер непосредственно в качестве архива tar.gz . Эта функция полезна, если рабочий процесс не прост и требует, чтобы вы, например, запустите средство сканирования по изображениям, прежде чем отправлять их. После создания архива его можно переместить, проверить или загрузить его в локальную цепочку инструментов Docker.

Чтобы опубликовать в архиве, добавьте ContainerArchiveOutputPath свойство в dotnet publish команду, например:

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

Можно указать имя папки или путь с определенным именем файла. Если указать имя папки, имя файла, созданное для архивного файла изображения, будет $(ContainerRepository).tar.gz. Эти архивы могут содержать несколько тегов внутри них, только так как для всех ContainerImageTagsсоздается один файл.

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

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

ContainerFamily

Начиная с .NET 8, вы можете использовать ContainerFamily свойство MSBuild для выбора другого семейства образов контейнеров, предоставляемых Корпорацией Майкрософт, в качестве базового образа для приложения. При установке это значение добавляется к концу выбранного тега TFM, изменяя предоставленный тег. Например, чтобы использовать варианты Alpine Linux базовых образов .NET, можно задать ContainerFamily следующие alpineзначения:

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

Предыдущая конфигурация проекта приводит к окончательному тегу 8.0-alpine для приложения для .NET 8-целевого приложения.

Это поле является бесплатным и часто можно использовать для выбора различных дистрибутивов операционной системы, конфигураций пакетов по умолчанию или любого другого варианта изменений базового образа. Это поле игнорируется при ContainerBaseImage установке. Дополнительные сведения см. в разделе образов контейнеров .NET.

ContainerRepository

Репозиторий контейнеров — это имя самого образа, например dotnet/runtime или my-app. По умолчанию AssemblyName используется проект.

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

ContainerImageName

Имя образа контейнера определяет имя самого образа, например dotnet/runtime или my-app. По умолчанию AssemblyName используется проект.

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

Начиная с .NET 8, если тег не указан по умолчанию latest.

По умолчанию Version проект используется в качестве значения тега.

Начиная с .NET 8, ContainerPort он выводится при явном указании на основе нескольких известных переменных среды ASP.NET:

• ASPNETCORE_URLS
• ASPNETCORE_HTTP_PORTS
• ASPNETCORE_HTTPS_PORTS

Если эти переменные среды присутствуют, их значения анализируются и преобразуются в сопоставления tcp-портов. Эти переменные среды считываются из базового образа, при наличии или из переменных среды, определенных в проекте, с помощью ContainerEnvironmentVariable элементов. Дополнительные сведения см. в разделе ContainerEnvironmentVariable.

Однако вы можете управлять выполнением приложения с помощью некоторых сочетаний ContainerAppCommand, ContainerAppCommandArgsа ContainerDefaultArgsContainerAppCommandInstructionтакже .

Эти разные точки конфигурации существуют, так как разные базовые образы используют различные сочетания контейнеров ENTRYPOINT и COMMAND свойств, и вы хотите иметь возможность поддерживать все из них. Значения по умолчанию должны использоваться для большинства приложений, но если вы хотите настроить поведение запуска приложения, необходимо:

• Определите двоичный файл для запуска и задайте его как ContainerAppCommand
• Определите, какие аргументы необходимы для запуска приложения, и задайте их как ContainerAppCommandArgs
• Определите, какие аргументы (если таковые имеются) являются необязательными и могут быть переопределены пользователем и задать их как ContainerDefaultArgs
• Задайте для ContainerAppCommandInstruction значение DefaultArgs.

Дополнительные сведения см. в следующих элементах конфигурации.

ContainerAppCommand

Элемент конфигурации команды приложения — это логическая точка входа приложения. Для большинства приложений это приложение AppHost, созданный исполняемый двоичный файл для вашего приложения. Если приложение не создает AppHost, эта команда обычно будет выполняться dotnet <your project dll>. Эти значения применяются после любого ENTRYPOINT в базовом контейнере или непосредственно, если он не ENTRYPOINT определен.

Конфигурация ContainerAppCommand имеет одно Include свойство, представляющее команду, параметр или аргумент для использования в команде точки входа:

<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

Этот элемент конфигурации команды приложения args представляет любые логически необходимые аргументы для приложения, которые должны применяться к нему ContainerAppCommand. По умолчанию для приложения не создается ни один из них. При наличии к контейнеру применяются args при выполнении.

Конфигурация ContainerAppCommandArgs имеет одно Include свойство, представляющее параметр или аргумент для применения к команде ContainerAppCommand .

<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

Этот элемент конфигурации args по умолчанию представляет любые переопределяемые пользователем аргументы для приложения. Это хороший способ предоставить значения по умолчанию, которые может потребоваться запустить приложение таким образом, чтобы упростить запуск, но по-прежнему легко настроить.

Конфигурация ContainerDefaultArgs имеет одно Include свойство, представляющее параметр или аргумент для применения к команде ContainerAppCommand .

<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

Конфигурация инструкций команды приложения помогает управлять способом ContainerEntrypoint, ContainerEntrypointArgsа ContainerAppCommandContainerAppCommandArgsтакже ContainerDefaultArgs объединяться для формирования окончательной команды, выполняемой в контейнере. Это зависит от того, присутствует ли в ENTRYPOINT базовом образе. Это свойство принимает одно из трех значений: "DefaultArgs", "Entrypoint"или "None".

• Entrypoint:
  • В этом режиме точка входа определяется ContainerAppCommandи ContainerAppCommandArgsContainerDefaultArgs.
• None:
  • В этом режиме точка входа определяется ContainerEntrypointи ContainerEntrypointArgsContainerDefaultArgs.
• DefaultArgs:
  • Это самый сложный режим, если ни один из ContainerEntrypoint[Args] элементов отсутствует, ContainerAppCommand[Args] он ContainerDefaultArgs используется для создания точки входа и команды. Точка входа базового образа для базовых образов с жесткой кодировкой dotnet или /usr/bin/dotnet пропускается таким образом, чтобы вы имели полный контроль.
  • Если оба ContainerEntrypoint и ContainerAppCommand есть, то ContainerEntrypoint становится точкой входа и ContainerAppCommand становится командой.

ContainerUser

Свойство конфигурации пользователя управляет пользователем по умолчанию, в котором выполняется контейнер. Это часто используется для запуска контейнера в качестве пользователя, не являющегося пользователем, который рекомендуется использовать для обеспечения безопасности. Существует несколько ограничений для этой конфигурации, которые следует учитывать:

• Она может принимать различные формы: имя пользователя, идентификаторы пользователей Linux, имя группы, идентификатор username:groupnameгруппы Linux и другие варианты идентификаторов.
• На изображении нет проверки наличия указанного пользователя или группы.
• Изменение пользователя может изменить поведение приложения, особенно в отношении таких действий, как разрешения файловой системы .

Значение по умолчанию этого поля зависит от проекта TFM и целевой операционной системы:

• Если вы используете .NET 8 или более поздней версии и используете образы среды выполнения Майкрософт, выполните следующие действия.
  • в Linux используется бессерверный пользователь app (хотя он ссылается на его идентификатор пользователя)
  • В Windows используется бессерверный пользователь ContainerUser
• В противном случае значение по умолчанию ContainerUser не используется

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

Однако вы можете управлять выполнением приложения с помощью ContainerEntrypoint и ContainerEntrypointArgs.

ContainerEntrypoint

Точку входа контейнера можно использовать для настройки ENTRYPOINT контейнера, который вызывается при запуске контейнера. По умолчанию для сборок, создающих узел приложения, он устанавливается в качестве ContainerEntrypoint. Для сборок, которые не создают исполняемый файл, dotnet path/to/app.dll он используется в качестве ContainerEntrypoint.

Узел ContainerEntrypoint имеет один атрибут:

• Include: команда, параметр или аргумент для использования в команде ContainerEntrypoint .

Например, рассмотрим следующую примерную группу элементов проекта .NET:

<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

Узел точки входа контейнера управляет аргументами по умолчанию, предоставленными для ContainerEntrypointузла. Это следует использовать, если ContainerEntrypoint программа, которую пользователь может использовать самостоятельно. По умолчанию не ContainerEntrypointArgs создаются от вашего имени.

Узел ContainerEntrypointArg имеет один атрибут:

• Include: параметр или аргумент для применения к команде ContainerEntrypoint .

Рассмотрим следующий пример группы элементов проекта .NET:

<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>