singularityhub / sregistry

server for storage and management of singularity images
https://singularityhub.github.io/sregistry
Mozilla Public License 2.0
103 stars 42 forks source link

Add description for containers #381

Open xiaojinghu93 opened 2 years ago

xiaojinghu93 commented 2 years ago

Hi, all,

We've deployed sregistry in our clusters, of which the software and hardware environments are both quite complex. We'd like to add descriptions to containers to help users/developers grasp infos like the architecture, the version, the compiler and so on.

Currently we have to differentiate the containers by name(with long suffix).

Sregistry's already provided a separate page for each container. It would be nice if the description can be displayed and edited on that page.

Please feel free to close this issue if you are not interested in it. Or if you have better alternatives(better than long suffix), please share it with me.

Thanks in advance!

vsoch commented 2 years ago

Yep, can definitely add this! And likely we can store with the container metadata so the database doesn’t need a migration. And you’d be ok with editing the interface to add the description?

mine more suggestion I’ll make in terms of labels is to use org.opencontainers.image.description - it’s currently used by GitHub packages containers for the same goal.

I should have some time to work on this soon.

vsoch commented 2 years ago

okay, please review https://github.com/singularityhub/sregistry/pull/382 !