Container:Guidelines

This page is a draft only
It is still under construction and content may change. Do not rely on the information on this page.

Container Maintainer Guidelines

In the Fedora world, the concept of being a Package Maintainer is well known as all the software currently released and published as an official "Build Artifact" of the Fedora Project for inclusion in the Fedora GNU/Linux distribution has always been packaged in RPM Package Manager Format.

However, as technology changes so must the Fedora Project. The concept of "containers" on Linux has become quite prominent and Fedora will be publishing container images as officially released Build Artifact. One thing to note is that containers images are not a new software packaging format but more so a delivery mechanism where many different things such be easily shipped as a single unit. An example of this is packages that can be combined to deliver an easily ran "software solution".

Below you will find Guidelines similar in nature to that of the Fedora Packaging Guidelines but catered towards the concept of Containers. Initially Fedora will be targeting the Docker container implemention but there are many and others will likely be incorporated in the future.

Container Guidelines

The Container Guidelines are a collection of common issues and the severity that should be placed on them. While these guidelines should not be ignored, they should also not be blindly followed. If you think that your container should be exempt from part of the Guidelines, please bring the issue to the Fedora Container Committee (Pending Existence). In the absence of a Fedora Container Committee, please seek guidance from the Fedora Cloud SIG|.

Docker Containers (Dockerfile)

Docker images are built using a Dockerfile much in the same way an RPM is built using a spec file. In this section are Fedora Guidelines for creating Docker images using a Dockerfile.

Dockerfile Guidelines Upstream
These guidelines are a Fedora adaptation of the Upstream Project Atomic effort to define Container Best Practices.

LABELS

Dockerfiles have a concept of a LABEL which can add arbitrary metadata to an image as a key-value pair. Fedora Guidelines on the topic of LABELs follows the Project Atomic Container Application Generic Labels standards for LABEL definition.

Required LABELs for a Fedora Docker Image are as follows:

Name	Description
Name	Name of the Image
Version	Version of the image
Release	Release Number for this version
Architecture	Architecture the software in the image should target (Optional: if omitted, it will be built for all supported Fedora Architectures)

These LABELs should be defined in a single line of the Dockerfile. The following is a very simple Dockerfile example containing the required LABELs:

FROM fedora
MAINTAINER "Adam Miller" <maxamillion@fedoraproject.org>

ENV VERSION=0.1 RELEASE=1
LABEL BZComponent="myawesomecontainer" \
        Name="fedora/myawesomecontainer" \
        Version="$VERSION" \
        Release="$RELEASE" \
        Architecture="x86_64"
CMD printf "My Awesome Container!\n"

Content

Dockerfiles in Fedora should not contain net new code, which is unfortunately subjective in nature. The meaning of this is that software should be packaged properly as RPMs and placed in the Fedora repositories, Dockerfiles are simply a deliver mechanism for pre-defined "ready to run" configurations. This can be achieved as an Atomic App or similar. Any content that is to accompany the Dockerfile must either be configuration files or startup/orchestration scripts. The goal of this is such that we follow the key points of the Fedora Release Engineering Philosophy.

Discussion

See Talk:PackagingDrafts/Go for discussion.