docker / docker/cli

Suggestion: Docker images should have a "manifest" detailing the configuration options required to run a container

Open
#6,350 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

kind/feature status/0-triage
Dominant language
Go
Stars
6.1k
Forks
2.2k
Avg merge
1d 15h
Merged PRs (30d)
43

Description

Description

If you were to pick a random container from a registry, AFAIK there is currently no way to know what configuration the container needs to be run:

  • Ports: You may be able to interrogate to get a list of ports, but you don't know exactly what they are for, whether they are for a common protocol or something proprietary.
  • Environment variables: You don't know which need to be set, or what the values should be
  • File/volume mounts: You don't know what paths will be read for configuration or volumes that need to be remapped

Why

Tools that are supposed to make working with containers easier don't have the information required to be able to prompt or guess what details need to be passed in, you have to look at the documentation. Most tools don't know how to do that, or where to find it. If that information could be packaged with the container, it would make it much easier for a variety of tools such as:

  • Docker desktop UI - It could prompt for what is needed
  • Hosting services could prompt and provide sensible defaults
  • LLM based tools for working with compose files and kubernetes would be able to understand what each specific container needs, and be able to make more sensible options based on it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how Docker images currently expose configuration information for ports, environment variables, and file or volume mounts, and compare that with the proposed manifest needs. Done would require an agreed manifest format and a defined implementation and validation path; this issue does not name files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.