Skip to content

Remove "mkimage.sh" and associated scripts#41440

Merged
cpuguy83 merged 1 commit intomoby:masterfrom
tianon:rm-mkimage.sh
Oct 20, 2020
Merged

Remove "mkimage.sh" and associated scripts#41440
cpuguy83 merged 1 commit intomoby:masterfrom
tianon:rm-mkimage.sh

Conversation

@tianon
Copy link
Copy Markdown
Member

@tianon tianon commented Sep 11, 2020

I looked at fixing https://bugs.debian.org/969940, but these scripts haven't been materially changed in 2-3 years and better alternatives exist elsewhere, so we should probably just remove them instead.

(Consider this a request for comment from Moby maintainers and/or community members who might be using them 😅)

IMO, it would also make sense to remove the other mkimage-*.sh scripts (alpine, 3x arch ❗, crux, pld, yum), but I've been less directly involved in those so I'm not positive how much use they've seen (happy to throw them in here too if maintainers agree).

I looked at fixing https://bugs.debian.org/969940, but these scripts haven't been materially changed in 2-3 years and better alternatives exist elsewhere, so we should probably just remove them instead.

Signed-off-by: Tianon Gravi <[email protected]>
@cpuguy83
Copy link
Copy Markdown
Member

Maybe a link to a reference where the better alternatives exist, or update the ones in contrib to match the better ones?

@thaJeztah
Copy link
Copy Markdown
Member

I never used these myself; not sure how popular they are (if they're broken, probably not too popular ☺️)

Copy link
Copy Markdown
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@thaJeztah
Copy link
Copy Markdown
Member

a readme/link to alternatives would perhaps be nice yes (if we have some place to put it)

@tianon
Copy link
Copy Markdown
Member Author

tianon commented Sep 18, 2020

Sorry, yes, that's what I've been struggling with -- I don't think these are good examples anymore, or even great for folks to use. They don't have exact replacements, but functionally the idea is simply "generate some content and package it into an image via ADD tarball /. For things like Fedora, CentOS, etc. the relevant release teams publish official tarballs for use in Docker / chroots. For BusyBox, this wasn't a great way to create a BusyBox image to begin with (the result isn't exactly super useful). For Debian, you can get away with something as simple as debootstrap ... && tar -cC ... . | docker import.

If we remove this completely, I'm not sure where we'd put a note about alternatives, but also I'm not sure we really should -- either our documentation or better yet each project's documentation is a better place IMO.

We do have the following note on the whole contrib/ directory:

The contrib directory contains scripts, images, and other helpful things which are not part of the core docker distribution. Please note that they could be out of date, since they do not receive the same attention as the rest of the repository.

Copy link
Copy Markdown
Member

@cpuguy83 cpuguy83 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine with @tianon's explanation.

LGTM

@cpuguy83 cpuguy83 merged commit 73dc6a6 into moby:master Oct 20, 2020
@tianon tianon deleted the rm-mkimage.sh branch October 20, 2020 19:21
@thaJeztah thaJeztah added this to the 20.10.0 milestone Oct 20, 2020
@tianon
Copy link
Copy Markdown
Member Author

tianon commented Oct 20, 2020

Coming back to this from a fresh thought process, another way to put my sentiment is that these scripts are unmaintained, and the ecosystem at large is mature enough now that I don't think it's necessarily our responsibility to help users find alternatives -- these were really helpful when there weren't a lot of base images available, and now we're to the point where that's not remotely accurate (lots of folks have their own special base images these days). 😅

@thaJeztah
Copy link
Copy Markdown
Member

Agreed; makes sense

@tianon
Copy link
Copy Markdown
Member Author

tianon commented Jul 1, 2025

Looking at this now years later, I'm even more firmly of the opinion that we should remove all the contrib/mkimage-* scripts, if someone wanted to open a PR. 👀 ❤️

(They're all very outdated/unmaintained now.)

I'd even go slightly further and suggest we should consider including contrib/dockerize-disk.sh in the culling, but I feel less strongly about that one.

@thaJeztah
Copy link
Copy Markdown
Member

Yeah, I agree; at least, they haven't been maintained in Years; which may mean they still work, but could just as well be completely broken.

A quick look to see if I can find references to anyone using contrib/mkimage-XXX gives me 20 hits; https://grep.app/search?q=contrib%2Fmkimage-

The only potentially active reference I could find was this one;

All the other ones were either forked / inspired by, archived, or some docs linking;

@thaJeztah
Copy link
Copy Markdown
Member

So, yeah, I think it should be safe to just ditch those scripts.

@thaJeztah
Copy link
Copy Markdown
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants