Skip to content
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.

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

Undocument arch-specific tags on .NET appliance images #5946

Closed
2 of 3 tasks
jander-msft opened this issue Oct 3, 2024 · 2 comments
Closed
2 of 3 tasks

Undocument arch-specific tags on .NET appliance images #5946

jander-msft opened this issue Oct 3, 2024 · 2 comments

Comments

@jander-msft
Copy link
Member

jander-msft commented Oct 3, 2024

Describe the Problem

The appliance-style (dotnet/monitor and dotnet/aspire-dashboard) and sample (dotnet/samples) images have various tags for describing the product version, the architecture, and distro of the image. While distro information has been removed in newer releases, the architecture and product version information remains. The tag listing for these images can be intimidating due to the matrix of possibilities and may lead to choice paralysis or confusion as to which tag should be used.

Upon further reflection, the tag matrix can be greatly simplified if the arch-specific tags are removed or undocumented. An example simplification in this manner is described for the sample images in #5918. Using dotnet/monitor:8 Ubuntu Chiseled as another example, the tag listing would be simplified from:

8.0.4-ubuntu-chiseled-amd64, 8.0-ubuntu-chiseled-amd64, 8-ubuntu-chiseled-amd64, 8.0.4-ubuntu-chiseled, 8.0-ubuntu-chiseled, 8-ubuntu-chiseled, 8.0.4, 8.0, 8, latest

to

8.0.4-ubuntu-chiseled, 8.0-ubuntu-chiseled, 8-ubuntu-chiseled, 8.0.4, 8.0, 8, latest

Describe the Solution

  • For dotnet/aspire-dashboard:8* images, all arch-specific tags are to be undocumented to prevent breaking changes in current usage.
  • For dotnet/monitor:9* and lower version images, all arch-specific tags are to be undocumented to prevent breaking changes in current usage.
  • For dotnet/samples images, all arch-specific tags are to be removed.

For dotnet/monitor/base, all arch-specific tags are to remain since this is a base image used for adding extensions upon it, which may require native dependencies or may have native entrypoints.

Additional Context

The arch-specific tags are largely useful for images that are meant to be used as base images upon which derivative images are produced, especially if native dependencies are added in the deriving image. Given that the appliance-style and sample images are intended to be used as-is (not expected to be derived), the arch-specific tags do not provide much value. The assumption is that the vast majority use case is that users will use the manifest tags as-is without needing to further specify the platform. If needed, users can specify platform information on container tooling (such as docker run --platform linux/amd64 or FROM --platform linux/amd64 within Dockerfiles) to specify which architecture should be used.

@jander-msft
Copy link
Member Author

I've updated the issue to reflect that arch-specific tags of .NET Monitor 9 and lower are to be undocumented rather than having a bifurcation of treatment between 9 vs 8 and lower.

@jander-msft jander-msft changed the title Remove arch-specific tags from appliance-style and sample images Undocument/remove arch-specific tags on appliance-style and sample images Oct 7, 2024
@lbussell
Copy link
Contributor

This proposal is documented in detail in this announcement: New tagging scheme for .NET Monitor, Aspire Dashboard, and samples (dotnet/dotnet-docker#5961)

@jander-msft, since Simplify dotnet/samples tags tables by un-documenting arch specific tags (#5918) already exists, what do you say we "re-target" this issue to refer to appliance-style images only, and close it since they have been undocumented. We can track the samples work with #5918.

And we can open two/three new issues for removing the tags completely (Samples, Monitor, and Aspire Dashboard).

@lbussell lbussell changed the title Undocument/remove arch-specific tags on appliance-style and sample images Undocument arch-specific tags on .NET appliance images Oct 14, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in .NET Docker Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

2 participants