Skip to content

Container Build: Handle multiple tags wtihin one image #35138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 5, 2023
Merged

Container Build: Handle multiple tags wtihin one image #35138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 33 additions & 36 deletions src/Containers/Microsoft.NET.Build.Containers/ContainerBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ public static async Task<int> ContainerizeAsync(

bool isLocalPull = string.IsNullOrEmpty(baseRegistry);
Registry? sourceRegistry = isLocalPull ? null : new Registry(baseRegistry, logger);
ImageReference sourceImageReference = new(sourceRegistry, baseImageName, baseImageTag);
SourceImageReference sourceImageReference = new(sourceRegistry, baseImageName, baseImageTag);

bool isLocalPush = string.IsNullOrEmpty(outputRegistry);
Registry? destinationRegistry = isLocalPush ? null : new Registry(outputRegistry!, logger);
IEnumerable<ImageReference> destinationImageReferences = imageTags.Select(t => new ImageReference(destinationRegistry, imageName, t));
DestinationImageReference destinationImageReference = new DestinationImageReference(destinationRegistry, imageName, imageTags);

ImageBuilder? imageBuilder;
if (sourceRegistry is { } registry)
Expand Down Expand Up @@ -120,48 +120,45 @@ public static async Task<int> ContainerizeAsync(
BuiltImage builtImage = imageBuilder.Build();
cancellationToken.ThrowIfCancellationRequested();

foreach (ImageReference destinationImageReference in destinationImageReferences)
if (isLocalPush)
{
if (isLocalPush)
ILocalRegistry containerRegistry = KnownLocalRegistryTypes.CreateLocalRegistry(localRegistry, loggerFactory);
if (!(await containerRegistry.IsAvailableAsync(cancellationToken).ConfigureAwait(false)))
{
ILocalRegistry containerRegistry = KnownLocalRegistryTypes.CreateLocalRegistry(localRegistry, loggerFactory);
if (!(await containerRegistry.IsAvailableAsync(cancellationToken).ConfigureAwait(false)))
{
Console.WriteLine(DiagnosticMessage.ErrorFromResourceWithCode(nameof(Strings.LocalRegistryNotAvailable)));
return 7;
}
Console.WriteLine(DiagnosticMessage.ErrorFromResourceWithCode(nameof(Strings.LocalRegistryNotAvailable)));
return 7;
}

try
{
await containerRegistry.LoadAsync(builtImage, sourceImageReference, destinationImageReference, cancellationToken).ConfigureAwait(false);
logger.LogInformation(Strings.ContainerBuilder_ImageUploadedToLocalDaemon, destinationImageReference.RepositoryAndTag);
}
catch (Exception ex)
{
Console.WriteLine(DiagnosticMessage.ErrorFromResourceWithCode(nameof(Strings.RegistryOutputPushFailed), ex.Message));
return 1;
}
try
{
await containerRegistry.LoadAsync(builtImage, sourceImageReference, destinationImageReference, cancellationToken).ConfigureAwait(false);
logger.LogInformation(Strings.ContainerBuilder_ImageUploadedToLocalDaemon, destinationImageReference);
}
else
catch (Exception ex)
{
try
{
if (destinationImageReference.Registry is not null)
{
await (destinationImageReference.Registry.PushAsync(
builtImage,
sourceImageReference,
destinationImageReference,
cancellationToken)).ConfigureAwait(false);
logger.LogInformation(Strings.ContainerBuilder_ImageUploadedToRegistry, destinationImageReference.RepositoryAndTag, destinationImageReference.Registry.RegistryName);
}
}
catch (Exception e)
Console.WriteLine(DiagnosticMessage.ErrorFromResourceWithCode(nameof(Strings.RegistryOutputPushFailed), ex.Message));
return 1;
}
}
else
{
try
{
if (destinationImageReference.Registry is not null)
{
Console.WriteLine(DiagnosticMessage.ErrorFromResourceWithCode(nameof(Strings.RegistryOutputPushFailed), e.Message));
return 1;
await (destinationImageReference.Registry.PushAsync(
builtImage,
sourceImageReference,
destinationImageReference,
cancellationToken)).ConfigureAwait(false);
logger.LogInformation(Strings.ContainerBuilder_ImageUploadedToRegistry, destinationImageReference, destinationImageReference.Registry.RegistryName);
}
}
catch (Exception e)
{
Console.WriteLine(DiagnosticMessage.ErrorFromResourceWithCode(nameof(Strings.RegistryOutputPushFailed), e.Message));
return 1;
}
}
return 0;
}
Expand Down
25 changes: 25 additions & 0 deletions src/Containers/Microsoft.NET.Build.Containers/DestinationImageReference.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.NET.Build.Containers;

/// <summary>
/// Represents a push destination reference to a Docker image.
/// A push destination reference is made of a registry, a repository (aka the image name) and multiple tags.
/// (unlike the <see cref="SourceImageReference"/> which has a single tag)
/// </summary>
internal readonly record struct DestinationImageReference(Registry? Registry, string Repository, string[] Tags)
{
public override string ToString()
{
string tagList = string.Join(", ", Tags);
if (Registry is { } reg)
{
return $"{reg.RegistryName}/{Repository}:{tagList}";
}
else
{
return $"{Repository}:{tagList}";
}
}
}
11 changes: 6 additions & 5 deletions src/Containers/Microsoft.NET.Build.Containers/LocalDaemons/DockerCli.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public DockerCli(ILoggerFactory loggerFactory) : this(null, loggerFactory)
return command;
}

public async Task LoadAsync(BuiltImage image, ImageReference sourceReference, ImageReference destinationReference, CancellationToken cancellationToken)
public async Task LoadAsync(BuiltImage image, SourceImageReference sourceReference, DestinationImageReference destinationReference, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
string dockerPath = FindFullPathFromPath("docker") ?? "docker";
Expand Down Expand Up @@ -196,7 +196,7 @@ internal static JsonDocument GetConfig()

private static void Proc_OutputDataReceived(object sender, DataReceivedEventArgs e) => throw new NotImplementedException();

private static async Task WriteImageToStreamAsync(BuiltImage image, ImageReference sourceReference, ImageReference destinationReference, Stream imageStream, CancellationToken cancellationToken)
private static async Task WriteImageToStreamAsync(BuiltImage image, SourceImageReference sourceReference, DestinationImageReference destinationReference, Stream imageStream, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
using TarWriter writer = new(imageStream, TarEntryFormat.Pax, leaveOpen: true);
Expand Down Expand Up @@ -241,10 +241,11 @@ private static async Task WriteImageToStreamAsync(BuiltImage image, ImageReferen
}

// Add manifest
JsonArray tagsNode = new()
JsonArray tagsNode = new();
foreach (string tag in destinationReference.Tags)
{
destinationReference.RepositoryAndTag
};
tagsNode.Add($"{destinationReference.Repository}:{tag}");
}

JsonNode manifestNode = new JsonArray(new JsonObject
{
Expand Down
2 changes: 1 addition & 1 deletion src/Containers/Microsoft.NET.Build.Containers/LocalDaemons/ILocalRegistry.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ internal interface ILocalRegistry {
/// <summary>
/// Loads an image (presumably from a tarball) into the local registry.
/// </summary>
public Task LoadAsync(BuiltImage image, ImageReference sourceReference, ImageReference destinationReference, CancellationToken cancellationToken);
public Task LoadAsync(BuiltImage image, SourceImageReference sourceReference, DestinationImageReference destinationReference, CancellationToken cancellationToken);

/// <summary>
/// Checks to see if the local registry is available. This is used to give nice errors to the user.
Expand Down
11 changes: 7 additions & 4 deletions src/Containers/Microsoft.NET.Build.Containers/Registry/Registry.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ private async Task UploadBlobAsync(string repository, string digest, Stream cont

}

public async Task PushAsync(BuiltImage builtImage, ImageReference source, ImageReference destination, CancellationToken cancellationToken)
public async Task PushAsync(BuiltImage builtImage, SourceImageReference source, DestinationImageReference destination, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
Registry destinationRegistry = destination.Registry!;
Expand Down Expand Up @@ -425,8 +425,11 @@ public async Task PushAsync(BuiltImage builtImage, ImageReference source, ImageR
_logger.LogInformation(Strings.Registry_ManifestUploaded, RegistryName);

//tag upload
_logger.LogInformation(Strings.Registry_TagUploadStarted, destination.Tag, RegistryName);
await _registryAPI.Manifest.PutAsync(destination.Repository, destination.Tag, builtImage.Manifest, cancellationToken).ConfigureAwait(false);
_logger.LogInformation(Strings.Registry_TagUploaded, destination.Tag, RegistryName);
foreach (string tag in destination.Tags)
{
_logger.LogInformation(Strings.Registry_TagUploadStarted, tag, RegistryName);
await _registryAPI.Manifest.PutAsync(destination.Repository, tag, builtImage.Manifest, cancellationToken).ConfigureAwait(false);
_logger.LogInformation(Strings.Registry_TagUploaded, tag, RegistryName);
}
}
}
10 changes: 7 additions & 3 deletions ...ft.NET.Build.Containers/ImageReference.cs → ....Build.Containers/SourceImageReference.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@ namespace Microsoft.NET.Build.Containers;
/// <summary>
/// Represents a reference to a Docker image. A reference is made of a registry, a repository (aka the image name) and a tag.
/// </summary>
internal readonly record struct ImageReference(Registry? Registry, string Repository, string Tag) {
internal readonly record struct SourceImageReference(Registry? Registry, string Repository, string Tag)
{
public override string ToString()
{
if (Registry is { } reg) {
if (Registry is { } reg)
{
return $"{reg.RegistryName}/{Repository}:{Tag}";
} else {
}
else
{
return RepositoryAndTag;
}
}
Expand Down
79 changes: 38 additions & 41 deletions src/Containers/Microsoft.NET.Build.Containers/Tasks/CreateNewImage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ internal async Task<bool> ExecuteAsync(CancellationToken cancellationToken)
}

Registry? sourceRegistry = IsLocalPull ? null : new Registry(BaseRegistry, logger);
ImageReference sourceImageReference = new(sourceRegistry, BaseImageName, BaseImageTag);
SourceImageReference sourceImageReference = new(sourceRegistry, BaseImageName, BaseImageTag);

Registry? destinationRegistry = IsLocalPush ? null : new Registry(OutputRegistry, logger);
IEnumerable<ImageReference> destinationImageReferences = ImageTags.Select(t => new ImageReference(destinationRegistry, Repository, t));
DestinationImageReference destinationImageReference = new DestinationImageReference(destinationRegistry, Repository, ImageTags);

ImageBuilder? imageBuilder;
if (sourceRegistry is { } registry)
Expand Down Expand Up @@ -114,54 +114,51 @@ internal async Task<bool> ExecuteAsync(CancellationToken cancellationToken)
GeneratedContainerConfiguration = builtImage.Config;
GeneratedContainerDigest = builtImage.Manifest.GetDigest();

foreach (ImageReference destinationImageReference in destinationImageReferences)
if (IsLocalPush)
{
if (IsLocalPush)
ILocalRegistry localRegistry = KnownLocalRegistryTypes.CreateLocalRegistry(LocalRegistry, msbuildLoggerFactory);
if (!(await localRegistry.IsAvailableAsync(cancellationToken).ConfigureAwait(false)))
{
ILocalRegistry localRegistry = KnownLocalRegistryTypes.CreateLocalRegistry(LocalRegistry, msbuildLoggerFactory);
if (!(await localRegistry.IsAvailableAsync(cancellationToken).ConfigureAwait(false)))
{
Log.LogErrorWithCodeFromResources(nameof(Strings.LocalRegistryNotAvailable));
return false;
}
try
{
await localRegistry.LoadAsync(builtImage, sourceImageReference, destinationImageReference, cancellationToken).ConfigureAwait(false);
SafeLog("Pushed image '{0}' to local registry", destinationImageReference.RepositoryAndTag);
}
catch (AggregateException ex) when (ex.InnerException is DockerLoadException dle)
{
Log.LogErrorFromException(dle, showStackTrace: false);
}
Log.LogErrorWithCodeFromResources(nameof(Strings.LocalRegistryNotAvailable));
return false;
}
else
try
{
await localRegistry.LoadAsync(builtImage, sourceImageReference, destinationImageReference, cancellationToken).ConfigureAwait(false);
SafeLog("Pushed image '{0}' to local registry", destinationImageReference);
}
catch (AggregateException ex) when (ex.InnerException is DockerLoadException dle)
{
Log.LogErrorFromException(dle, showStackTrace: false);
}
}
else
{
try
{
try
if (destinationImageReference.Registry is not null)
{
if (destinationImageReference.Registry is not null)
{
await destinationImageReference.Registry.PushAsync(
builtImage,
sourceImageReference,
destinationImageReference,
cancellationToken).ConfigureAwait(false);
SafeLog("Pushed image '{0}' to registry '{1}'", destinationImageReference, OutputRegistry);
}
await destinationImageReference.Registry.PushAsync(
builtImage,
sourceImageReference,
destinationImageReference,
cancellationToken).ConfigureAwait(false);
SafeLog("Pushed image '{0}' to registry '{1}'", destinationImageReference, OutputRegistry);
}
catch (ContainerHttpException e)
}
catch (ContainerHttpException e)
{
if (BuildEngine != null)
{
if (BuildEngine != null)
{
Log.LogErrorFromException(e, true);
}
Log.LogErrorFromException(e, true);
}
catch (Exception e)
}
catch (Exception e)
{
if (BuildEngine != null)
{
if (BuildEngine != null)
{
Log.LogErrorWithCodeFromResources(nameof(Strings.RegistryOutputPushFailed), e.Message);
Log.LogMessage(MessageImportance.Low, "Details: {0}", e);
}
Log.LogErrorWithCodeFromResources(nameof(Strings.RegistryOutputPushFailed), e.Message);
Log.LogMessage(MessageImportance.Low, "Details: {0}", e);
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions src/Tests/Microsoft.NET.Build.Containers.IntegrationTests/CreateNewImageTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,8 +239,8 @@ public async System.Threading.Tasks.Task CreateNewImage_RootlessBaseImage()

BuiltImage builtImage = imageBuilder.Build();

var sourceReference = new ImageReference(registry, DockerRegistryManager.RuntimeBaseImage, DockerRegistryManager.Net8PreviewImageTag);
var destinationReference = new ImageReference(registry, RootlessBase, "latest");
var sourceReference = new SourceImageReference(registry, DockerRegistryManager.RuntimeBaseImage, DockerRegistryManager.Net8PreviewImageTag);
var destinationReference = new DestinationImageReference(registry, RootlessBase, new[] { "latest" });

await registry.PushAsync(builtImage, sourceReference, destinationReference, cancellationToken: default).ConfigureAwait(false);

Expand Down
4 changes: 2 additions & 2 deletions src/Tests/Microsoft.NET.Build.Containers.IntegrationTests/DockerRegistryTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ public async Task WriteToPrivateBasicRegistry()
var ridgraphfile = ToolsetUtils.GetRuntimeGraphFilePath();
Registry mcr = new Registry(DockerRegistryManager.BaseImageSource, logger);

var sourceImage = new ImageReference(mcr, DockerRegistryManager.RuntimeBaseImage, DockerRegistryManager.Net6ImageTag);
var destinationImage = new ImageReference(localAuthed, DockerRegistryManager.RuntimeBaseImage, DockerRegistryManager.Net6ImageTag);
var sourceImage = new SourceImageReference(mcr, DockerRegistryManager.RuntimeBaseImage, DockerRegistryManager.Net6ImageTag);
var destinationImage = new DestinationImageReference(localAuthed, DockerRegistryManager.RuntimeBaseImage,new[] { DockerRegistryManager.Net6ImageTag });
ImageBuilder? downloadedImage = await mcr.GetImageManifestAsync(
DockerRegistryManager.RuntimeBaseImage,
DockerRegistryManager.Net6ImageTag,
Expand Down
Loading