Rename "osname" → "stateroot"
I never really liked the term "osname". I feel "stateroot" is a *lot* clearer, since the osname/stateroot mostly just holds `/var`. Further it avoids the `os` prefix which is already overloaded. Some of the existing docs already talked about "operating system state", which further reinforces this. There's *lot* more things than this which reference the term "osname", but I don't want to change *everything* yet in this patch in case we decide to do something different - this just gets the highlights. Closes: #794 Approved by: jlebon
This commit is contained in:
1 parent
0c4aeff1cb
commit
55603a0c52
10 files changed
+37
-25
No files matched your search
@@ -55,7 +55,7 @@ checking it back out of the repo into a deployment.
|
||||
## Assembling a new deployment directory
|
||||
|
||||
Given a commit to deploy, OSTree first allocates a directory for
|
||||
it. This is of the form `/boot/loader/entries/ostree-$osname-$checksum.$serial.conf`.
|
||||
it. This is of the form `/boot/loader/entries/ostree-$stateroot-$checksum.$serial.conf`.
|
||||
The `$serial` is normally `0`, but if a
|
||||
given commit is deployed more than once, it will be incremented.
|
||||
This is supported because the previous deployment may have
|
||||
|
||||
+13
-12
@@ -8,23 +8,24 @@ operating systems (accessible via `ostree admin`). The core content of these op
|
||||
are treated as read-only, but they transparently share storage.
|
||||
|
||||
A deployment is physically located at a path of the form
|
||||
`/ostree/deploy/$osname/deploy/$checksum`.
|
||||
`/ostree/deploy/$stateroot/deploy/$checksum`.
|
||||
OSTree is designed to boot directly into exactly one deployment
|
||||
at a time; each deployment is intended to be a target for
|
||||
`chroot()` or equivalent.
|
||||
|
||||
### "osname": Group of deployments that share /var
|
||||
### "stateroot" (AKA "osname"): Group of deployments that share /var
|
||||
|
||||
Each deployment is grouped in exactly one "osname". From above, you
|
||||
can see that an osname is physically represented in the
|
||||
`/ostree/deploy/$osname` directory. For example, OSTree can allow
|
||||
parallel installing Debian in `/ostree/deploy/debian` and Red Hat
|
||||
Enterprise Linux in `/ostree/deploy/rhel` (subject to operating system
|
||||
support, present released versions of these operating systems may not
|
||||
support this).
|
||||
Each deployment is grouped in exactly one "stateroot" (also known as an "osname");
|
||||
the former term is preferred.
|
||||
|
||||
Each osname has exactly one copy of the traditional Unix `/var`,
|
||||
stored physically in `/ostree/deploy/$osname/var`. OSTree provides
|
||||
From above, you can see that an stateroot is physically represented in the
|
||||
`/ostree/deploy/$stateroot` directory. For example, OSTree can allow parallel
|
||||
installing Debian in `/ostree/deploy/debian` and Red Hat Enterprise Linux in
|
||||
`/ostree/deploy/rhel` (subject to operating system support, present released
|
||||
versions of these operating systems may not support this).
|
||||
|
||||
Each stateroot has exactly one copy of the traditional Unix `/var`,
|
||||
stored physically in `/ostree/deploy/$stateroot/var`. OSTree provides
|
||||
support tools for `systemd` to create a Linux bind mount that ensures
|
||||
the booted deployment sees the shared copy of `/var`.
|
||||
|
||||
@@ -81,7 +82,7 @@ files.
|
||||
|
||||
When a tree is deployed, it will have a configuration file generated
|
||||
of the form
|
||||
`/boot/loader/entries/ostree-$osname-$checksum.$serial.conf`. This
|
||||
`/boot/loader/entries/ostree-$stateroot-$checksum.$serial.conf`. This
|
||||
configuration file will include a special `ostree=` kernel argument
|
||||
that allows the initramfs to find (and `chroot()` into) the specified
|
||||
deployment.
|
||||
|
||||
@@ -97,7 +97,7 @@ parallel install inside an existing OS or distribution
|
||||
occupying the physical `/` root.
|
||||
|
||||
On each client machine, there is an OSTree repository stored
|
||||
in `/ostree/repo`, and a set of "deployments" stored in `/ostree/deploy/$OSNAME/$CHECKSUM`.
|
||||
in `/ostree/repo`, and a set of "deployments" stored in `/ostree/deploy/$STATEROOT/$CHECKSUM`.
|
||||
Each deployment is primarily composed of a set of hardlinks
|
||||
into the repository. This means each version is deduplicated;
|
||||
an upgrade process only costs disk space proportional to the
|
||||
|
||||
Reference in new issue
Block a user