Go to file
Colin Walters a981e5fd76 checkout: Fix fsync defaults for new API to be off for real
My previous change in https://github.com/ostreedev/ostree/pull/425
actually broke things so we basically used the repository defaults =(

This is a subtle mess since we're only trying to flip things off
for the *new* API.

Clean this up so that the "default repo inheritance" lives only in one
place - in the compat layer for the old checkout API.  The new
checkout API defaults to off period, so the repository state is
irrelevant.

Closes: #520
Approved by: jlebon
2016-10-05 21:34:57 +00:00
apidoc libostree: new function ostree_repo_checkout_at 2016-07-30 11:24:52 +00: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 build: Import attributes.m4, detect CFLAGS at build time 2016-08-08 11:13:06 +00:00
contrib/golang contrib: indent golang code using only tabs instead of both tabs and spaces 2016-04-07 12:25:24 +00:00
docs docs: add mention of rpm-ostree package layering 2016-09-20 18:45:44 +00:00
libglnx@4ae5e3beaa Final excision of libgsystem dependency 2016-08-09 15:36:09 +00:00
man Fix spelling of "repository" 2016-10-01 18:50:41 +00:00
manual-tests tests/delta-crosscheck: Add missing --from 2016-07-29 14:30:42 +00:00
packaging Final excision of libgsystem dependency 2016-08-09 15:36:09 +00:00
src checkout: Fix fsync defaults for new API to be off for real 2016-10-05 21:34:57 +00:00
tests static-delta: add some error handling 2016-09-09 19:06:11 +00:00
.gitmodules bsdiff: change submodule location 2015-03-26 23:33:07 +01:00
.travis.yml travis: Disable email notifications 2016-08-09 17:36:39 +00: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
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 lib: Use sd_journal directly (optionally) 2016-06-21 18:24:17 +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 tests: add tests for contenturl and mirrorlist 2016-08-31 16:52:12 +00:00
Makefile.am build: Set --enable-man during distcheck 2016-09-01 19:03:23 +00: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: Fix broken link 2016-07-14 20:32:41 +00:00
TODO Fix repeated words. 2015-01-30 15:27:36 +01:00
autogen.sh libglnx porting: Migrate to new tempfile code 2016-07-29 19:02:41 +00:00
cfg.mk small cleanups 2016-04-08 18:43:18 +00:00
configure.ac Release 2016.10 2016-09-09 00:28:02 +00:00
git.mk Use git.mk 2016-04-07 12:49:40 +00:00
maint.mk tests: prefix invocation of ostree with where missing 2015-11-16 11:07:55 +01:00
mkdocs.yml docs: Add a section on repository management 2016-03-29 14:10:24 +00:00
ostree.doap doap category infrastructure 2014-07-31 11:26:32 +02: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.