Skip to content

Commit 2ad8afd

Browse files
committed
documentation for the new ContainerRuntimeIdentifier property
1 parent aeb099c commit 2ad8afd

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/ContainerCustomization.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ If you set a value here, you should set the fully-qualified name of the image to
2424
<ContainerBaseImage>mcr.microsoft.com/dotnet/runtime:6.0</ContainerBaseImage>
2525
```
2626

27+
## ContainerRuntimeIdentifier
28+
29+
This property controls the OS and platform used by your container if your [`ContainerBaseImage`](#containerbaseimage) is a 'Manifest List'. Manifest Lists are images that support more than one architecture behind a single, common, name. For example, the `mcr.microsoft.com/dotnet/runtime` image is a manifest list that supports `linux-x64`, `linux-arm`, `linux-arm64` and `win10-x64` images.
30+
31+
When a Manifest List is your base image, we need to choose the most relevant image to use as the base. We do this by choosing the image that best matches the `RuntimeIdentifier` of your project. If you set a value here, we will use that value to choose the best image to use as the base. Valid values for this property will vary based on the image you choose, but will always be in the form of a .NET SDK Runtime Identifier.
32+
33+
By default, if your project has a RuntimeIdentifier set, that value will be used. A RuntimeIdentifer is usually set via the `-r` parameter to the `dotnet publish` command, or by setting the `RuntimeIdentifier` property in a PublishProfile used from Visual Studio.
34+
35+
```xml
36+
<ContainerRuntimeIdentifier>linux-x64</ContainerRuntimeIdentifier>
37+
```
38+
2739
## ContainerRegistry
2840

2941
This property controls the destination registry - the place that the newly-created image will be pushed to.

0 commit comments

Comments
 (0)