From e7b9c31214d3846b7b76bb2ed50ae7353b0a68d9 Mon Sep 17 00:00:00 2001 From: Davide Cavalca Date: Sep 30 2022 21:32:58 +0000 Subject: Group all deliverables in a dedicated section --- diff --git a/docs/containers.md b/docs/containers.md deleted file mode 100644 index e1b0ebb..0000000 --- a/docs/containers.md +++ /dev/null @@ -1,18 +0,0 @@ -A minimal container image based on the Hyperscale SIG repos and packages is -available on [Quay.io](https://quay.io/centoshyperscale/centos) and can be used -via Docker or Podman. - -This container image is -[built from scratch](https://pagure.io/centos-sig-hyperscale/containers-releng), -and in the future we plan to leverage the CentOS CI infrastructure to automate -the build process. - -# CentOS Stream 8 -```shell -podman run -a stdin,stdout,stderr -t quay.io/centoshyperscale/centos:stream8 -``` - -# CentOS Stream 9 -```shell -podman run -a stdin,stdout,stderr -t quay.io/centoshyperscale/centos:stream9 -``` diff --git a/docs/content/containers.md b/docs/content/containers.md new file mode 100644 index 0000000..e1b0ebb --- /dev/null +++ b/docs/content/containers.md @@ -0,0 +1,18 @@ +A minimal container image based on the Hyperscale SIG repos and packages is +available on [Quay.io](https://quay.io/centoshyperscale/centos) and can be used +via Docker or Podman. + +This container image is +[built from scratch](https://pagure.io/centos-sig-hyperscale/containers-releng), +and in the future we plan to leverage the CentOS CI infrastructure to automate +the build process. + +# CentOS Stream 8 +```shell +podman run -a stdin,stdout,stderr -t quay.io/centoshyperscale/centos:stream8 +``` + +# CentOS Stream 9 +```shell +podman run -a stdin,stdout,stderr -t quay.io/centoshyperscale/centos:stream9 +``` diff --git a/docs/content/eln_extras.md b/docs/content/eln_extras.md new file mode 100644 index 0000000..f4b19d6 --- /dev/null +++ b/docs/content/eln_extras.md @@ -0,0 +1,3 @@ +The SIG maintains a [workload](https://tiny.distro.builders/workload-overview--eln_extras_hyperscale--repository-fedora-eln.html) for [ELN Extras](https://docs.fedoraproject.org/en-US/eln/extras/), to ensure that packages we care about in Fedora and EPEL continue to build and work properly for the next CentOS major release. These packages are included in [Fedora ELN](https://docs.fedoraproject.org/en-US/eln/) composes. + +The set of packages is defined in [Content Resolver](https://github.com/minimization/content-resolver-input/blob/master/configs/eln_extras_hyperscale.yaml) and was orginally added in [PR#706](https://github.com/minimization/content-resolver-input/pull/706). diff --git a/docs/content/repositories/experimental.md b/docs/content/repositories/experimental.md new file mode 100644 index 0000000..9205c34 --- /dev/null +++ b/docs/content/repositories/experimental.md @@ -0,0 +1,28 @@ +The `experimental` repository is meant for work-in-progress packages that might +change major system components and require some manual configuration for usage. + +This repository can be enabled by installing the +`centos-release-hyperscale-experimental` package: + +```shell +$ sudo dnf install centos-release-hyperscale-experimental +``` + +# Available packages +Browse the [release tag](https://cbs.centos.org/koji/packages?tagID=2245) on +CBS to see what packages are available. Please report any issues with these +packages on our +[package-bugs](https://pagure.io/centos-sig-hyperscale/package-bugs) tracker. + +## DNF/RPM stack with CoW support +An updated packaging stack (`rpm`, `dnf`, `libdnf`, `librepo`) is available in +the repository. These packages include several improvements and bugfixes to +support the ongoing +[Copy-on-Write](https://fedoraproject.org/wiki/Changes/RPMCoW) work. + +## Kernel +We have a 5.12.4 release of the [Linux kernel](https://kernel.org) currently +in the repository. This kernel has +[btrfs](https://btrfs.wiki.kernel.org/index.php/Main_Page) and +[Kernel Live Patching](https://www.kernel.org/doc/html/latest/livepatch/livepatch.html) +enabled. diff --git a/docs/content/repositories/hotfixes.md b/docs/content/repositories/hotfixes.md new file mode 100644 index 0000000..58db25b --- /dev/null +++ b/docs/content/repositories/hotfixes.md @@ -0,0 +1,35 @@ +The `hotfixes` repository is desiged as a +[modularity hotfix repository](https://dnf.readthedocs.io/en/latest/modularity.html#hotfix-repositories). This repository provides a set of non-modular +packages that can be used to override modular packages provided in CentOS +Stream. We do this because CBS cannot currently build modular packages, so the +only way to ship them within Hyperscale is as non-modular content. + +This repository can be enabled by installing the +`centos-release-hyperscale-hotfixes` package: + +```shell +$ sudo dnf install centos-release-hyperscale-hotfixes +``` + +Note that this release package will pull in `centos-release-hyperscale`, as +the hotfixes repo is not meant to be self containerd. In turn, that will pull +in `epel-release`, as EPEL is a prerequisite for Hyperscale. We also recommend +enabling PowerTools (which is itself a prerequisite for EPEL) with: + +```shell +sudo dnf config-manager --set-enabled powertools +``` + +# Available packages +Browse the [release tag](https://cbs.centos.org/koji/packages?tagID=2305) on +CBS to see what packages are available. Please report any issues with these +packages on our +[package-bugs](https://pagure.io/centos-sig-hyperscale/package-bugs) tracker. + +## libvirt +We ship an updated backport of [libvirt](https://libvirt.org) 7.1.0. + +## LLVM +We used to ship a backport of the LLVM 12 compiler suite. This has since +[become part](https://bugzilla.redhat.com/show_bug.cgi?id=1952248) of CentOS +Stream 8 proper, so we have retired our build. diff --git a/docs/content/repositories/main.md b/docs/content/repositories/main.md new file mode 100644 index 0000000..1144713 --- /dev/null +++ b/docs/content/repositories/main.md @@ -0,0 +1,54 @@ +Packages released in `main` are designed to be drop-in replacements for the +corresponding packages on a stock CentOS Stream system. This repository can +be enabled by installing the `centos-release-hyperscale` package: + +```shell +$ sudo dnf install centos-release-hyperscale +``` + +Note that this release package will pull in `epel-release`, as EPEL is a +prerequisite for Hyperscale. We also recommend enabling PowerTools (which is +itself a prerequisite for EPEL) with: + +```shell +sudo dnf config-manager --set-enabled powertools +``` + +# Available packages +Browse the [release tag](https://cbs.centos.org/koji/packages?tagID=2249) on +CBS to see what packages are available. Please report any issues with these +packages on our +[package-bugs](https://pagure.io/centos-sig-hyperscale/package-bugs) tracker. + + +## systemd +We ship a backport of [systemd](https://systemd.io) based on the Fedora +packaging. This includes a variety of bug fixes in existing features such as +timers and cgroups, as well as new properties that take advantage of the latest +kernel features. You can also look forward to new knobs in the various tools +and daemons to make debugging and configuration easier. + +By default, this backport will boot the system using the +[unified cgroup hierarchy](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) +(i.e. cgroup2), in line with systemd upstream policy. This can be changed with +the appropriate +[kernel cmdline](https://www.freedesktop.org/software/systemd/man/systemd.html#systemd.unified_cgroup_hierarchy) +knobs. + +This systemd backport also includes a SELinux overlay module, which allows +running systemd on a system in enforcing mode. Nonetheless, the SELinux +integration has only seen limited testing and should be considered experimental +at this point. + +We also include systemd-oomd, which was declared stable in systemd 248 and was +[adopted in Fedora 34](https://fedoraproject.org/wiki/Changes/EnableSystemdOomd) +as the default userspace out-of-memory killer. It monitors memory pressure +thresholds and kills processes at the cgroup level. The `systemd-oomd-defaults` +package, which provides the policy used by Fedora, is also backported to our +repository. + +## kpatch +We ship an updated version of [kpatch](https://github.com/dynup/kpatch), which +also includes the `kpatch-build` tool. This can be used to convert kernel +patches to be then applied onto a system that supports +[Kernel Live Patching](https://www.kernel.org/doc/html/latest/livepatch/livepatch.html). diff --git a/docs/content/spins/workstation.md b/docs/content/spins/workstation.md new file mode 100644 index 0000000..3d584e6 --- /dev/null +++ b/docs/content/spins/workstation.md @@ -0,0 +1,16 @@ +The CentOS Hyperscale SIG produces an experimental Hyperscale Workstation Spin +to showcase the technologies we're working on to the broader community. + +The spins are available for download here: + +* [GNOME ISO](https://d2r1r30d0ahkv5.cloudfront.net/CS8-HS-GNOME-LIVE-20211001.iso) +* [KDE ISO](https://d2r1r30d0ahkv5.cloudfront.net/CS8-HS-KDE-LIVE-20211001.iso) +* [SHA512 checksums](https://d2r1r30d0ahkv5.cloudfront.net/CS8-HS-LIVE-20211001-CHECKSUMS) + +The live media is built using `livecd-creator` from the +[LiveCD Tools](https://github.com/livecd-tools/livecd-tools) provided by the +`livecd-tools` package in EPEL. We published the +[kickstarts](https://pagure.io/centos-sig-hyperscale/spin-kickstarts) as well. + +Please report any issues with these spins on our +[spin-bugs](https://pagure.io/centos-sig-hyperscale/spin-bugs) tracker. diff --git a/docs/eln_extras.md b/docs/eln_extras.md deleted file mode 100644 index f4b19d6..0000000 --- a/docs/eln_extras.md +++ /dev/null @@ -1,3 +0,0 @@ -The SIG maintains a [workload](https://tiny.distro.builders/workload-overview--eln_extras_hyperscale--repository-fedora-eln.html) for [ELN Extras](https://docs.fedoraproject.org/en-US/eln/extras/), to ensure that packages we care about in Fedora and EPEL continue to build and work properly for the next CentOS major release. These packages are included in [Fedora ELN](https://docs.fedoraproject.org/en-US/eln/) composes. - -The set of packages is defined in [Content Resolver](https://github.com/minimization/content-resolver-input/blob/master/configs/eln_extras_hyperscale.yaml) and was orginally added in [PR#706](https://github.com/minimization/content-resolver-input/pull/706). diff --git a/docs/repositories/experimental.md b/docs/repositories/experimental.md deleted file mode 100644 index 9205c34..0000000 --- a/docs/repositories/experimental.md +++ /dev/null @@ -1,28 +0,0 @@ -The `experimental` repository is meant for work-in-progress packages that might -change major system components and require some manual configuration for usage. - -This repository can be enabled by installing the -`centos-release-hyperscale-experimental` package: - -```shell -$ sudo dnf install centos-release-hyperscale-experimental -``` - -# Available packages -Browse the [release tag](https://cbs.centos.org/koji/packages?tagID=2245) on -CBS to see what packages are available. Please report any issues with these -packages on our -[package-bugs](https://pagure.io/centos-sig-hyperscale/package-bugs) tracker. - -## DNF/RPM stack with CoW support -An updated packaging stack (`rpm`, `dnf`, `libdnf`, `librepo`) is available in -the repository. These packages include several improvements and bugfixes to -support the ongoing -[Copy-on-Write](https://fedoraproject.org/wiki/Changes/RPMCoW) work. - -## Kernel -We have a 5.12.4 release of the [Linux kernel](https://kernel.org) currently -in the repository. This kernel has -[btrfs](https://btrfs.wiki.kernel.org/index.php/Main_Page) and -[Kernel Live Patching](https://www.kernel.org/doc/html/latest/livepatch/livepatch.html) -enabled. diff --git a/docs/repositories/hotfixes.md b/docs/repositories/hotfixes.md deleted file mode 100644 index 58db25b..0000000 --- a/docs/repositories/hotfixes.md +++ /dev/null @@ -1,35 +0,0 @@ -The `hotfixes` repository is desiged as a -[modularity hotfix repository](https://dnf.readthedocs.io/en/latest/modularity.html#hotfix-repositories). This repository provides a set of non-modular -packages that can be used to override modular packages provided in CentOS -Stream. We do this because CBS cannot currently build modular packages, so the -only way to ship them within Hyperscale is as non-modular content. - -This repository can be enabled by installing the -`centos-release-hyperscale-hotfixes` package: - -```shell -$ sudo dnf install centos-release-hyperscale-hotfixes -``` - -Note that this release package will pull in `centos-release-hyperscale`, as -the hotfixes repo is not meant to be self containerd. In turn, that will pull -in `epel-release`, as EPEL is a prerequisite for Hyperscale. We also recommend -enabling PowerTools (which is itself a prerequisite for EPEL) with: - -```shell -sudo dnf config-manager --set-enabled powertools -``` - -# Available packages -Browse the [release tag](https://cbs.centos.org/koji/packages?tagID=2305) on -CBS to see what packages are available. Please report any issues with these -packages on our -[package-bugs](https://pagure.io/centos-sig-hyperscale/package-bugs) tracker. - -## libvirt -We ship an updated backport of [libvirt](https://libvirt.org) 7.1.0. - -## LLVM -We used to ship a backport of the LLVM 12 compiler suite. This has since -[become part](https://bugzilla.redhat.com/show_bug.cgi?id=1952248) of CentOS -Stream 8 proper, so we have retired our build. diff --git a/docs/repositories/main.md b/docs/repositories/main.md deleted file mode 100644 index 1144713..0000000 --- a/docs/repositories/main.md +++ /dev/null @@ -1,54 +0,0 @@ -Packages released in `main` are designed to be drop-in replacements for the -corresponding packages on a stock CentOS Stream system. This repository can -be enabled by installing the `centos-release-hyperscale` package: - -```shell -$ sudo dnf install centos-release-hyperscale -``` - -Note that this release package will pull in `epel-release`, as EPEL is a -prerequisite for Hyperscale. We also recommend enabling PowerTools (which is -itself a prerequisite for EPEL) with: - -```shell -sudo dnf config-manager --set-enabled powertools -``` - -# Available packages -Browse the [release tag](https://cbs.centos.org/koji/packages?tagID=2249) on -CBS to see what packages are available. Please report any issues with these -packages on our -[package-bugs](https://pagure.io/centos-sig-hyperscale/package-bugs) tracker. - - -## systemd -We ship a backport of [systemd](https://systemd.io) based on the Fedora -packaging. This includes a variety of bug fixes in existing features such as -timers and cgroups, as well as new properties that take advantage of the latest -kernel features. You can also look forward to new knobs in the various tools -and daemons to make debugging and configuration easier. - -By default, this backport will boot the system using the -[unified cgroup hierarchy](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) -(i.e. cgroup2), in line with systemd upstream policy. This can be changed with -the appropriate -[kernel cmdline](https://www.freedesktop.org/software/systemd/man/systemd.html#systemd.unified_cgroup_hierarchy) -knobs. - -This systemd backport also includes a SELinux overlay module, which allows -running systemd on a system in enforcing mode. Nonetheless, the SELinux -integration has only seen limited testing and should be considered experimental -at this point. - -We also include systemd-oomd, which was declared stable in systemd 248 and was -[adopted in Fedora 34](https://fedoraproject.org/wiki/Changes/EnableSystemdOomd) -as the default userspace out-of-memory killer. It monitors memory pressure -thresholds and kills processes at the cgroup level. The `systemd-oomd-defaults` -package, which provides the policy used by Fedora, is also backported to our -repository. - -## kpatch -We ship an updated version of [kpatch](https://github.com/dynup/kpatch), which -also includes the `kpatch-build` tool. This can be used to convert kernel -patches to be then applied onto a system that supports -[Kernel Live Patching](https://www.kernel.org/doc/html/latest/livepatch/livepatch.html). diff --git a/docs/spins/workstation.md b/docs/spins/workstation.md deleted file mode 100644 index 3d584e6..0000000 --- a/docs/spins/workstation.md +++ /dev/null @@ -1,16 +0,0 @@ -The CentOS Hyperscale SIG produces an experimental Hyperscale Workstation Spin -to showcase the technologies we're working on to the broader community. - -The spins are available for download here: - -* [GNOME ISO](https://d2r1r30d0ahkv5.cloudfront.net/CS8-HS-GNOME-LIVE-20211001.iso) -* [KDE ISO](https://d2r1r30d0ahkv5.cloudfront.net/CS8-HS-KDE-LIVE-20211001.iso) -* [SHA512 checksums](https://d2r1r30d0ahkv5.cloudfront.net/CS8-HS-LIVE-20211001-CHECKSUMS) - -The live media is built using `livecd-creator` from the -[LiveCD Tools](https://github.com/livecd-tools/livecd-tools) provided by the -`livecd-tools` package in EPEL. We published the -[kickstarts](https://pagure.io/centos-sig-hyperscale/spin-kickstarts) as well. - -Please report any issues with these spins on our -[spin-bugs](https://pagure.io/centos-sig-hyperscale/spin-bugs) tracker. diff --git a/mkdocs.yml b/mkdocs.yml index d4f8fae..edcde8b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,14 +6,15 @@ repo_name: centos-sig-hyperscale/sig nav: - Overview: index.md - - Repositories: - - repositories/main.md - - repositories/hotfixes.md - - repositories/experimental.md - - Container images: containers.md - - Spins: - - Workstation LiveDVD: spins/workstation.md - - ELN Extras: eln_extras.md + - Content: + - Repositories: + - content/repositories/main.md + - content/repositories/hotfixes.md + - content/repositories/experimental.md + - Container images: content/containers.md + - Spins: + - Workstation LiveDVD: content/spins/workstation.md + - ELN Extras: content/eln_extras.md - Contributing: - Packaging: contributing/packaging.md - Kernel: contributing/kernel.md @@ -55,6 +56,12 @@ markdown_extensions: plugins: - redirects: redirect_maps: + repositories/main.md: content/repositories/main.md + repositories/hotfixes.md: content/repositories/hotfixes.md + repositories/experimental.md: content/repositories/experimental.md + containers.md: content/containers.md + spins/workstation.md: content/spins/workstation.md + eln_extras.md: content/eln_extras.md internal/documentation.md: contributing/documentation.md internal/meetings.md: communication/meetings.md internal/reports.md: communication/reports.md