Skip to content

Commit

Permalink
Merge pull request #180 from vrothberg/docs
Browse files Browse the repository at this point in the history
minor doc tweaks
  • Loading branch information
cgwalters committed Nov 6, 2023
2 parents 491e131 + 85b9d73 commit 6ebad51
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
11 changes: 5 additions & 6 deletions docs/bootc-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ FROM debian
RUN apt install kernel
```

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

# Building bootc compatible base images

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

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

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

As an opt-in optimization today, you can also add `ostree container commit`
as part of your `RUN` invocations. This will perform early detection
of some incompatibilities.

However, its usage is not and will never be strictly required.
of some incompatibilities but is not a strict requirement today and will not be
in the future.


8 changes: 5 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,10 @@ Here's an example:
$ podman run --privileged --pid=host --net=none --security-opt label=type:unconfined_t <image> bootc install --target-no-signature-verification /path/to/disk
```

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

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

#### Injecting SSH keys in a container image

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

0 comments on commit 6ebad51

Please sign in to comment.