Go to file
Simon McVittie 384b7abbd9 Make build-time test failures non-fatal if 3 out of 5 attempts succeed
There are several upstream bugs that cause intermittent test failures,
and can intermittently be reproduced in real use. However, these are not
regressions, so we should not FTBFS just because we happen to have been
unlucky during build.
2016-12-01 12:33:59 +00:00
apidoc New upstream version 2016.14 2016-11-29 01:10:29 +00:00
bsdiff New upstream version 2016.11 2016-10-07 21:52:21 +01:00
build-aux New upstream version 2016.11 2016-10-07 21:52:21 +01:00
buildutil New upstream version 2016.14 2016-11-29 01:10:29 +00:00
debian Make build-time test failures non-fatal if 3 out of 5 attempts succeed 2016-12-01 12:33:59 +00:00
libglnx New upstream version 2016.13 2016-11-20 15:41:33 +00:00
man New upstream version 2016.14 2016-11-29 01:10:29 +00:00
src New upstream version 2016.14 2016-11-29 01:10:29 +00:00
tests New upstream version 2016.14 2016-11-29 01:10:29 +00:00
COPYING COPYING: Update to latest FSF with current address 2014-01-16 10:22:30 -05:00
Makefile-boot.am Move ostree-* executables to /usr/lib/ostree 2016-08-11 14:04:59 +00:00
Makefile-decls.am ostree_bootdir: properly preprend $(prefix) 2016-08-11 15:52:28 +00:00
Makefile-libostree-defines.am libostree: mark ostree_repo_checkout_tree_at as deprecated 2016-07-30 11:24:52 +00:00
Makefile-libostree.am libostree: mark ostree_repo_checkout_tree_at as deprecated 2016-07-30 11:24:52 +00:00
Makefile-man.am build: Actually distribute man page XML source 2016-09-01 19:23:49 +00:00
Makefile-ostree.am remote: Add commands to add and remove cookies for a remote 2016-11-05 17:34:09 +00:00
Makefile-otutil.am lib: Use sd_journal directly (optionally) 2016-06-21 18:24:17 +00:00
Makefile-switchroot.am switchroot: Fix build on Ubuntu 2016-09-01 20:17:58 +00:00
Makefile-tests.am pull: Add support for `http-headers` option 2016-11-16 10:04:22 +00:00
Makefile.am build: Set --enable-man during distcheck 2016-09-01 19:03:23 +00:00
Makefile.in New upstream version 2016.14 2016-11-29 01:10:29 +00:00
README.md README: Fix broken link 2016-07-14 20:32:41 +00:00
TODO Fix repeated words. 2015-01-30 15:27:36 +01:00
aclocal.m4 New upstream version 2016.11 2016-10-07 21:52:21 +01:00
autogen.sh libglnx porting: Migrate to new tempfile code 2016-07-29 19:02:41 +00:00
config.h.in New upstream version 2016.11 2016-10-07 21:52:21 +01:00
configure New upstream version 2016.14 2016-11-29 01:10:29 +00:00
configure.ac Release 2016.14 2016-11-23 16:20:49 +00:00
gtk-doc.make New upstream version 2016.11 2016-10-07 21:52:21 +01:00

README.md

OSTree

New! See the docs online at Read The Docs (OSTree)


OSTree is a tool that combines a "git-like" model for committing and downloading bootable filesystem trees, along with a layer for deploying them and managing the bootloader configuration.

OSTree is like git in that it checksums individual files and has a content-addressed-object store. It's unlike git in that it "checks out" the files via hardlinks, and they should thus be immutable. Therefore, another way to think of OSTree is that it's just a more polished version of Linux VServer hardlinks.

Features:

  • Atomic upgrades and rollback for the system
  • Replicating content incrementally over HTTP via GPG signatures and "pinned TLS" support
  • Support for parallel installing more than just 2 bootable roots
  • Binary history on the server side (and client)
  • Introspectable shared library API for build and deployment systems

This last point is important - you should think of the OSTree command line as effectively a "demo" for the shared library. The intent is that package managers, system upgrade tools, container build tools and the like use OSTree as a "deduplicating hardlink store".

Projects using OSTree

rpm-ostree is a tool that uses OSTree as a shared library, and supports committing RPMs into an OSTree repository, and deploying them on the client. This is appropriate for "fixed purpose" systems. There is in progress work for more sophisticated hybrid models, deeply integrating the RPM packaging with OSTree.

Project Atomic uses rpm-ostree to provide a minimal host for Docker formatted Linux containers. Replicating a base immutable OS, then using Docker for applications meshes together two different tools with different tradeoffs.

flatpak uses OSTree for desktop application containers.

GNOME Continuous is a custom build system designed for OSTree, using OpenEmbedded in concert with a custom build system to do continuous delivery from hundreds of git repositories.

Building

Releases are available as GPG signed git tags, and most recent versions support extended validation using git-evtag.

However, in order to build from a git clone, you must update the submodules. If you're packaging OSTree and want a tarball, I recommend using a "recursive git archive" script. There are several available online; this code in OSTree is an example.

Once you have a git clone or recursive archive, building is the same as almost every autotools project:

env NOCONFIGURE=1 ./autogen.sh
./configure --prefix=...
make
make install DESTDIR=/path/to/dest

More documentation

New! See the docs online at Read The Docs (OSTree)

Some more information is available on the old wiki page: https://wiki.gnome.org/Projects/OSTree

Contributing

See Contributing.