docker
Revision of current Docker Hub limitation for 25,000 characters in description field
Tell us about your request Revision of current Docker Hub limitation for 25,000 characters in description field.
Which service(s) is this request for? Docker Hub
Tell us about the problem you're trying to solve. What are you trying to do, and why is it hard? Given that support for hosting Helm charts was recently introduced, perhaps current limitation should be revised. My general impression is that the documentation for Helm charts is potentially much more extensive than image documentation.
For instance, the company I work for hosts Helm charts on Docker Hub, but is unable to push it's documentation because of this limit and is forced to keep in on a remote host. Typical Helm chart documentation size for those charts is about 50,000 characters, so my suggestion is that new limit should be set to at least 50k-100k characters (maybe even only for Helm artifacts?).
Are you currently working around the issue? Current workaround is to keep documentation on a remote host, which is more complex to implement and maintain.
EDIT: The workaround is especially problematic if you want to use private Helm charts, forcing users to authenticate twice, plus the maintenance of the additional auth service itself...
Would introducing a link format to host the descriptions separately be a wiser choice then just increasing the limit? If I understand the previous concerns leading to the Limit correctly, docker hub is trying to keep API Bandwidth Usage as low as possible. Could someone (maybe this should even be picked up by the OCI container standard?) allow a standardized description link so hubs like docker could pull the description from a provided link? This could reduce the API Bandwidth usage to a few Bytes and allow effectively unlimited length descriptions.
The API could become transparent for pushes by providing a tool (maybe a docker plugin) to split the description off on image creation.
@modellking This proposal is probably fine for public artifacts and documentation, but what if both artifact and external documentation are in private registries? Maybe some hybrid solution would work - link for public repos and increased limit for private?
@nkuzman I'm not against raising the limit, but I do not see the use case, if links are automatically fetched: A private repo / descriptions host still is somehow identifiable (URI). A internal Link should suffice for internal use-cases, and so on...
It actually seems to migrate quite intuitively for the use case of a public description while the image is not - a public URI in a private container. This isn't even a use-case for a embedded description. I think we can safely ignore public Image + private Description.
@modellking The use case is a private Helm chart (requires authentication to Docker Hub) with documentation hosted on a private web server (requires another authentication).
This is inconvenient for several reasons:
- Requires maintenance of a separate web server for hosting documentation only
- End user is forced to authenticate twice in order to see Helm chart documentation - once to Docker Hub and once to private web server
- Authentications potentially requires different credentials so that's another inconvenience for end user
