Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add fedora bootable image, remove containerfile guide #446

Merged
merged 1 commit into from
May 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Easily go from container to VM / ISO-on-a-USB / RAW image!
## Topics

- [Technology](#technology)
- [Bootable Container Images](#bootable-container-images)
- [Read Before Using](#read-before-using)
- [Example Images](#example-images)
- [Use Case](#use-case)
Expand All @@ -23,11 +24,25 @@ The **Bootable Container (bootc)** extension uses [bootc-image-builder](https://

Once a machine is created from the disk image, it can apply transactional updates "in place" from newly pushed container images (without creating a new disk image). For more information, see [bootc](https://containers.github.io/bootc/).

### Supported base images (`FROM` in `Containerfile`)
## Bootable Container Images

* [`quay.io/centos-bootc/centos-bootc`](https://centos.github.io/centos-bootc)
There are many projects at work at creating "bootc" images. Below is a non-exhaustive list of compatible images which are known to work with [`bootc-image-builder`](https://github.com/osbuild/bootc-image-builder).

More will be added in the future.
| Bootable Container Image | Documentation | Example Images | Notes |
|------------------------------------------------------------------------------------------|------------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`quay.io/centos-bootc/centos-bootc:stream9`](https://quay.io/centos-bootc/centos-bootc) | [fedoraproject.org](https://docs.fedoraproject.org/en-US/bootc/) | [bootc-org/examples](https://gitlab.com/bootc-org/examples) | |
| [`quay.io/fedora/fedora-bootc:40`](https://quay.io/fedora/fedora-bootc) | [fedoraproject.org](https://docs.fedoraproject.org/en-US/bootc/) | [bootc-org/examples](https://gitlab.com/bootc-org/examples) | Must select "XFS" or "EXT4" for the root filesystem when building in the GUI. [Read more here.](https://docs.fedoraproject.org/en-US/bootc/default-rootfs-type/) |

The images can then be added to your Containerfile:

```Dockerfile
FROM quay.io/centos-bootc/centos-bootc:stream9
```

### Learning more

- [Fedora Building Containers Guide](https://docs.fedoraproject.org/en-US/bootc/building-containers/): provides an overview on how to create Fedora/CentOS-derived bootc images.
- [Bootc General Guidance](https://containers.github.io/bootc/building/guidance.html): provides a general configuration overview for bootc images.

## Read Before Using

Expand Down Expand Up @@ -57,11 +72,6 @@ RUN echo "root:root" | chpasswd

After creating your image you can now login and explore your bootable OS.

Want to learn more?

- [Bootc general guidance](https://containers.github.io/bootc/building/guidance.html) which covers users/groups and SSH keys
- [Our Containerfile Guide!](https://github.com/containers/podman-desktop-extension-bootc/blob/main/docs/containerfile_guide.md) We also explain how to add your first "run-on-boot" application!

## Example images

Want to view more example images Such as [`httpd`](https://gitlab.com/bootc-org/examples/-/tree/main/httpd) and [`nvidia`](https://gitlab.com/bootc-org/examples/-/tree/main/nvidia)?
Expand Down
185 changes: 0 additions & 185 deletions docs/containerfile_guide.md

This file was deleted.