arc/docs/kerneltest/index.rst
Michal Konečný ed89fe6173 Initial version of kerneltest ARC investigation
This is an initial version of the ARC investigation document for kerneltest
initiative.

It contains:
* index document with info, requirements for the project and what this
initiative needs to address
* repository enhancement investigation - what is missing in the repository
itself
* Complete rewrite stub - needs to be updated
* V2 reuse investigation - thorough investigation what is available in current
codebase, which wasn't released

Signed-off-by: Michal Konečný <mkonecny@redhat.com>
2022-08-29 17:05:01 +02:00

70 lines
1.8 KiB
ReStructuredText

kerneltest
==========
Purpose
-------
This investigation's goal is to address tech debt of kerneltest application.
kerneltest applications is used by Fedora QA for submitting test logs for
kernel builds in Fedora. It also provides web interface for users to access
and upload logs.
Currently there is a partial rewrite v2 in repository, which is not functionality
complete and was never released.
Resources
---------
* kerneltest repo: https://github.com/jmflinuxtx/kerneltest-harness
* kerneltest web: https://apps.fedoraproject.org/kerneltest/
* kerneltest ansible: https://pagure.io/fedora-infra/ansible/blob/main/f/roles/kerneltest
* kerneltest wiki: http://fedoraproject.org/wiki/KernelTestingInitiative
Requirements
------------
* Be able to upload logs anonymously, authenticated, super user
* Be able to view logs on front page showing super user ones
* When clicking on the release it should show all logs for a release
* Stats: https://apps.fedoraproject.org/kerneltest/stats (currently stored in postgres)
* Logs needs to be saved in persistent volume
* Send Fedora Messages for badges
* Size limitation on the uploaded logs (currently hardcoded in code)
What Needs To Be Addressed?
---------------------------
* Update authentication library
* Switch CI
* fedmsg -> fedora messaging (some v2 parts could be used)
* python2 -> python3
* migration to OpenShift
* Documentation - Fedora QA has some
* Users don't receive any badges
* Update development environment
* Web interface (should be revitalized)
Investigation
-------------
Here is the list of ideas/things we discussed/looked at:
.. toctree::
:maxdepth: 1
rewrite_of_kerneltest_app
continue_from_v2
enhancement_of_repository
Conclusions
-----------
Proposed Roadmap
----------------
* Step 1 - Address tech debt in kerneltest application
* Step 2 - ???
* Step 3 - Profit!