Support publishing of multi-architecture OCI container images

src/Containers/Microsoft.NET.Build.Containers/ImageBuilder.cs

@@ -320,6 +320,12 @@ static string[] Split(string input)
         }
     }
 
+    // For tests
+    internal string GetManifestConfigDigest()
+    {
+        return _manifest.Config.digest;
+    }
+
     internal static class EnvironmentVariables
     {
         public static readonly string APP_UID = nameof(APP_UID);

src/Containers/Microsoft.NET.Build.Containers/ImageIndexGenerator.cs

@@ -0,0 +1,128 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Text.Json;
+using System.Text.Json.Nodes;
+using Microsoft.NET.Build.Containers.Resources;
+using Microsoft.NET.Build.Containers.Tasks;
+
+namespace Microsoft.NET.Build.Containers;
+
+internal struct ImageInfo
+{
+    internal string Config { get; init; }
+    internal string ManifestDigest { get; init; }
+    internal string Manifest { get; init; }
+    internal string ManifestMediaType { get; init; }
+}
+
+internal static class ImageIndexGenerator
+{
+    /// <summary>
+    /// Generates an image index from the given images.
+    /// </summary>
+    /// <param name="imageInfos"></param>
+    /// <returns>Returns json string of image index and image index mediaType.</returns>
+    /// <exception cref="ArgumentException"></exception>
+    /// <exception cref="NotSupportedException"></exception>
+    internal static (string, string) GenerateImageIndex(ImageInfo[] imageInfos)
+    {
+        if (imageInfos.Length == 0)
+        {
+            throw new ArgumentException(string.Format(Strings.ImagesEmpty));
+        }
+
+        string firstManifestMediaType = imageInfos[0].ManifestMediaType;
+
+        if (firstManifestMediaType == SchemaTypes.DockerManifestV2)
+        {
+            return GenerateDockerManifestList(imageInfos, firstManifestMediaType);
+        }
+        else if (firstManifestMediaType == SchemaTypes.OciManifestV1)
+        {
+            return GenerateOciImageIndex(imageInfos, firstManifestMediaType);
+        }
+        else
+        {
+            throw new NotSupportedException(string.Format(Strings.UnsupportedMediaType, firstManifestMediaType));
+        }
+    }
+
+    private static (string, string) GenerateDockerManifestList(ImageInfo[] images, string firstManifestMediaType)
+    {
+        var manifests = new PlatformSpecificManifest[images.Length];
+        for (int i = 0; i < images.Length; i++)
+        {
+            var image = images[i];
+
+            if (i > 0 && image.ManifestMediaType != firstManifestMediaType)
+            {
+                throw new ArgumentException(Strings.MixedMediaTypes);
+            }
+
+            var manifest = new PlatformSpecificManifest
+            {
+                mediaType = firstManifestMediaType,
+                size = image.Manifest.Length,
+                digest = image.ManifestDigest,
+                platform = GetArchitectureAndOsFromConfig(image)
+            };
+            manifests[i] = manifest;
+        }
+
+        var dockerManifestList = new ManifestListV2
+        {
+            schemaVersion = 2,
+            mediaType = SchemaTypes.DockerManifestListV2,
+            manifests = manifests
+        };
+
+        return (JsonSerializer.SerializeToNode(dockerManifestList)?.ToJsonString() ?? "", dockerManifestList.mediaType);
+    }
+
+    private static (string, string) GenerateOciImageIndex(ImageInfo[] images, string firstManifestMediaType)
+    {
+        var manifests = new PlatformSpecificOciManifest[images.Length];
+        for (int i = 0; i < images.Length; i++)
+        {
+            var image = images[i];
+
+            if (i > 0 && image.ManifestMediaType != firstManifestMediaType)
+            {
+                throw new ArgumentException(Strings.MixedMediaTypes);
+            }
+
+            var manifest = new PlatformSpecificOciManifest
+            {
+                mediaType = firstManifestMediaType,
+                size = image.Manifest.Length,
+                digest = image.ManifestDigest,
+                platform = GetArchitectureAndOsFromConfig(image)
+            };
+            manifests[i] = manifest;
+        }
+
+        var ociImageIndex = new ImageIndexV1
+        {
+            schemaVersion = 2,
+            mediaType = SchemaTypes.OciImageIndexV1,
+            manifests = manifests
+        };
+
+        return (JsonSerializer.SerializeToNode(ociImageIndex)?.ToJsonString() ?? "", ociImageIndex.mediaType);
+    }
+
+    private static PlatformInformation GetArchitectureAndOsFromConfig(ImageInfo image)
+    {
+        var configJson = JsonNode.Parse(image.Config) as JsonObject ??
+            throw new ArgumentException($"{nameof(image.Config)} should be a JSON object.", nameof(image.Config));
+
+        var architecture = configJson["architecture"]?.ToString() ??
+            throw new ArgumentException($"{nameof(image.Config)} should contain 'architecture'.", nameof(image.Config));
+
+        var os = configJson["os"]?.ToString() ??
+            throw new ArgumentException($"{nameof(image.Config)} should contain 'os'.", nameof(image.Config));
+
+        return new PlatformInformation { architecture = architecture, os = os };
+    }
+}

src/Containers/Microsoft.NET.Build.Containers/PublicAPI/net472/PublicAPI.Unshipped.txt

@@ -62,6 +62,8 @@ Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedContainerDigest.get
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedContainerDigest.set -> void
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedArchiveOutputPath.get -> string!
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedArchiveOutputPath.set -> void
+Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedContainerMediaType.get -> string!
+Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedContainerMediaType.set -> void
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.Repository.get -> string!
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.Repository.set -> void
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.ImageTags.get -> string![]!
@@ -123,8 +125,8 @@ Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.IsTrimmed.get
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.IsTrimmed.set -> void
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.IsSelfContained.get -> bool
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.IsSelfContained.set -> void
-Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.TargetRuntimeIdentifier.get -> string!
-Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.TargetRuntimeIdentifier.set -> void
+Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.TargetRuntimeIdentifiers.get -> string![]!
+Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.TargetRuntimeIdentifiers.set -> void
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.UsesInvariantGlobalization.get -> bool
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.UsesInvariantGlobalization.set -> void
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag

src/Containers/Microsoft.NET.Build.Containers/PublicAPI/net8.0/PublicAPI.Unshipped.txt

@@ -12,12 +12,27 @@ Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.IsTrimmed.get
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.IsTrimmed.set -> void
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.IsSelfContained.get -> bool
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.IsSelfContained.set -> void
-Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.TargetRuntimeIdentifier.get -> string!
-Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.TargetRuntimeIdentifier.set -> void
+Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.TargetRuntimeIdentifiers.get -> string![]!
+Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.TargetRuntimeIdentifiers.set -> void
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.UserBaseImage.get -> string?
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.UserBaseImage.set -> void
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.UsesInvariantGlobalization.get -> bool
 Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.UsesInvariantGlobalization.set -> void
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.Cancel() -> void
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.CreateImageIndex() -> void
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.Dispose() -> void
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.GeneratedImageIndex.get -> string!
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.GeneratedImageIndex.set -> void
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.ImageTags.get -> string![]!
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.ImageTags.set -> void
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.GeneratedContainers.get -> Microsoft.Build.Framework.ITaskItem![]!
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.GeneratedContainers.set -> void
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.OutputRegistry.get -> string!
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.OutputRegistry.set -> void
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.Repository.get -> string!
+Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.Repository.set -> void
+override Microsoft.NET.Build.Containers.Tasks.CreateImageIndex.Execute() -> bool
 static readonly Microsoft.NET.Build.Containers.Constants.Version -> string!
 Microsoft.NET.Build.Containers.ContainerHelpers
 Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
@@ -196,6 +211,8 @@ Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedContainerDigest.get
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedContainerDigest.set -> void
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedArchiveOutputPath.get -> string!
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedArchiveOutputPath.set -> void
+Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedContainerMediaType.get -> string!
+Microsoft.NET.Build.Containers.Tasks.CreateNewImage.GeneratedContainerMediaType.set -> void
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.Repository.get -> string!
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.Repository.set -> void
 Microsoft.NET.Build.Containers.Tasks.CreateNewImage.ImageTags.get -> string![]!

src/Containers/Microsoft.NET.Build.Containers/Registry/DefaultManifestOperations.cs

@@ -41,7 +41,13 @@ public async Task<HttpResponseMessage> GetAsync(string repositoryName, string re
     public async Task PutAsync(string repositoryName, string reference, ManifestV2 manifest, string mediaType, CancellationToken cancellationToken)
     {
         string jsonString = JsonSerializer.SerializeToNode(manifest)?.ToJsonString() ?? "";
-        HttpContent manifestUploadContent = new StringContent(jsonString);
+
+        await PutAsync(repositoryName, reference, jsonString, mediaType, cancellationToken).ConfigureAwait(false);
+    }
+
+    public async Task PutAsync(string repositoryName, string reference, string manifestJson, string mediaType, CancellationToken cancellationToken)
+    {
+        HttpContent manifestUploadContent = new StringContent(manifestJson);
         manifestUploadContent.Headers.ContentType = new MediaTypeHeaderValue(mediaType);
 
         HttpResponseMessage putResponse = await _client.PutAsync(new Uri(_baseUri, $"/v2/{repositoryName}/manifests/{reference}"), manifestUploadContent, cancellationToken).ConfigureAwait(false);

src/Containers/Microsoft.NET.Build.Containers/Registry/IManifestOperations.cs

@@ -15,4 +15,6 @@ internal interface IManifestOperations
     public Task<HttpResponseMessage> GetAsync(string repositoryName, string reference, CancellationToken cancellationToken);
 
     public Task PutAsync(string repositoryName, string reference, ManifestV2 manifest, string mediaType, CancellationToken cancellationToken);
+
+    public Task PutAsync(string repositoryName, string reference, string manifestListJson, string mediaType, CancellationToken cancellationToken);
 }

src/Containers/Microsoft.NET.Build.Containers/Registry/Registry.cs

@@ -6,9 +6,7 @@
 using NuGet.RuntimeModel;
 using System.Diagnostics;
 using System.Net.Http.Json;
-using System.Text.Json;
 using System.Text.Json.Nodes;
-using System.Text.RegularExpressions;
 
 namespace Microsoft.NET.Build.Containers;
 
@@ -527,6 +525,17 @@ private async Task UploadBlobAsync(string repository, string digest, Stream cont
 
     }
 
+    public async Task PushManifestListAsync(string repositoryName, string[] tags, string manifestListJson, string mediaType, CancellationToken cancellationToken)
+    {
+        cancellationToken.ThrowIfCancellationRequested();
+        foreach (var tag in tags)
+        {
+            _logger.LogInformation(Strings.Registry_TagUploadStarted, tag, RegistryName);
+            await _registryAPI.Manifest.PutAsync(repositoryName, tag, manifestListJson, mediaType, cancellationToken).ConfigureAwait(false);
+            _logger.LogInformation(Strings.Registry_TagUploaded, tag, RegistryName);
+        }          
+    }
+
     public Task PushAsync(BuiltImage builtImage, SourceImageReference source, DestinationImageReference destination, CancellationToken cancellationToken)
         => PushAsync(builtImage, source, destination, pushTags: true, cancellationToken);