Infrastructure/arc
3
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Make minor changes and move FCAS to Completed section

Browse source 
Signed-off-by: Akashdeep Dhar <akashdeep.dhar@gmail.com>
This commit is contained in:
Akashdeep Dhar 2023-05-23 12:32:17 +05:30
parent 59c60a0471
commit 5c82ebf5dd
3 changed files with 67 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/fcas/creation_workflow.rst
View file

@ -12,14 +12,15 @@ repository is located at
How does it work?
----
There are essentially two functional units in the project - the ``namelist`` that
lets the service runner fetch the usernames from the FASJSON service on a file
and the ``actvlist`` that checks the activity for the names present in the
aforementioned file on Datagrepper. These are run as automated cronjobs to be
run once every after a certain period of time to obtain both an updated list
of usernames as well as an updated count of active users. The functioning of
the service is governed by a configuration file that can be edited to suit the
requirements of those running the service.
The project consists of two main functional units: the ``namelist`` unit and
the ``actvlist`` unit. The ``namelist`` unit facilitates the retrieval of
usernames from the FASJSON service by the service runner, while the
``actvlist`` unit verifies the activity status of the names listed in the
aforementioned file through Datagrepper. Both units are executed as automated
cronjobs, scheduled to run at specific intervals. This ensures that the service
maintains an up-to-date list of usernames and a count of active users. The
service's behavior is controlled by a configurable file, allowing
administrators to tailor it according to their specific needs.
**Usage** ::
@ -34,7 +35,7 @@ requirements of those running the service.
namelist Fetch a list of usernames on the Fedora Account System
Configuration file
^^^^
----
The sample configuration file can be found
`here <https://github.com/t0xic0der/fuas/blob/main/fuas/conf.py>`_ that can be
@ -62,7 +63,7 @@ scope. These variables are intended only for developers.
1. ``dfltsize`` (Default - 1000) - Size of iterable pages for all entities present in the FASJSON service
The ``namelist`` unit
^^^^
----
The service unit takes up the configuration variables like ``username`` and
``password`` for the user to masquerade as while probing into the FASJSON
@ -100,7 +101,7 @@ workflow on GitHub Actions is, however, 6 hours and that might, in some cases,
lead to timeouts and incomplete runs.
The ``actvlist`` unit
^^^^
---
The service unit takes up the configuration variables like ``listlink`` for
locating the file containing the list of all users registered on Fedora