Skip to content

Commit 477e5e0

Browse files
committed
docs/relationships: add section about ostree
I think this info can probably be pieced together from the rest of the docs, but let's add a dedicated section for it. Came up in an internal chat. Signed-off-by: Jonathan Lebon <[email protected]>
1 parent 38e6528 commit 477e5e0

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

docs/src/relationships.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,26 @@ However, there are also plans for `bootc` to also understand Kubernetes API type
3939

4040
Perhaps in the future we may actually support some kind of `Pod` analogue for representing the host state. Or we may define a [CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) which can be used inside and outside of Kubernetes.
4141

42+
## Relationship with ostree
43+
44+
OSTree provides many things:
45+
1. a git-like repo for OS data from which you can check out an entire rootfs
46+
2. a bootloader integration layer
47+
3. a transport layer for pulling content over HTTP
48+
49+
With bootc, the OSTree transport layer is not used. Instead, content is pulled
50+
as OCI containers using `skopeo` as mentioned above. However, this content
51+
is then imported into the local OSTree repo to perform a deployment checkout.
52+
The role of OSTree may further shrink in the future, especially as tighter
53+
integration with podman and composefs occurs, but it will remain an important
54+
part of the bootc stack (in particular the bootloader integration layer and
55+
management of deployment roots).
56+
4257
## Relationship with rpm-ostree
4358

44-
Today both bootc and rpm-ostree use the [ostree project](https://github.com/ostreedev/ostree-rs-ext)
45-
as a backing model. Hence, when using a container source,
46-
`rpm-ostree upgrade` and `bootc upgrade` are effectively equivalent;
47-
you can use either command.
59+
As mentioned above, bootc uses OSTree as a backing model, and so does
60+
rpm-ostree. Hence, when using a container source, `rpm-ostree upgrade` and
61+
`bootc upgrade` are effectively equivalent; you can use either command.
4862

4963
### Differences from rpm-ostree
5064

0 commit comments

Comments
 (0)