packaging
/
ostree
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
3,012 Commits 2 Branches 0 Tags 18 MiB
C 50.8%
HTML 20.8%
Shell 13.9%
Makefile 12.4%
Yacc 0.7%
Other 1.3%
Go to file
Colin Walters df5cbc9be9 core: Support building with OpenSSL for checksums 
Add an OpenSSL backend to the checksum input stream, which is where we do a lot
of checksumming (object commit, static deltas).

The raw OpenSSL performance is
[approximately double](https://gist.github.com/cgwalters/169349fd1c06fd4fb4d3a7ce33303222) on
my laptop; not only does OpenSSL have e.g. hand-tuned x86_64 assembly, the
current implementation uses the
[Intel SHA extensions](https://en.wikipedia.org/wiki/Intel_SHA_extensions).

Another reason to do this is I was idly thinking about adding
[Curve25519](https://en.wikipedia.org/wiki/Curve25519) signatures (like e.g.
Alpine does) instead of/in addition to GPG.  The rationale for that is
that GPG is pretty heavyweight, both in code footprint and the simple
fact that EC keys are way smaller.

I didn't benchmark ostree with this; we have bigger performance problems
really like the fact we just malloc way too much.  But, it's a step
in the right direction I think in combination with the libcurl work
where we're linking to openssl anyways.

Closes: #738
Approved by: jlebon
 		2017-03-20 18:32:40 +00:00
apidoc core: Add runtime ostree_check_version() 2017-03-13 14:29:02 +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 Terminate individual tests after (10 * $TEST_TIMEOUT_FACTOR) minutes 2016-12-01 18:22:51 +00:00
docs doc: fix typo in CONTRIBUTING 2017-02-03 19:05:40 +00:00
libglnx@5309e363aa libglnx: bump for -Wmaybe-uninitialized fix 2017-03-02 20:35:24 +00:00
man checkout: Support a "pure addition" mode 2017-03-06 20:58:04 +00:00
manual-tests tests/delta-crosscheck: Add missing --from 2016-07-29 14:30:42 +00:00
rust rust: Support `make dist` -> cargo vendor 2017-02-07 16:50:37 +00:00
src core: Support building with OpenSSL for checksums 2017-03-20 18:32:40 +00:00
tests Avoid unnecessary includes 2017-03-10 21:46:50 +00:00
.dir-locals.el .dir-locals.el: Standard Emacs indentation config 2017-01-12 16:09:34 +00:00
.gitmodules bsdiff: change submodule location 2015-03-26 23:33:07 +01:00
.redhat-ci.Dockerfile ci: Install PyYAML 2017-02-17 21:38:14 +00:00
.redhat-ci.yml core: Support building with OpenSSL for checksums 2017-03-20 18:32:40 +00:00
.travis.yml libcurl backend 2017-02-09 16:37:45 +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 build-sys: Minor makefile tweaks 2017-01-04 16:32:11 +00:00
Makefile-libostree-defines.am libostree: add versioning macros 2017-03-11 15:38:56 +00:00
Makefile-libostree.am lib: Exclude soup header from introspection 2017-03-13 15:20:45 +00:00
Makefile-man.am build: Actually distribute man page XML source 2016-09-01 19:23:49 +00:00
Makefile-ostree.am libostree: add versioning macros 2017-03-11 15:38:56 +00:00
Makefile-otutil.am lib: Add a private copy of checksum-instream 2017-03-20 18:32:40 +00:00
Makefile-switchroot.am build: clean up ostree-remount if building without systemd 2016-11-29 14:11:50 +00:00
Makefile-tests.am upgrade: Add support for --pull-only and --deploy-only 2017-02-27 20:57:23 +00:00
Makefile.am main: Make ostree --version output YAML (and add gitrev) 2017-02-22 18:57:18 +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.md: Add more/clean up links to consuming projects 2017-02-21 16:34:14 +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 core: Support building with OpenSSL for checksums 2017-03-20 18:32:40 +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

libOSTree

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

This project is now known as "libOSTree", renamed from "OSTree"; the focus is on the shared library. 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.

libOSTree is a 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:

  • 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

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.

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.