keremet/rpm-ostree
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs/compose: add a introductory section

Browse Source 
This section is meant to give a broad overview of this doc.

First introducing the tool in general. Then showing the distinction
between 'compose tree' and the granular approach. Finally transitioning
over to the next section.
This commit is contained in:
Alexander Wellbrock 2021-03-23 18:42:46 +01:00 committed by Colin Walters
parent bf14072087
commit 5ed0834144
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/compose-server.md
View File

@ -8,6 +8,21 @@ nav_order: 4
1. TOC
{:toc}
## Managing RPM based OSTree commits
With `rpm-ostree compose` you get a tool to compose your own ostree commits based on a
[treefile](https://coreos.github.io/rpm-ostree/treefile/) configuration, a couple of RPMs,
some post-processing and possibly some custom modifications directly in the resulting tree.
The tool allows to either build a tree commit in one go with a single command: `rpm-ostree compose tree`.
Or to split that process up into smaller chunks with the usage of `rpm-ostree compose install`,
followed by `rpm-ostree compose postprocess` and finally `rpm-ostree compose commit`. While
the former approach is pretty complete and allows most use-cases the latter is useful if you need
some more customization on the resulting filesystem. More customization than the sandboxed
post-process functionality of the treefile allows.
In most scenarios you'll want to consider using a more "high level" tool, than `rpm-ostree compose`.
## Using higher level build tooling
Originally `rpm-ostree compose tree` was intended to be a "high level" tool,