Operating system and container binary deployment and upgrades
Go to file
Colin Walters 8c1542134c lib/repo: Enable locking by default, but drop external API
The code has been sitting around for a while but since I disabled
it by default, I doubt anyone is really using it or relying on it.

This patch and turns on locking by default, and also drops the
API which was only public in the experimental API builds.
Conceptually these are two distinct things, and we
may actually want to split up the patches.

I don't think this will break anyone, but it's hard to say for sure.
It's also going to be hard to find out until we actually release
I suspect...

But anyone who is broken should be able to add `locking=false` into
their repo config.  On the flip side Endless has been shipping with
this enabled and it is reported to help.

The reason to drop the APIs: I'm a bit concerned about the interactions over time
between libostree's use of the API and any apps that start using it.
For example, if an app specifies a SHARED lock in their code, then
later internally we decide to temporarily grab an `EXCLUSIVE`, but the
app had a second thread/process that was `EXCLUSIVE` already, and
that process was waiting on the first bit of code, then we could
deadlock. I can't think of a real world situation where this would happen
yet though.

We are likely to in the future have say `fsck` take an external lock,
`checkout` grab a shared one, etc.

Closes: #1555
Approved by: jlebon
2018-04-30 17:24:51 +00:00
apidoc lib/repo: Enable locking by default, but drop external API 2018-04-30 17:24:51 +00:00
bash bash-completion: Remove admin completions 2018-02-27 13:56:11 +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 Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00:00
ci ci: drop BDB1539 workaround 2018-04-24 13:16:59 +00:00
coccinelle tree-wide: Add+run spatch to use glnx_throw() 2017-05-26 19:27:11 +00:00
docs docs: Dual license under CC BY-SA and the GFDL 2018-02-05 14:31:16 +00:00
libglnx@0c82203cd4 main, status: Factor out deployment printing into helper 2018-03-19 17:15:27 +00:00
man man: Add man page for create-usb 2018-04-19 13:35:15 +00:00
manual-tests Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00:00
rust rust/bupsplit: minor idiomatic fixes 2018-03-17 19:59:06 +00:00
src lib/repo: Enable locking by default, but drop external API 2018-04-30 17:24:51 +00:00
tests lib/repo: Enable locking by default, but drop external API 2018-04-30 17:24:51 +00:00
.dir-locals.el .dir-locals.el: Standard Emacs indentation config 2017-01-12 16:09:34 +00:00
.editorconfig Add a .vimrc and .editorconfig 2017-09-21 22:03:11 +00:00
.gitmodules bsdiff: change submodule location 2015-03-26 23:33:07 +01:00
.papr.yml ci: mark some ci testsuites as required again 2018-04-23 17:29:13 +00:00
.travis.yml ci: Move travis scripts from tests/ → ci/ 2017-05-09 18:25:13 +00:00
.vimrc Add a .vimrc and .editorconfig 2017-09-21 22:03:11 +00:00
autogen.sh Make sure *.am.inc are up to date before make dist 2017-10-16 13:53:06 +00:00
cfg.mk tests: Add a test case for path traversal in a dirtree 2018-01-12 19:38:34 +00:00
configure.ac Post-release version bump 2018-03-22 21:07:11 +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
git.mk Use git.mk 2016-04-07 12:49:40 +00:00
GNUmakefile Add infrastructure for "make syntax-check" 2015-01-30 15:27:36 +01:00
maint.mk build/maint.mk: Comment out setting of LC_ALL 2017-08-23 17:41:06 +00:00
Makefile-bash.am Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00:00
Makefile-boot.am Add concept of "staged" deployment 2018-04-12 14:55:12 +00:00
Makefile-decls.am Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00:00
Makefile-libostree-defines.am Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00:00
Makefile-libostree.am Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00:00
Makefile-man.am man: Add man page for create-usb 2018-04-19 13:35:15 +00:00
Makefile-ostree.am Add concept of "staged" deployment 2018-04-12 14:55:12 +00:00
Makefile-otutil.am Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00:00
Makefile-switchroot.am switchroot: Fix split source/build directory 2018-02-05 15:26:22 +00:00
Makefile-tests.am Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00:00
Makefile.am Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00: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-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: Fix docs link to COPYING 2018-04-30 14:33:37 +00:00
TODO Fix repeated words. 2015-01-30 15:27:36 +01:00

libostree

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


This project is now known as "libostree", though it is still appropriate to use the previous name: "OSTree" (or "ostree"). The focus is on projects which use libostree's shared library, rather than users directly invoking the command line tools (except for build systems). However, in most of the rest of the documentation, we will use the term "OSTree", since it's slightly shorter, and changing all documentation at once is impractical. We expect to transition to the new name over time.

As implied above, libostree is both a shared library and suite of command line tools 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.

The core OSTree model 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:

  • Transactional 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
  • Flexible support for multiple branches and repositories, supporting projects like flatpak which use libostree for applications, rather than hosts.

Projects using OSTree

meta-updater is a layer available for OpenEmbedded systems.

QtOTA is Qt's over-the-air update framework which uses libostree.

rpm-ostree is a next-generation hybrid package/image system for Fedora and CentOS, used by the Atomic Host project. By default it uses libostree to atomically replicate a base OS (all dependency resolution is done on the server), but it supports "package layering", where additional RPMs can be layered on top of the base. This brings a "best of both worlds"" model for image and package systems.

flatpak uses libostree for desktop application containers. Unlike most of the other systems here, flatpak does not use the "libostree host system" aspects (e.g. bootloader management), just the "git-like hardlink dedup". For example, flatpak supports a per-user OSTree repository.

Endless OS uses libostree for their host system as well as flatpak. See their eos-updater and deb-ostree-builder projects.

GNOME Continuous is where OSTree was born - as a high performance continuous delivery/testing system for GNOME.

The BuildStream build and integration tool uses libostree as a caching system to store and share built artifacts.

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:

git submodule update --init
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)

Contributing

See Contributing.

Licensing

The licensing for the code of libostree can be canonically found in the individual files; and the overall status in the COPYING file in the source. Currently, that's LGPLv2+.

The license for the documentation of libostree is: SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)