Add a quick start to the README, reorganize and make the main
documentation less reference-like, and add a man page.
Signed-off-by: Alberto Faria <afaria@redhat.com>
We attempt to detect if a container image is bootable. We can't easily
retrieve the image's labels, so we check if /usr/lib/bootc/install
exists and is a directory. If so, it is a bootable container. If it is a
bootable container but we're not running under Podman, we fail with an
error.
Once our container's entrypoint starts running, a background process on
the host (outside the container) queries Podman for the image's name and
ID, which the OCI runtime does not get but bootc-install needs. It then
saves the container image as an OCI archive.
It then runs the original container to generate the VM image. We do this
using krun [1] so that elevated privileges aren't necessary. Our
entrypoint blocks until this is done, and all subsequent logic remains
the same.
We could potentially avoid the OCI archive creation step by mounting the
host's container storage into the container running under krun. This
isn't trivial to achieve due to SELinux label and context mismatches
between the host and the krun environment, so we leave this optimization
for a future date.
Closes#26.
[1] https://github.com/containers/crun/blob/main/krun.1.md
Signed-off-by: Alberto Faria <afaria@redhat.com>
In step 1, since editing /etc is not desirable for rootless Podman,
mention the alternative location that will have the same effect.
In step 2, there's no need for the disclaimer paragraph about Docker
lacking --latest in an example that already can't use Docker because
of lack of --rootfs a couple paragraphs above. And even for Podman,
make it clear that the initial example is limited, in that the qcow2
image has no ssh keys, root password, or alternative users installed
yet.
Signed-off-by: Eric Blake <eblake@redhat.com>
Alberto Faria
Eric Blake
Daniel J Walsh