keremet/rpm-ostree
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
930 Commits 1 Branch 0 Tags 12 MiB
C++ 58.8%
Rust 18.6%
Shell 13.6%
C 6.6%
M4 0.8%
Other 1.6%
fdbe28b964
Go to file
Jonathan Lebon fdbe28b964 docs: fix README.md and add HACKING.md 
Add a HACKING.md document detailing how to get started and test
rpm-ostree using the vagrant box.

Fix the CONTRIBUTING.md link and add a link to HACKING.md in README.md.

Closes: #344
Approved by: cgwalters
2016-06-23 00:05:09 +00:00
api-doc build: Use git.mk, make git status clean 2016-03-10 14:36:44 -05:00
buildutil build: Use git.mk, make git status clean 2016-03-10 14:36:44 -05:00
design design/package-layering: New file 2014-06-18 08:48:03 -04:00
docs README/docs: A few more links around composes 2016-05-26 18:48:27 +00:00
libglnx@afe3c3a861 core: Dedup hardlink/tempfile code 2016-06-01 15:15:11 +00:00
man man page: add pkg-add and pkg-delete 2016-06-03 19:13:13 +00:00
packaging build: Update .gitignore 2016-03-26 14:22:41 +00:00
scripts compose: Add check-passwd/group JSON options, fails compose if uids/gids change 2014-12-18 16:59:33 -05:00
src rpmostree-core.c: squash -Wunused-function 2016-06-20 19:57:37 +00:00
tests vagrant: move helper files to vagrant/ 2016-06-23 00:05:09 +00:00
tests-container tests-container: New experimental testing code path 2016-03-11 08:38:06 -05:00
vagrant vagrant: move helper files to vagrant/ 2016-06-23 00:05:09 +00:00
.gitmodules Start using libglnx 2015-02-15 14:01:13 -05:00
.travis.yml Add a stub travis file to enable Homu 2016-03-15 19:34:19 +00:00
autogen.sh autogen.sh: tweak program checking logic 2015-09-11 10:24:44 -04:00
configure.ac Release 2016.3 2016-05-20 08:54:05 -04:00
COPYING COPYING: Update to latest LGPLv2+ 2014-03-10 16:40:16 -04:00
git.mk build: Use git.mk, make git status clean 2016-03-10 14:36:44 -05:00
HACKING.md docs: fix README.md and add HACKING.md 2016-06-23 00:05:09 +00:00
LICENSE Add a LICENSE symlink 2016-04-28 13:09:22 +00:00
Makefile-daemon.am daemon: Unify PkgAdd/PkgDelete into PkgChange 2016-06-20 14:45:49 +00:00
Makefile-decls.am Import some code for using GJS 2014-01-03 17:14:10 -05:00
Makefile-lib-defines.am lib: Add RpmOstreePackage 2015-04-16 13:26:58 -04:00
Makefile-lib.am (cleanup): Move the refsack and root loading code into libpriv 2015-05-20 20:51:42 -04:00
Makefile-libpriv.am status: Import systemd bits to use UTF-8 circle 2016-06-09 19:33:19 +00:00
Makefile-man.am build: Use git.mk, make git status clean 2016-03-10 14:36:44 -05:00
Makefile-rpm-ostree.am tmpfiles.d: rename and re-order 2016-06-15 20:41:45 +00:00
Makefile-tests.am testenv: include same vars as real test environment 2016-06-15 20:41:45 +00:00
Makefile.am build: Use gnu99 by default 2016-03-30 20:51:34 +00:00
mkdocs.yml docs: Start using mkdocs 2016-03-09 11:10:58 -05:00
README.md docs: fix README.md and add HACKING.md 2016-06-23 00:05:09 +00:00
TODO package layering: major rework 2016-05-27 22:18:44 +00:00
Vagrantfile docs: fix README.md and add HACKING.md 2016-06-23 00:05:09 +00:00

README.md

rpm-ostree Overview

New! See the docs online at Read The Docs (rpm-ostree)

rpm-ostree is a hybrid image/package system. It uses OSTree as an image format, and uses RPM as a component model.

The project aims to bring together a hybrid of image-like upgrade features (reliable replication, atomicity), with package-like flexibility (introspecting trees to find package sets, package layering, partial live updates).

Features:

  • Atomic upgrades and rollback for host system updates
  • A server side tool to consume RPMs and commit them to an OSTree repository
  • A system daemon to consume ostree commits as updates

Projects using rpm-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.

Using rpm-ostree to build OS images/trees

See Compose Server.

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 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, the next step is to install the build dependencies. At the moment, rpm-ostree has a hard requirement on a bleeding edge version of libhif. It also requires a few other libraries like librepo.

Once you have the dependencies, building is the same as every autotools project:

env NOCONFIGURE=1 ./autogen.sh
./configure --prefix=/usr --libdir=/usr/lib64 --sysconfdir=/etc
make

At this point you can run some of the unit tests with make check. For more information on this, see CONTRIBUTING.md.

More documentation

New! See the docs online at Read The Docs (rpm-ostree)

Hacking

See Hacking.

Contributing

See Contributing.