Read the Introduction to Project Atomic for information about the goals and scope of the project.
The Quick Start Guide. will help you get Atomic up and running quickly.
When Atomic is up and running, read the Getting Started Guide to learn more about your new Atomic setup.
More In-depth Documentation
Updating the Atomic Host
Using rpm-ostree we can easily update the system in one "atomic" transaction, and roll back to the prior system if an update has any issues.
The Atomic (/usr/bin/atomic) Documentation explains how to use the atomic command on Atomic hosts. This command defines the entrypoint for Project Atomic hosts.
The goal of /usr/bin/atomic is to provide a high-level, coherent entrypoint to the system, and fill in gaps that are not filled by Linux container implementations.
Building New Images
The Building Docker Images provides guidelines on how to build new Docker images for your application deployments, and the Docker Image Author Guidance gives a set of explanations and tips which will help authoring new Docker images.
Containment and Security
Beyond the isolation provided by containers, Atomic relies on Security-Enhanced Linux to improve the security of the host and between containers, see Docker and SELinux for details of the increased protection available.
When an application is composed using multiple containers it can be a bit complex to provide for communication without losing flexibility. Learn about Atomic host networking options for single and multi-host configurations.
Atomic is a work in progress, and documentation needs to follow the pace of the developments.
To help achieve this, the documentation (as well as the whole
web site) is available from the
repository on GitHub as part of the
Most of the documents are simply written in the
plain text formatting syntax, they are as a result easy to edit and
extend. To change a document, clone the atomic site and make your edits under the
directory. If you add a new file please also register it in
. Then send us a pull request on GitHub or the resulting patch to the
mailing-list if you prefer. Thanks !
The web site itself is available in the
repository on GitHub, it is built using
framework, see the
at the top of the git checkout for informations. It also uses
for more complex formatting of some pages, check the
to get started editing some of the haml pages.