From 0001b1a49f98e99e4254306d5900a6c2554f22f1 Mon Sep 17 00:00:00 2001 From: Louis Abel Date: Wed, 29 Jun 2022 15:51:24 -0700 Subject: [PATCH] add future documentation --- docs/.pages | 2 ++ docs/CNAME | 1 + docs/documentation/.pages | 6 ++++ docs/documentation/index.md | 56 ++++++++++++++++++++++++++++++++ docs/include/resources_bottom.md | 53 ++++++++++++++++++++++++++++++ mkdocs.yml | 4 ++- 6 files changed, 121 insertions(+), 1 deletion(-) create mode 100644 docs/CNAME create mode 100644 docs/documentation/.pages create mode 100644 docs/documentation/index.md create mode 100644 docs/include/resources_bottom.md diff --git a/docs/.pages b/docs/.pages index 06765ee..8fa8a40 100644 --- a/docs/.pages +++ b/docs/.pages @@ -1,4 +1,6 @@ --- nav: - ... | index.md + - ... | about.md + - Documentation | documentation ... diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..492df2a --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +core.sig.rocky.page diff --git a/docs/documentation/.pages b/docs/documentation/.pages new file mode 100644 index 0000000..c781ea1 --- /dev/null +++ b/docs/documentation/.pages @@ -0,0 +1,6 @@ +--- +nav: + - ... | index.md + - Composing Releases | compose.md + - Empanadas | empanadas.md +... diff --git a/docs/documentation/index.md b/docs/documentation/index.md new file mode 100644 index 0000000..ae3cc8f --- /dev/null +++ b/docs/documentation/index.md @@ -0,0 +1,56 @@ +--- +title: Composing Releases +--- + +This section goes over at a high level how we compose releases for Rocky Linux. +As most of our tools are home grown, we have made sure that the tools are open +source and in our git services. + +This page should serve as an idea of the steps we generally take and we hope +that other projects out there who wish to also use our tools can make sure they +can use them in this same way, whether they want to be an Enterprise Linux +derivative or another project entirely. + +## Build System and Tools + +The tools in use for the distribution are in the table below. + +| Tool | Maintainer | Code Location | +|-----------------|-------------------|---------------------------------------------------------------------| +| srpmproc | SIG/Core at Rocky | [GitHub](https://github.com/rocky-linux/srpmproc) | +| empanadas | SIG/Core at Rocky | [sig-core-toolkit](https://github.com/rocky-linux/sig-core-toolkit) | +| Peridot | SIG/Core at Rocky | | +| MirrorManager 2 | Fedora Project | [MirrorManager2](https://github.com/fedora-infra/mirrormanager2) | + +For Rocky Linux to be build, we use `Peridot` as the build system and +`empanadas` to "compose" the distribution. As we do not use Koji for Rocky +Linux beyond version 9, pungi no longer can be used. Peridot instead takes +pungi configuration data and comps and transforms them into a format it +can understand. Empanadas then comes in to do the "compose" and sync +all the repositories down. + +## Full Compose (major or minor releases) + +Step by step, it looks like this: + +* Distribution is built and maintained in Peridot +* Comps and pungi configuration is converted into the peridot format for the project +* Repositories are created in yumrepofs based on the configuration provided +* In Parallel: + * Repositories are synced as a "full run" in empanadas + * Lorax is ran using empanadas in the peridot cluster +* Lorax results are pulled down from an S3 bucket +* DVD images are built for each architecture +* Compose directory is synced to staging for verification + +## General Updates + +Step by step, it looks like this: + +* Distribution is maintained in Peridot +* Updates are built, repos are then "hashed" in yumrepofs +* Empanadas syncs updates as needed, either per repo or all repos at once +* Updates are synced to staging to be verified +* Staging is synced to production to allow mirror syncing + +{% include "resources_bottom.md" %} diff --git a/docs/include/resources_bottom.md b/docs/include/resources_bottom.md new file mode 100644 index 0000000..365a10d --- /dev/null +++ b/docs/include/resources_bottom.md @@ -0,0 +1,53 @@ + +

Resources

+ +=== "Account Services" + + **URL**: [https://accounts.rockylinux.org](https://accounts.rockylinux.org) + + **Purpose**: Account Services maintains the accounts for almost all components of the Rocky ecosystem + + **Technology**: Noggin used by Fedora Infrastructure + + **Contact**: `~Infrastructure` in Mattermost and `#rockylinux-infra` in Libera IRC + +=== "Git (RESF Git Service)" + + **URL**: [https://git.resf.org](https://git.resf.org) + + **Purpose**: General projects, code, and so on for the Rocky Enterprise Software Foundation. + + **Technology**: [Gitea](https://gitea.io/en-us/) + + **Contact**: `~Infrastructure`, `~Development` in Mattermost and `#rockylinux-infra`, `#rockylinux-devel` in Libera IRC + +=== "Git (Rocky Linux GitHub)" + + **URL**: [https://github.com/rocky-linux](https://github.com/rocky-linux) + + **Purpose**: General purpose code, assets, and so on for Rocky Linux. Some content is mirrored to the RESF Git Service. + + **Technology**: [GitHub](https://github.com) + + **Contact**: `~Infrastructure`, `~Development` in Mattermost and `#rockylinux-infra`, `#rockylinux-devel` in Libera IRC + + +=== "Git (Rocky Linux GitLab)" + + **URL**: [https://git.rockylinux.org](https://git.rockylinux.org) + + **Purpose**: Packages and light code for the Rocky Linux distribution + + **Technology**: [GitLab](https://gitlab.com) + + **Contact**: `~Infrastructure`, `~Development` in Mattermost and `#rockylinux-infra`, `#rockylinux-devel` in Libera IRC + +=== "Mail Lists" + + **URL**: [https://lists.resf.org](https://lists.resf.org) + + **Purpose**: Users can subscribe and interact with various mail lists for the Rocky ecosystem + + **Technology**: Mailman 3 + Hyper Kitty + + **Contact**: `~Infrastructure` in Mattermost and `#rockylinux-infra` in Libera IRC diff --git a/mkdocs.yml b/mkdocs.yml index f74f012..a40dbb7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,7 +3,7 @@ site_name: SIG/Core Wiki site_url: https://core.sig.rocky.page site_description: >- - The wiki for Core SIG. + The wiki for Rocky Linux Core SIG. # Repository repo_url: https://git.resf.org/sig_core/wiki @@ -47,5 +47,7 @@ plugins: - awesome-pages - git-revision-date - search + - macros: + include_dir: docs/include copyright: Copyright © 2022 Rocky Enterprise Software Foundation ...