Operating system and container binary deployment and upgrades
Go to file
Colin Walters d25212f04a tests: Port to glib-tap.mk, make make check run all of the tests
OSTree's code for testing predates the `glib-tap.mk` making its
way into GLib.  Let's switch to it, as it provides a number
of advantages.

By far the biggest advantage is that `make check` can start to run
most of the tests *in addition* to having them work installed.

This commit keeps the installed tests working, but `make check` turns
out to be really broken because...our TAP usage has bitrotted to say
the least.  Fix that all up.

Do some hacks so that the tests work uninstalled as well - in
particular, `glib-tap.mk` and the bits encoded into
`g_test_build_filename()` assume *recursive* Automake (blah).  Work
around that by creating a symlink when installed to loop back.
2016-03-03 08:50:19 -05:00
apidoc ostree-repo: new public function ostree_repo_list_refs_ext 2016-03-02 14:52:02 -05:00
bsdiff@1edf9f6568 bsdiff: change submodule location 2015-03-26 23:33:07 +01:00
build-aux Add infrastructure for "make syntax-check" 2015-01-30 15:27:36 +01:00
buildutil tests: Port to glib-tap.mk, make make check run all of the tests 2016-03-03 08:50:19 -05:00
docs docs: Add a blurb on the summary file 2016-02-27 11:28:54 -05:00
libglnx@769522753c repo: Port -refs.c to openat() 2016-01-28 14:57:13 -05:00
man refs: Add argument --list to print the full ref name 2016-03-02 14:53:14 -05:00
manual-tests Fix make syntax-check 2016-03-01 10:08:25 -05:00
packaging packaging: Add a fuse subpackage 2016-02-17 11:06:53 -05:00
src refs: Add argument --list to print the full ref name 2016-03-02 14:53:14 -05:00
tests tests: Port to glib-tap.mk, make make check run all of the tests 2016-03-03 08:50:19 -05:00
.gitignore Update .gitignore 2015-08-08 21:53:43 -04:00
.gitmodules bsdiff: change submodule location 2015-03-26 23:33:07 +01:00
autogen.sh build: Make gtk-doc optional 2015-06-29 16:08:51 -04:00
cfg.mk tests: Port to glib-tap.mk, make make check run all of the tests 2016-03-03 08:50:19 -05:00
configure.ac tests: Port to glib-tap.mk, make make check run all of the tests 2016-03-03 08:50:19 -05:00
CONTRIBUTING.md Rewrite manual in mkdocs 2016-01-28 09:31:37 -05:00
COPYING COPYING: Update to latest FSF with current address 2014-01-16 10:22:30 -05:00
GNUmakefile Add infrastructure for "make syntax-check" 2015-01-30 15:27:36 +01:00
maint.mk tests: prefix invocation of ostree with where missing 2015-11-16 11:07:55 +01:00
Makefile-boot.am syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
Makefile-decls.am libostree: Add initial GRUB2 support 2014-10-16 14:15:00 -04:00
Makefile-libostree-defines.am build: ostree-gpg-verify-result.h is a public header, install it 2015-03-20 10:56:23 -04:00
Makefile-libostree.am lib: Introduce versioned symbols 2016-03-01 21:45:26 -05:00
Makefile-man.am Add an export builtin, and API to write to libarchive 2016-02-14 09:53:01 -05:00
Makefile-ostree.am build: Link ostree with libarchive 2016-02-22 11:22:24 -05:00
Makefile-otutil.am libotutil: Establish a place for GPG utilities 2015-05-01 10:20:34 -04:00
Makefile-switchroot.am Add support for mkinitcpio 2013-10-24 14:27:49 -04:00
Makefile-tests.am tests: Port to glib-tap.mk, make make check run all of the tests 2016-03-03 08:50:19 -05:00
Makefile.am tests: Port to glib-tap.mk, make make check run all of the tests 2016-03-03 08:50:19 -05:00
mkdocs.yml docs: Add a new formats section, move static deltas in there 2016-02-22 14:06:20 -05:00
ostree.doap doap category infrastructure 2014-07-31 11:26:32 +02:00
README-historical.md README: Just link to wiki, move most of it to README-historical.md 2014-01-20 18:00:09 -05:00
README.md README.md: Update to link to Read The Docs, describe a bit better 2016-02-08 14:35:24 +01:00
TODO Fix repeated words. 2015-01-30 15:27:36 +01:00

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.

xdg-app 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.