From 0aef8d1ec914611aaf6047a54e5f04443b49a55c Mon Sep 17 00:00:00 2001 From: Louis Abel Date: Sat, 15 Oct 2022 17:28:22 -0700 Subject: [PATCH] Start adding modifications and prepping for existence --- .github/workflows/gh.yml | 29 +++++++++++++++++++++ README.md | 14 +++++++++++ docs/.pages | 4 +-- docs/CNAME | 2 +- docs/assets/icon-white.svg | 3 +++ docs/documentation/.pages | 4 +-- docs/documentation/compose.md | 7 ++++++ docs/documentation/empanadas.md | 43 ++++++++++++++++++++++++++++++++ docs/documentation/index.md | 21 ++++++++++------ docs/include/resources_bottom.md | 13 ++++++++++ docs/index.md | 22 ++++++++-------- docs/sop/.pages | 5 ++-- mkdocs.yml | 22 ++++++++++++---- 13 files changed, 159 insertions(+), 30 deletions(-) create mode 100644 .github/workflows/gh.yml create mode 100644 README.md create mode 100644 docs/assets/icon-white.svg create mode 100644 docs/documentation/compose.md create mode 100644 docs/documentation/empanadas.md diff --git a/.github/workflows/gh.yml b/.github/workflows/gh.yml new file mode 100644 index 0000000..72f4983 --- /dev/null +++ b/.github/workflows/gh.yml @@ -0,0 +1,29 @@ +--- +name: mkdocs build +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [ 3.8 ] + + steps: + - uses: actions/checkout@v2 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + architecture: x64 + + - name: Install requirements + run: python3 -m pip install -r requirements.txt + + - name: Deploy + run: python3 -m mkdocs gh-deploy --force +... diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc39059 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# SIG/Core Wiki +[![mkdocs build](https://github.com/rocky-linux/sig-core-wiki/actions/workflows/gh.yml/badge.svg)](https://github.com/rocky-linux/sig-core-wiki/actions/workflows/gh.yml) + +This is the wiki repository for SIG/Core. + +https://sig-core.rocky.page + +## Building + +To test the appearance of this wiki, give it a try: + +``` + +``` diff --git a/docs/.pages b/docs/.pages index 26a1d07..4039603 100644 --- a/docs/.pages +++ b/docs/.pages @@ -2,6 +2,6 @@ nav: - ... | index.md - ... | about.md - - Documentation | documentation - - SOP | sop + - Documentation: documentation + - SOP: sop ... diff --git a/docs/CNAME b/docs/CNAME index 492df2a..1cdac2e 100644 --- a/docs/CNAME +++ b/docs/CNAME @@ -1 +1 @@ -core.sig.rocky.page +sig-core.rocky.page diff --git a/docs/assets/icon-white.svg b/docs/assets/icon-white.svg new file mode 100644 index 0000000..689ab46 --- /dev/null +++ b/docs/assets/icon-white.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/documentation/.pages b/docs/documentation/.pages index c781ea1..c0a12ff 100644 --- a/docs/documentation/.pages +++ b/docs/documentation/.pages @@ -1,6 +1,6 @@ --- nav: - ... | index.md - - Composing Releases | compose.md - - Empanadas | empanadas.md + - Composing Releases: compose.md + - Empanadas: empanadas.md ... diff --git a/docs/documentation/compose.md b/docs/documentation/compose.md new file mode 100644 index 0000000..2d8c886 --- /dev/null +++ b/docs/documentation/compose.md @@ -0,0 +1,7 @@ +--- +title: Composing Releases +--- + +This page goes over the process of composing a release. + +More to come. diff --git a/docs/documentation/empanadas.md b/docs/documentation/empanadas.md new file mode 100644 index 0000000..2f71259 --- /dev/null +++ b/docs/documentation/empanadas.md @@ -0,0 +1,43 @@ +--- +title: Empanadas +--- + +This page goes over `empanadas`, which is part of the SIG/Core toolkit. Empanadas +assists SIG/Core is composing repositories, creating ISO's, creating images, and +various other activities in Rocky Linux. It is also used for general testing and +debugging of repositories and its metadata. + +## Contact Information + +| | | +| - | - | +| **Owner** | SIG/Core (Release Engineering & Infrastructure) | +| **Email Contact** | releng@rockylinux.org | +| **Mattermost Contacts** | `@label` `@neil` | +| **Mattermost Channels** | `~Development` | + +## General Information + +`empanadas` is a python project using poetry, containing various built-in modules +with the goal to try to emulate the Fedora Project's pungi to an extent. While it +is not perfect, it achieves the very basic goals of creating repositories, images +and ISO's for consumption by the end user. It also has interactions with peridot, +the build system used by Rocky Linux to build the distribution. + +For performing syncs, it relies on the use of podman to perform syncing in a +parallel fashion. This was done because it is not possible to run multiple dnf +transactions at once on a single system and looping one repository at a time is +not sustainable. + +## Requirements + +* Poetry must be available on the system +* Podman must be installed on the system +* fpart must be installed on the system (available in EPEL) +* Enough storage should be available if repositories are being synced + +## Using Empanadas + +### + +{% include "resources_bottom.md" %} diff --git a/docs/documentation/index.md b/docs/documentation/index.md index ae3cc8f..14d4ffc 100644 --- a/docs/documentation/index.md +++ b/docs/documentation/index.md @@ -15,12 +15,12 @@ derivative or another project entirely. 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) | +| Tool | Maintainer | Code Location | +|-----------------|------------------|---------------------------------------------------------------------| +| srpmproc | SIG/Core at RESF | [GitHub](https://github.com/rocky-linux/srpmproc) | +| empanadas | SIG/Core at RESF | [sig-core-toolkit](https://github.com/rocky-linux/sig-core-toolkit) | +| Peridot | SIG/Core at RESF | [GitHub](https://github.com/rocky-linux/peridot) | +| 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 @@ -36,12 +36,17 @@ 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 +* A repoclosure is ran against the repositories from empanadas to ensure there are no critical issues * In Parallel: - * Repositories are synced as a "full run" in empanadas - * Lorax is ran using empanadas in the peridot cluster + + * 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 +* Staging is synced to production to allow mirror syncing +* Bit flip on release day ## General Updates diff --git a/docs/include/resources_bottom.md b/docs/include/resources_bottom.md index 365a10d..3565fd3 100644 --- a/docs/include/resources_bottom.md +++ b/docs/include/resources_bottom.md @@ -51,3 +51,16 @@ **Technology**: Mailman 3 + Hyper Kitty **Contact**: `~Infrastructure` in Mattermost and `#rockylinux-infra` in Libera IRC + +=== "Contacts" + + | Name | Email | Mattermost Name | IRC Name | + |---------------------------------|-------------------------|-------------------|--------------------| + | Louis Abel | label@rockylinux.org | @nazunalika | Sokel/label/Sombra | + | Mustafa Gezen | mustafa@rockylinux.org | @mustafa | mstg | + | Skip Grube | skip@rockylinux.org | @skip77 | | + | Sherif Nagy | sherif@rockylinux.org | @sherif | | + | Pablo Greco | pgreco@rockylinux.org | @pgreco | pgreco | + | Neil Hanlon | neil@resf.org | @neil | neil | + | Taylor Goodwill | tg@resf.org | @tgo | tg | + diff --git a/docs/index.md b/docs/index.md index 4d649d5..44d0940 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,18 +6,20 @@ title: SIG/Core ## About -Rocky Linux Center for Technical Excellence +The Rocky Linux Core Special Interest Group (SIG/Core) dedicates themselves to the development, building, production, and release of Rocky Linux for the Enterprise Linux community and the many users around the world. This group is a mixture of core Rocky Linux developers and infrastructure and the members of this group are also members of other groups within the Rocky Linux community (such as SIG/AltArch) as well as the Enterprise Linux community as a whole. ## Mission Statement +SIG/Core strives to ensure a stable distribution is built, tested, and provided to the community from the RESF as a compatible derivative of Red Hat Enterprise Linux. + ## Contact -| Role | Name | Email | Mattermost Name | IRC Name | -|------------------------------------: |------------------------------- |--------------------- |--- | --- | -| Identity Management & Release Engineering Co-Lead | Louis Abel | label@rockylinux.org | @nazunalika | Sokel/label/Sombra | -| Release Engineering Co-Lead | Mustafa Gezen | mustafa@rockylinux.org | @mustafa | mstg | -| Release Engineering and Development | Skip Grube | skip@rockylinux.org | @skip77 | | -| Release Engineering and Development | Sherif Nagy | sherif@rockylinux.org | @sherif | | -| Release Engineering and Development | Pablo Greco | N/A | @pgreco | pgreco | -| Infrastructure | Neil Hanlon | neil@resf.org | @neil | neil | -| Infrastructure | Taylor Goodwill | tg@resf.org | @tgo | tg | +| Role | Name | Email | Mattermost Name | IRC Name | +|---------------------------------------------------|---------------------------------|------------------------ |-------------------|--------------------| +| Identity Management & Release Engineering Co-Lead | Louis Abel | label@rockylinux.org | @nazunalika | Sokel/label/Sombra | +| Release Engineering Co-Lead | Mustafa Gezen | mustafa@rockylinux.org | @mustafa | mstg | +| Release Engineering and Development | Skip Grube | skip@rockylinux.org | @skip77 | | +| Release Engineering and Development | Sherif Nagy | sherif@rockylinux.org | @sherif | | +| Release Engineering and Development | Pablo Greco | pgreco@rockylinux.org | @pgreco | pgreco | +| Infrastructure | Neil Hanlon | neil@resf.org | @neil | neil | +| Infrastructure | Taylor Goodwill | tg@resf.org | @tgo | tg | diff --git a/docs/sop/.pages b/docs/sop/.pages index fa02d00..8ff870e 100644 --- a/docs/sop/.pages +++ b/docs/sop/.pages @@ -1,4 +1,5 @@ ---- nav: +--- +nav: - ... | index.md - - Release Procedures | sop_release.md + - Release Procedures: sop_release.md ... diff --git a/mkdocs.yml b/mkdocs.yml index a40dbb7..5d8f22e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ --- # Wiki information site_name: SIG/Core Wiki -site_url: https://core.sig.rocky.page +site_url: https://sig-core.rocky.page site_description: >- The wiki for Rocky Linux Core SIG. @@ -11,7 +11,19 @@ repo_name: sig_core/wiki edit_uri: edit/main/docs/ theme: - name: cinder + name: material + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/weather-night + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/weather-night + name: Switch to dark mode + logo: assets/icon-white.svg highlightjs: true hljs_languages: - bash @@ -19,12 +31,12 @@ theme: - yaml - perl features: - - navigation.tabs - - navigation.tabs.sticky - - navigation.top - search.highlight - search.suggest - toc.integrate + #- navigation.tabs + #- navigation.tabs.sticky + #- navigation.top markdown_extensions: - abbr - admonition