shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2024-10-27 10:25:07 +03:00
Code Issues Projects Releases Wiki Activity
Operating system and container binary deployment and upgrades
2,944 Commits 6 Branches 140 Tags 32 MiB
C 73.4%
Shell 15.4%
Rust 7.5%
Yacc 1%
M4 0.9%
Other 1.7%
7803fe1d60
Go to file
Colin Walters 7803fe1d60 Rename to libOSTree 
There are many motivating factors. The biggest is simply that at a practical
level, the command line is not sufficient to build a real system. The docs say
that it's a demo for the library. Let's make that more obvious, so people don't
try to use `ostree admin upgrade` for their real systems, and also don't use
e.g. `ostree commit` on the command line outside of test suites/quick hacking.

This change will also help clarify the role of rpm-ostree, which we will likely
be renamed to "nts". Then use of the term "ostree" will become much clearer. And
similarly for other people writing upgraders, they can say they use libostree.

I didn't try to change all of the docs and code at once, because it's going to
lead to conflicts.

The next big steps are:

  - Rename the github repo (github will inject a redirect)
  - Look at supporting a build where we don't do `ostree admin`, or at least
    it's only built for tests. We may want to split it off as a separate binary
    or so? That way people with their own upgraders don't need to ship it.

Closes: #659
Approved by: jlebon
2017-02-02 17:47:43 +00:00
apidoc Add support for more selective pruning 2017-01-19 16:28:00 +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
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: update pulp_ostree link 2017-01-26 15:20:54 +00:00
libglnx@abd37a4790 libglnx: Bump to master (for -fsanitize fixes) 2016-10-28 17:47:50 +00:00
man repo: Add unconfigured-state to remote config options 2016-12-09 17:46:54 +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 lib: Move the bupsplit selftest into our test framework 2017-02-02 16:51:36 +00:00
tests tests: Add setup for more realistic repo, change pull-many to use 2017-02-02 17:04:31 +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: Rebase to f25 2016-12-12 16:00:45 +00:00
.redhat-ci.yml ci: Combine UBSAN and ASAN by default 2016-12-09 18:05:53 +00:00
.travis.yml travis: Disable tests (but keep builds) on flaky distros 2017-02-01 20:57:34 +00: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 Rename to libOSTree 2017-02-02 17:47:43 +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 tests: prefix invocation of ostree with where missing 2015-11-16 11:07:55 +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: mark ostree_repo_checkout_tree_at as deprecated 2016-07-30 11:24:52 +00:00
Makefile-libostree.am libostree: Don't distribute generated enumtypes in tarballs 2017-01-31 22:30:37 +00:00
Makefile-man.am build: Actually distribute man page XML source 2016-09-01 19:23:49 +00:00
Makefile-ostree.am Split trivial-httpd into separate binary 2017-01-04 16:32:11 +00:00
Makefile-otutil.am lib: Use sd_journal directly (optionally) 2016-06-21 18:24:17 +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 tests: Add a big (many objects) pull 2017-01-23 17:29:02 +00:00
Makefile.am build: Set --enable-man during distcheck 2016-09-01 19:03:23 +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 Rename to libOSTree 2017-02-02 17:47:43 +00:00
TODO Fix repeated words. 2015-01-30 15:27:36 +01: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

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.