rpm-ostree/docs/manual/compose-server.md
Colin Walters 39186e3330 docs/compose: Mention caching, privileged containers, example code
And also drop the `-z2` I saw show up in another project.

Closes: #1347
Approved by: jlebon
2018-04-25 18:43:36 +00:00

3.4 KiB

Background on managing an OSTree repository

Before you get started, it's recommended to read (at least) these two sections of the OSTree manual:

Generating OSTree commits from a CentOS base

First, you'll need a copy of rpm-ostree. The current recommendation is to use a privileged container, but you can also install rpm-ostree directly to a physical or virtual machine.

It's included in the package collection for Fedora, and there are CentOS Core packages as well as bleeding edge CentOS builds.

You can create a privileged container with e.g. podman via: podman run --privileged registry.fedoraproject.org/fedora:27 .... However you create the environment, run yum -y install rpm-ostree.

A good first thing to try would be using the CentOS Atomic Host metadata to generate a custom host.

One time setup, where we clone the git repository, then make two OSTree repos, one for doing builds, one for export via HTTP:

# mkdir /srv/centos-atomic
# cd /srv/centos-atomic
# git clone https://github.com/CentOS/sig-atomic-buildscripts -b downstream
# mkdir build-repo
# ostree --repo=build-repo init --mode=bare-user
# mkdir repo
# ostree --repo=repo init --mode=archive

We'll also want to cache downloaded RPMs:

# mkdir cache

Running rpm-ostree compose tree

This program takes as input a manifest file that describes the target system, and commits the result to an OSTree repository.

The input format is a JSON "treefile". See examples in api-doc/treefile-examples. More real-world examples include the manifest for Fedora Atomic and CentOS Atomic.

If you're doing this multiple times, it's strongly recommended to create a cache directory:

# rpm-ostree compose tree --cachedir=cache --repo=/srv/centos-atomic/build-repo sig-atomic-buildscripts/centos-atomic-host.json

This will download RPMs from the referenced repos, and commit the result to the OSTree repository, using the ref named by ref.

Once we have that commit, let's export it:

# ostree --repo=repo pull-local build-repo centos-atomic-host/7/x86_64/standard

You can tell client systems to rebase to it by combining ostree remote add, and rpm-ostree rebase on the client side.

More information