diff --git a/docs/_config.yml b/docs/_config.yml index 24b2189..d26cf8f 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,5 +1,5 @@ -title: containers/bootc -description: bootc documentation +title: centos/centos-boot +description: centos-boot documentation baseurl: "/centos-boot" url: "https://centos.github.io" # Comment above and use below for local development @@ -32,8 +32,8 @@ color_scheme: coreos # Aux links for the upper right navigation aux_links: - "bootc on GitHub": - - "https://github.com/containers/bootc" + "centos-boot on GitHub": + - "https://github.com/centos/centos-boot" footer_content: "Copyright © Red Hat, Inc. and others." @@ -44,7 +44,7 @@ last_edit_time_format: "%b %e %Y at %I:%M %p" # Footer "Edit this page on GitHub" link text gh_edit_link: true gh_edit_link_text: "Edit this page on GitHub" -gh_edit_repository: "https://github.com/containers/bootc" +gh_edit_repository: "https://github.com/centos/centos-boot" gh_edit_branch: "main" gh_edit_source: docs gh_edit_view_mode: "tree" diff --git a/docs/index.md b/docs/index.md index 8d9769e..25b2748 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,20 @@ # Goals -This project's toplevel goal is to create base *bootable* container images -from Fedora ELN and CentOS Stream packages. +This project's toplevel goal is to maintain default definitions for +base *bootable* container images, locked with Fedora ELN and CentOS Stream 9. ## Status This is an in-development project not intended for production use yet. +## Container images + +The primary output of this project is container images. The current +main development target is [Fedora ELN](https://docs.fedoraproject.org/en-US/eln/) +and there is one image built: + +- `quay.io/centos-boot/fedora-tier-1:eln` + ## Trying it out See [install.md](./install.md). @@ -23,9 +31,10 @@ include Ignition for example. ## Differences from RHEL CoreOS -We sometimes say that RHEL CoreOS [has FCOS as an upstream](https://github.com/openshift/os/blob/master/docs/faq.md#q-what-is-coreos) but this is only -kind of true; RHEL CoreOS includes a subset of FCOS content, and is lifecycled -with OCP. +We sometimes say that RHEL CoreOS +[has FCOS as an upstream](https://github.com/openshift/os/blob/master/docs/faq.md#q-what-is-coreos) +but this is only kind of true; RHEL CoreOS includes a subset of FCOS content, +and is lifecycled with OCP. An explicit goal of this project is to produce bootable container images that can be used as *base images* for RHEL CoreOS; for more on this, see e.g. @@ -35,53 +44,24 @@ that can be used as *base images* for RHEL CoreOS; for more on this, see e.g. It is an explicit goal that CentOS boot also becomes a "base input" to RHEL for Edge. -## Demonstration base images for Project CentOS boot +## Understanding "tiers" -These images are technology demonstrators, not for production use. The -intention is that these images are generated by the OS vendor or -distribution. -Or, you can fork this repository and generate your own via -`rpm-ostree compose image`. +There is a "tier-0" image, but it is not yet being automatically built. The "tier-0" +contains: -## Operating system sources +- kernel +- systemd +- bootc +- selinux-policy-targeted -At the moment these demonstration builds use Fedora ELN and CentOS Stream 9. - -## Tiers - -### Tier 0 - -This is the basic tier; it has effectively just: - -- kernel systemd selinux-policy-targeted bootc - -You are generally going to need to generate derived images from this; installing -it on its own will boot to a system with no automatic networking support, no SSH, -and no default passwords etc. - -### Tier 1 - -This is larger system. +The tier-1 is a reasonably large system: - NetworkManager, chrony -- rpm-ostree (to install packages and in case it's useful "day 2") - openssh-server +- dnf (for installing packages in container builds) +- rpm-ostree (A lot of tooling uses this too) -At the current time, it does not include Ignition or cloud-init; so you will -still need to derive from it in order to inject a mechanism to log in in many -cases. However, it will work to install it using e.g. Anaconda and set up -users and passwords that way. - -## Image matrix (Fedora) - -- `quay.io/centos-boot/fedora-tier-1:eln` - -### More about image sources - -The current manifest definitions [tier-0](tier-0) and [tier-1](tier-1) were -forked from Fedora CoreOS, but significantly cut down. - -The existing content set is obviously subject to change and debate. +The content set for these images is subject to change. ## Building