Git Product home page Git Product logo

shortnames's Introduction

containers/shortnames

Short-Name Aliasing

What is a short name

When tools like Podman or Docker pull container images, users prefer to use short names like fedora or alpine rather then fully specified image names registry.fedoraproject.org/fedora and docker.io/alpine, respectively. In container engines that allow you to specify more then a single registry for storing container images, using short names can lead to ambiguity.

Imagine that I have two registries defined and both contain an image named "foobar". Now if I specify foobar, I am not sure which image I will get. There is potential for malicious parties to take advantage of this by spoofing images and tricking users into pulling them.

We are building into these container engine tools the ability to use short name aliases to help mitigate the risk of pulling the wrong image, especially when the image is a well known short name.

Similar to aliases in shells such as Bash, a short-name alias has a left-hand name that is being replaced with a right-hand value. Short-name aliases can now be configured in the 'registries.conf' file as follows:

unqualified-search-registries=["registry.fedoraproject.org", "docker.io"]

[aliases]
"fedora"="registry.fedoraproject.org/fedora"

All aliases must be specified in the new “aliases” table. Using the above 'registries.conf' file, Podman will resolve “fedora” immediately and securely to “registry.fedoraproject.org/fedora”. We are currently assembling a public list of short-name aliases that can be used across the community. Multiple Linux distributions and companies have expressed interest in collaborating with the container engines, to help registry their images.

Goal

The goal of this REPO is to gather a list of shortnames from the community, to allow distributions to ship them in their distributions. The idea is this list could be added to the default 'registries.conf' file shipped by a distro.

This list is in the open to guarantee fairness. We do not want this to be a free for all land grab, so we will base the list of images on images at well known registries and distributions.

In the case of a conflicts, we will base the shortname on the original source of the image. For example if the Fedora image is available at 'docker.io' as well as at 'registry.fedoraproject.org', we will grab it from fedoraproject.

I am sure over time their might be further rules designed if this turns out to be a problem.

Of course distributions are always free to make changes to this list if/when they ship it.

Contributing

Please verify that you are not conflicting with existing shortnames, or state your case on why your shortname should replace the existing short names.

Shipping and Packaging Short-Name Aliases

The configuration file is intended to be shipped in the /etc/containers/registries.conf.d directory. This directory allows for supporting drop-in registries.conf configuration files that are loaded in alpha-numerical order. Users can easily add new files manually or via config managers such as Ansible or Salt. Please refer to the upstream documentation of the containers/image library to read more about the registries.conf format, and the loading behavior.

Contact

  • IRC: #containers on libera.chat (Webchat)

shortnames's People

Contributors

carlwgeorge avatar conan-kudo avatar dcermak avatar djelibeybi avatar elboulangero avatar fatherlinux avatar haircommander avatar inglor avatar jaboutboul avatar jamescassell avatar kpcyrd avatar luap99 avatar ml- avatar nalind avatar neilhanlon avatar paniklab avatar rabattkarte avatar rahilarious avatar rcristiano avatar rhatdan avatar salewski avatar siretart avatar sysrich avatar thesuess avatar vrothberg avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

shortnames's Issues

Do not reserve unrelated short names

At the time of writing, the list includes aliases for short names that the respective projects should decide and not the distribution.

For instance:

"inkscape" = "registry.fedoraproject.org/inkscape"

Inkscape does not belong to Fedora and as such it should not auto-resolve to the Fedora registry. Only Fedora images should resolve to it.

@rhatdan PTAL

Add a license?

I haven't found a license attached to this project, which could be problematic for redistribution. Could we add one?

I am not a lawyer, thus I am not sure if shortnames.conf qualifies as copyrightable, but my approach would have been better safe than sorry.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.