#24 [WIP] Update documentation
Opened 3 months ago by pjgeorg. Modified 3 months ago

@@ -0,0 +1,19 @@ 

+ There are various ways to communicate with the Kmods SIG.

+ 

+ # Report Bugs/Issues/RFE

+ Please report any issue specific to a certain package in the corresponding project's issue tracker on [pagure.io](https://pagure.io/projects/centos-sig-kmods/%2A).

+ 

+ In case the issue is not related to a specific package or you want to request a new package please use this [issue tracker](https://pagure.io/centos-sig-kmods/sig/issues).

+ 

+ # IRC

+ For interactive communication or short question IRC is best suited.

+ You can find us in [#centos-kmods](https://wiki.centos.org/irc#A.23centos-kmods) on [Libera.Chat](https://libera.chat/).

+ 

+ # Mailing list

+ Mailing list is mainly used for coordination and discuss larger issues.

+ We do not have a Kmods SIG specific mailing list, hence we use [centos-devel](https://lists.centos.org/mailman/listinfo/centos-devel) for this purpose.

+ 

+ # Regular Meetings

+ [Regular IRC meetings](https://www.centos.org/community/calendar/#Kmods_SIG) are held monthly, in the first week, on Monday at 1600 UTC in [#centos-meeting](https://wiki.centos.org/irc#A.23centos-meeting) on [Libera.Chat](https://libera.chat/).

+ 

+ See [Meeting minutes](internal/minutes.md) for minutes of past meetings.

file added
+9
@@ -0,0 +1,9 @@ 

+ # Prebuild Driver Discs

+ The Kmods SIG is currently looking into building Driver Disc in CBS.

+ This requires collaboration and further discussion with Infra SIG.

+ The current state can be tracked [here](https://pagure.io/centos-infra/issue/418).

+ 

+ # Driver Disc Creator

+ The Kmods SIG provides a script called [ddc.sh](https://pagure.io/centos-sig-kmods/sig/blob/main/f/scripts/ddc.sh) to create driver discs including kernel module packages specified by the user.

+ The script is currently limited to kernel module packages provided by the Kmods SIG.

+ Run `ddc.sh --help` for information on usage.

file modified
+3 -41
@@ -1,42 +1,4 @@ 

- The [Kmods SIG](https://wiki.centos.org/SpecialInterestGroup/Kmods) focuses on providing kernel modules currently not available in CentOS Stream.

- 

- # What's in scope

- This SIG is a good place for any kernel module that is beneficial to CentOS Stream, but cannot be directly contributed to any of the involved upstream projects. These kernel modules may be divided in three categories:

- 

- ## Restore support for deprecated devices

- The CentOS Stream kernel includes several kernel modules for which the list of supported devices has been limited by Red Hat. This SIG aims to provide versions of these kernel modules with restored support for as many deprecated and removed devices as possible.

- 

- ## In-tree kernel modules not enabled for CentOS Stream

- Many in-tree kernel modules are simply disabled for the CentOS Stream kernel. This may either be due to drivers being deprecated and removed compared to older CentOS major releases or never being enabled in the first place. This SIG aims to provide these in-tree drivers as external kernel modules to enable CentOS Stream running on a broader range of available hardware and provide other beneficial functionality.

- 

- ## Out-of-tree kernel modules

- This SIG also aims to provide out-of-tree kernel modules for CentOS Stream. Due to legal reasons, out-of-tree kernel modules with a non GPL v2 compatible license require a case by case review by Red Hat Legal.

- 

- ## User space tools

- User space tools required by or specific to kernel modules provided by this SIG, which are not suitable to be included in EPEL, shall be provided by this SIG as well.

- 

- # What's not in scope

- Anything that can be contributed directly to any of the involved upstream projects is not in scope. This includes, but is not limited to:

- 

- *  Unrelated user space packages: These should be submitted to Fedora/EPEL

- *  Support for new architectures currently not supported by CentOS Stream

- *  Kernel modules with a non GPL v2 compatible license and no exception given by Red Hat Legal

- 

- # Collaboration

- It is desired to work closely together with other groups working on similar tasks within the CentOS Stream community and the broader Enterprise Linux community. In particular this includes, but is not limited to:

- 

- ## kernel-plus

- Especially for in-tree kernel modules it is desired to closely work together with the kernel-plus developers/maintainers.

- 

- ## CentOS Stream kernel

- A close collaboration with upstream is desired to get any valuable kernel module directly into the CentOS Stream kernel.

- 

- ## ELRepo

- There is a large overlap with ELRepo for many of the kernel modules to be provided by this SIG for CentOS Stream. Hence we hope to establish a good connection with the ELRepo community which shall be beneficial to both sides.

- 

- # Roadmap

- * Provide packages for in-tree kernel modules with restored support for deprecated devices

- * Provide packages for in-tree kernel modules that have been supported in older CentOS major releases

- * Provide packages for further in- and out-of-tree kernel modules as requested by the community

- * Work with other SIGs and others involved to establish a common work-flow to sign kernels and/or kernel modules provided by SIGs.

+ The [Kmods SIG](https://wiki.centos.org/SpecialInterestGroup/Kmods) focuses on packaging and maintaining kernel modules for CentOS Stream and Enterprise Linux.

  

+ We welcome anybody that's interested and willing to do work within the scope of the Kmods SIG to join and contribute.

+ See [membership](membership.md) for how to join.

file added
+25
@@ -0,0 +1,25 @@ 

+ We offer `centos-release-kmods` packages containing our repository configuration files and [public package signing key](https://www.centos.org/keys/RPM-GPG-KEY-CentOS-SIG-Kmods) for different Enterprise Linux major versions.

+ 

+ For convenience most Enterprise Linux based distributions include the `centos-release-kmods` package in their default repositories ready to be installed.

+ 

+ ```shell

+ $ sudo dnf install centos-release-kmods

+ ```

+ 

+ In case your distribution does not include the `centos-release-kmods` package you can install it from the official CentOS mirrors.

+ 

+ For Enterprise Linux 8 distributions:

+ ```shell

+ $ sudo dnf install http://mirror.centos.org/centos/8/...

+ ```

+ 

+ Note:

+ `centos-release-kmods` is signed using the [CentOS SIG Extras GPG key](https://www.centos.org/keys/RPM-GPG-KEY-CentOS-SIG-Extras).

+ 

+ Once `centos-release-kmods` is installed individual repositories can be enabled as desired.

+ 

+ ```shell

+ $ sudo dnf config-manger --set-enabled centos-kmods-<repository name>

+ ```

+ 

+ See [Repositories](repositories.md) for a list of available repositories.

@@ -1,9 +0,0 @@ 

- This [documentation site](https://sigs.centos.org/kmods) is generated

- from our [Pagure repository](https://pagure.io/centos-sig-kmods/sig) using

- [mkdocs](https://www.mkdocs.org). It uses the same

- [configuration](https://git.centos.org/centos/centos-infra-docs/blob/master/f/mkdocs.yml)

- as the CentOS Infra documentation (notably, the

- [material theme](https://squidfunk.github.io/mkdocs-material/)).

- 

- To test changes, run `make test` which will spawn a webserver on localhost. You

- can also run `make build` to render the documentation as a static site.

@@ -0,0 +1,15 @@ 

+ # Current members

+ 

+ * [Peter Georg](https://wiki.centos.org/PeterGeorg)

+ * [Patrick Riehecky](https://wiki.centos.org/PatrickRiehecky)

+ 

+ # Chairs

+ The SIG is co-chaired by two equal chairpersons elected by SIG members for one year.

+ Each chairperson is elected individually using a plurality vote.

+ 

+ The SIG is currently co-chaired by Peter Georg and <to be elected\>.

+ 

+ The next SIG chair election is scheduled to be held in June 2022.

+ 

+ # Former members

+ * Jonathan Billings

docs/internal/minutes.md docs/internal/meetings.md
file renamed
+1 -1
@@ -1,5 +1,5 @@ 

  This page collects meeting minutes for the Kmods SIG.

- [Regular IRC meetings](https://www.centos.org/community/calendar/#Kmods_SIG) are held monthly, in the first week, on Monday at 1600 UTC in #centos-meeting on Libera.Chat.

+ See [Regular Meetings](../communication.md#regular-meetings) for schedule of regular meetings.

  

  # 2022

  * [2022-05-02](https://www.centos.org/minutes/2022/May/centos-meeting.2022-05-02-15.00.html)

file modified
+4 -3
@@ -1,8 +1,9 @@ 

- The SIG publishes quarterly updates on the [CentOS Blog](https://blog.centos.org).

+ The SIG publishes quarterly reports on the [CentOS Blog](https://blog.centos.org).

  

- # 2021

+ # 2022

+ * [2022Q1](https://blog.centos.org/2022/04/centos-community-newsletter-april-2022/)

  

+ # 2021

  * [2021Q4](https://blog.centos.org/2022/01/centos-community-newsletter-january-2022/)

  * [2021Q3](https://blog.centos.org/2021/10/kmods-sig-quarterly-report-2/)

  * [2021Q2](https://blog.centos.org/2021/07/kmods-sig-quarterly-report/)

- 

file modified
+2 -3
@@ -1,6 +1,5 @@ 

- RPM packages list provided kernel modules as `Provides`. I.e. one can use `dnf`

- to search for packages in enabled repositories which provide a certain kernel

- module named `name.ko`:

+ RPM packages list provided kernel modules as `Provides`.

+ I.e., one can use `dnf` to search for packages in enabled repositories which provide a certain kernel module named `name.ko`:

  

  ```

  sudo dnf whatprovides "kmod(name.ko)"

file added
+5
@@ -0,0 +1,5 @@ 

+ Everybody is welcome to join and contribute to the Kmods SIG.

+ Membership can be requested by asking on the [mailing list](communication.md#mailing-list), the [Kmods SIG Issue Tracker](https://pagure.io/centos-sig-kmods/sig/issues), or by asking during one of the [regular meetings](communication.md#regular-meetings).

+ Any current member can raise objections and request a simple majority vote on membership applications.

+ SIG members are expected to actively contribute or otherwise remain engaged with the project.

+ Stale members may be removed by a simple majority vote after six months of inactivity.

file modified
+6 -17
@@ -1,26 +1,15 @@ 

  Packages provided by the kmods SIG are seperated into different repositories.

- Please report any issues with these packages in the corresponding project on

- [pagure.io](https://pagure.io/projects/centos-sig-kmods/%2A) or

- [here](https://pagure.io/centos-sig-kmods/sig/issues) in case the issue is not

- related to a particular package.

- 

+ Install `centos-release-kmods` as described in [Quickstart](install.md) to gain access to these repositories.

  

  # Main

- 

  Packages released in `main` are designed to be extensions to the distribution.

- This repository can be enabled by installing the `centos-release-kmods` package:

- 

- ```shell

- $ sudo dnf install centos-release-kmods

- ```

+ This repository is enabled by default.

  

  # Rebuild

- Packages released in `rebuild` are designed to modify content provided by the

- distribution.  In particular the source code for these kernel modules has been

- modified to restore support for devices that have been explicitly removed.

- This repository can be enabled by installing the `centos-release-kmods-rebuild`

- package:

+ Packages released in `rebuild` modify content provided by the distribution.

+ In particular the source code for these kernel modules has been modified to restore support for devices that have been explicitly removed.

+ This repository can be enabled by:

  

  ```shell

- $ sudo dnf install centos-release-kmods-rebuild

+ $ sudo dnf config-manger --set-enabled centos-kmods-rebuild

  ```

file modified
+3 -5
@@ -1,5 +1,3 @@ 

- When Secure Boot is enabled, the system boot loaders, the kernel, and all

- kernel modules have to be signed with a private key and authenticated with the

- corresponding public key. All kernel modules provided by the kmods SIG are

- currently not signed with a private key. Hence it is required to disable Secure

- Boot to be able to use any of these kernel modules.

+ When Secure Boot is enabled, the system boot loaders, the kernel, and all kernel modules have to be signed with a private key and authenticated with the corresponding public key.

+ All kernel modules provided by the kmods SIG are currently not signed with a private key.

+ Hence it is required to disable Secure Boot to be able to use any of these kernel modules.

file modified
+7 -8
@@ -6,32 +6,32 @@ 

  

  nav:

    - Overview: index.md

-   - Secure Boot: secure_boot.md

+   - Quickstart: install.md

+   - Communication: communication.md

    - Repositories: repositories.md

+   - Secure Boot: secure_boot.md

    - Finding a kernel module: kmod.md

    - Packages:

      - Enterprise Linux 8: packages/c8.md

      - Stream 8: packages/c8s.md

      - Stream 9: packages/c9s.md

+   - Driver Discs: dd.md

    - kABI Stability:

      - Enterprise Linux 8: kabi/c8.md

      - Stream 8: kabi/c8s.md

      - Stream 9: kabi/c9s.md

+   - Memberhip: membership.md

    - SIG internal:

-     - Meeting minutes: internal/meetings.md

+     - Members: internal/members.md

+     - Meeting minutes: internal/minutes.md

      - Quarterly reports: internal/reports.md

      - Working with CBS: internal/cbs.md

-     - Documentation: internal/documentation.md

- 

  

  theme:

    name: material

    logo: img/centos.png

    favicon: img/favicon-centos.ico

    features:

-     - navigation.expand

-     - navigation.instant

-     - navigation.tracking

      - navigation.top

      - toc.integrate

  
@@ -39,4 +39,3 @@ 

    - toc:

        baselevel: 4

        permalink: true

-