f82f825fed
OSTree has some logic to preserve comment lines in the BLS fragments, but the BLS fragments are always created on new deployments so the comments are never carried. Also, OSTree never writes BLS fragments with comments so these will only be present in BLS files that were modified outside of OSTree. Something that should be avoided in general. Finally, there is a bug in the logic that causes BLS files to have lines with only a newline character. The ostree_bootconfig_parser_parse_at() function reads the bootconfig file using glnx_fd_readall_utf8() but this function NUL terminates the returned string with the file contents. So when the string is later split using '\n' as delimiter, the last token is set to '\0' and a wrong GVariant will be added to the lines GPtrArray in the OstreeBootconfigParser struct. This will lead to bootconfig files that contains lines with only a newline character, since the key in the GVariant would be set to NUL and won't be present in the options GHashTable of the OstreeBootconfigParser struct. So let's just remove that logic since is never used and makes BLS files to have wrong empty lines. Before this patch: $ tail -n 4 /boot/loader/entries/ostree-1-testos.conf | hexdump -C 00000000 74 69 74 6c 65 20 54 65 73 74 4f 53 20 34 32 20 |title TestOS 42 | 00000010 32 30 31 39 30 38 32 34 2e 30 20 28 6f 73 74 72 |20190824.0 (ostr| 00000020 65 65 29 0a 0a 0a 0a |ee)....| 00000027 After this patch: $ tail -n 4 /boot/loader/entries/ostree-1-testos.conf | hexdump -C 00000000 76 65 72 73 69 6f 6e 20 31 0a 6f 70 74 69 6f 6e |version 1.option| 00000010 73 20 72 6f 6f 74 3d 4c 41 42 45 4c 3d 4d 4f 4f |s root=LABEL=MOO| 00000020 20 71 75 69 65 74 20 6f 73 74 72 65 65 3d 2f 6f | quiet ostree=/o| 00000030 73 74 72 65 65 2f 62 6f 6f 74 2e 31 2f 74 65 73 |stree/boot.1/tes| 00000040 74 6f 73 2f 61 65 34 36 34 39 36 38 30 64 33 65 |tos/ae4649680d3e| 00000050 38 33 62 32 34 65 34 37 66 38 64 66 31 30 38 31 |83b24e47f8df1081| 00000060 38 62 66 36 39 38 39 64 36 34 37 61 62 32 38 38 |8bf6989d647ab288| 00000070 64 31 63 30 39 38 30 36 65 34 61 33 36 61 34 65 |d1c09806e4a36a4e| 00000080 62 62 66 36 2f 30 0a 6c 69 6e 75 78 20 2f 6f 73 |bbf6/0.linux /os| 00000090 74 72 65 65 2f 74 65 73 74 6f 73 2d 61 65 34 36 |tree/testos-ae46| 000000a0 34 39 36 38 30 64 33 65 38 33 62 32 34 65 34 37 |49680d3e83b24e47| 000000b0 66 38 64 66 31 30 38 31 38 62 66 36 39 38 39 64 |f8df10818bf6989d| 000000c0 36 34 37 61 62 32 38 38 64 31 63 30 39 38 30 36 |647ab288d1c09806| 000000d0 65 34 61 33 36 61 34 65 62 62 66 36 2f 76 6d 6c |e4a36a4ebbf6/vml| 000000e0 69 6e 75 7a 2d 33 2e 36 2e 30 0a 74 69 74 6c 65 |inuz-3.6.0.title| 000000f0 20 54 65 73 74 4f 53 20 34 32 20 32 30 31 39 30 | TestOS 42 20190| 00000100 38 32 34 2e 30 20 28 6f 73 74 72 65 65 29 0a |824.0 (ostree).| 0000010f Closes: #1904 Approved by: cgwalters |
||
|---|---|---|
| apidoc | ||
| bash | ||
| bsdiff@1edf9f6568 | ||
| build-aux | ||
| buildutil | ||
| ci | ||
| coccinelle | ||
| docs | ||
| libglnx@b1cb19b6b2 | ||
| man | ||
| manual-tests | ||
| rust | ||
| src | ||
| tests | ||
| .dir-locals.el | ||
| .editorconfig | ||
| .gitmodules | ||
| .papr-ex.yaml | ||
| .papr.yml | ||
| .travis.yml | ||
| .vimrc | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| GNUmakefile | ||
| Makefile-bash.am | ||
| Makefile-boot.am | ||
| Makefile-decls.am | ||
| Makefile-libostree-defines.am | ||
| Makefile-libostree.am | ||
| Makefile-man.am | ||
| Makefile-ostree.am | ||
| Makefile-otutil.am | ||
| Makefile-switchroot.am | ||
| Makefile-tests.am | ||
| Makefile.am | ||
| README-historical.md | ||
| README.md | ||
| TODO | ||
| autogen.sh | ||
| cfg.mk | ||
| configure.ac | ||
| git.mk | ||
| maint.mk | ||
| mkdocs.yml | ||
| ostree.doap | ||
README.md
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 thus need to be immutable to prevent corruption. 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.
Operating systems and distributions using OSTree
Endless OS uses libostree for their host system as well as flatpak. See their eos-updater and deb-ostree-builder projects.
Fedora derivatives use rpm-ostree (noted below); there are 3 variants using OSTree:
Red Hat Enterprise Linux CoreOS is a derivative of Fedora CoreOS, used in OpenShift 4. The machine-config-operator manages upgrades. RHEL CoreOS is also the successor to RHEL Atomic Host, which uses rpm-ostree as well.
GNOME Continuous is where OSTree was born - as a high performance continuous delivery/testing system for GNOME.
Liri OS has the option to install their distribution using ostree.
Distribution build tools
meta-updater is a layer available for OpenEmbedded systems.
QtOTA is Qt's over-the-air update framework which uses libostree.
The BuildStream build and integration tool uses libostree as a caching system to store and share built artifacts.
Fedora coreos-assembler is the build tool used to generate Fedora CoreOS derivatives.
Projects linking to libostree
rpm-ostree is used by the Fedora-derived operating systems listed above. It is a full hybrid image/package system. 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.
eos-updater is a daemon that implements updates on EndlessOS.
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.
Language bindings
libostree is accessible via GObject Introspection; any language which has implemented the GI binding model should work. For example, Both pygobject and gjs are known to work and further are actually used in libostree's test suite today.
Some bindings take the approach of using GI as a lower level and write higher level manual bindings on top; this is more common for statically compiled languages. Here's a list of such bindings:
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+. This also covers the man pages and API docs.
The license for the manual documentation in the doc/ directory is:
SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)
This is intended to allow use by Wikipedia and other projects.
In general, files should have a SPDX-License-Identifier and that is canonical.