Skip to content

Commit 6ebad51

Browse files
authored
Merge pull request #180 from vrothberg/docs
minor doc tweaks
2 parents 491e131 + 85b9d73 commit 6ebad51

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

docs/bootc-images.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ FROM debian
1515
RUN apt install kernel
1616
```
1717

18-
And get an image compatible with bootc. Supporting this
18+
And get an image compatible with bootc. Supporting any base image
1919
is an eventual goal, however there are a few reasons why
2020
this doesn't yet work. The biggest reason is SELinux
2121
labeling support; the underlying ostree stack currently
@@ -25,7 +25,7 @@ for any derived layers.
2525

2626
# Building bootc compatible base images
2727

28-
As a corollary to this, the build process
28+
As a corollary to base-image limitations, the build process
2929
for generating base images currently requires running
3030
through ostree tooling to generate an "ostree commit"
3131
which has some special formatting in the base image.
@@ -34,7 +34,7 @@ However, the ostree usage is an implementation detail
3434
and the requirement on this will be lifted in the future.
3535

3636
For example, the [rpm-ostree compose image](https://coreos.github.io/rpm-ostree/container/#creating-base-images)
37-
tooling currently streamlines this, operating just
37+
tooling currently streamlines creating base images, operating just
3838
on a declarative input and writing to a registry.
3939

4040
This is how the [Project Sagano](https://github.com/centos/sagano)
@@ -55,8 +55,7 @@ RUN dnf -y install foo && dnf clean all
5555

5656
As an opt-in optimization today, you can also add `ostree container commit`
5757
as part of your `RUN` invocations. This will perform early detection
58-
of some incompatibilities.
59-
60-
However, its usage is not and will never be strictly required.
58+
of some incompatibilities but is not a strict requirement today and will not be
59+
in the future.
6160

6261

docs/install.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@ Here's an example:
5050
$ podman run --privileged --pid=host --net=none --security-opt label=type:unconfined_t <image> bootc install --target-no-signature-verification /path/to/disk
5151
```
5252

53-
Note that while `--privileged` is used, this command will not
54-
perform any destructive action on the host system.
53+
Note that while `--privileged` is used, this command will not perform any
54+
destructive action on the host system. Among other things, `--privileged`
55+
makes sure that all host devices are mounted into container. `/path/to/disk` is
56+
the host's block device `<image>` will be installed on.
5557

5658
The `--pid=host --security-opt label=type:unconfined_t` today
5759
make it more convenient for bootc to perform some privileged
@@ -121,7 +123,7 @@ in the image - it is per machine state.
121123

122124
#### Injecting SSH keys in a container image
123125

124-
In this example, we will configure OpenSSH to read the
126+
In the following example, we will configure OpenSSH to read the
125127
set of authorized keys for the root user from content
126128
that lives in `/usr` (i.e. is owned by the container image).
127129
We will also create a `/usr/etc-system` directory which is intentionally distinct

0 commit comments

Comments
 (0)