Review retrace SOP

Signed-off-by: Michal Konečný <mkonecny@redhat.com>
This commit is contained in:
Michal Konečný 2021-09-10 13:40:48 +02:00
parent 171be2a07d
commit 987fe806f0
2 changed files with 33 additions and 41 deletions

View file

@ -95,7 +95,7 @@
** xref:registry.adoc[Container registry - SOP] ** xref:registry.adoc[Container registry - SOP]
** xref:requestforresources.adoc[Request for resources - SOP] ** xref:requestforresources.adoc[Request for resources - SOP]
** xref:resultsdb.adoc[ResultsDB - SOP] ** xref:resultsdb.adoc[ResultsDB - SOP]
** xref:retrace.adoc[retrace - SOP in review ] ** xref:retrace.adoc[Retrace - SOP]
** xref:scmadmin.adoc[scmadmin - SOP in review ] ** xref:scmadmin.adoc[scmadmin - SOP in review ]
** xref:selinux.adoc[selinux - SOP in review ] ** xref:selinux.adoc[selinux - SOP in review ]
** xref:sigul-upgrade.adoc[sigul-upgrade - SOP in review ] ** xref:sigul-upgrade.adoc[sigul-upgrade - SOP in review ]

View file

@ -1,9 +1,7 @@
= retrace SOP = Retrace SOP
____
Retrace server - provides complete tracebacks for unhandled crashes and Retrace server - provides complete tracebacks for unhandled crashes and
show aggregated information for developers. show aggregated information for developers.
____
== Contact Information == Contact Information
@ -19,8 +17,8 @@ Purpose:::
== Description == Description
The physical server (retrace.fedoraproject.org) runs two main services: The physical server (_retrace.fedoraproject.org_) runs two main services:
retrace-server and FAF. _retrace-server_ and _FAF_.
=== Retrace-server === Retrace-server
@ -32,21 +30,21 @@ ____
When a user has the ABRT client installed and a process crashes with an When a user has the ABRT client installed and a process crashes with an
unhandled exception (e.g., traceback or core dump), the user can send a unhandled exception (e.g., traceback or core dump), the user can send a
request to retrace-server. The server will install the same set of request to _retrace-server_. The server will install the same set of
packages plus debuginfo, and will return a traceback to the user that packages plus debuginfo, and will return a traceback to the user that
includes function names instead of plain pointers. This information is includes function names instead of plain pointers. This information is
useful for debugging. useful for debugging.
The upstream retrace-server allows users to upload coredumps through a The upstream _retrace-server_ allows users to upload coredumps through a
web interface, but the Fedora instance disables this feature. web interface, but the Fedora instance disables this feature.
=== FAF === FAF
When a user decides to report a crash, data is sent to FAF. ABRT can When a user decides to report a crash, data is sent to _FAF_. ABRT can
also be configured to send microreports automatically, if desired. also be configured to send microreports automatically, if desired.
FAF can aggregate similar reports into one entity (called a Problem). _FAF_ can aggregate similar reports into one entity (called a Problem).
FAF provides a nice web interface for developers, allowing them to see _FAF_ provides a nice web interface for developers, allowing them to see
crashes of their packages. It lives at: crashes of their packages. It lives at:
____ ____
@ -57,18 +55,17 @@ ____
The playbook is split into several roles. There are two main roles The playbook is split into several roles. There are two main roles
____
* abrt/faf * abrt/faf
* abrt/retrace * abrt/retrace
____
These roles are copied from upstream. You should never update it These roles are copied from upstream. You should never update it
directly. The new version can be fetched from upstream using: directly. The new version can be fetched from upstream using:
____ ....
# cd ansible/abrt # rm -rf faf retrace # ansible-galaxy install -f -r cd ansible/abrt
requirements.yml --ignore-errors -p ./ rm -rf faf retrace
____ ansible-galaxy install -f -r requirements.yml --ignore-errors -p ./
....
You should review the new differences, and commit and push. You should review the new differences, and commit and push.
@ -82,20 +79,20 @@ ____
== Services == Services
FAF and retrace-server are web applications; only httpd is required. _FAF_ and _retrace-server_ are web applications; only httpd is required.
== Cron == Cron
FAF and retrace-server each have cron tasks. They are _not_ installed _FAF_ and _retrace-server_ each have cron tasks. They are _not_ installed
under /etc/cron* but are installed as user cron jobs for the 'faf' and under `/etc/cron*` but are installed as user cron jobs for the 'faf' and
'retrace' users. 'retrace' users.
You can list those crons using: You can list those crons using:
____ ....
* sudo -u faf crontab -l sudo -u faf crontab -l
* sudo -u retrace crontab -l sudo -u retrace crontab -l
____ ....
All cronjobs should be Ansible managed. Just make sure if you delete All cronjobs should be Ansible managed. Just make sure if you delete
some cron from Ansible that it does not remain on the server (not always some cron from Ansible that it does not remain on the server (not always
@ -103,34 +100,29 @@ possible with state=absent).
== Directories == Directories
* /srv/ssd - fast disk, used for PostgreSQL storage * `/srv/ssd` - fast disk, used for PostgreSQL storage
* /srv - big fat disk, used for storing packages. Mainly: * `/srv` - big fat disk, used for storing packages. Mainly:
** /srv/faf/lob ** `/srv/faf/lob`
** /srv/retrace ** `/srv/retrace`
* {blank} * `/srv/faf/db-backup/` - Daily backups of DB. No rotating yet. Needs to be
+
/srv/faf/db-backup/ - Daily backups of DB. No rotating yet. Needs to
be::
manually deleted occasionally. manually deleted occasionally.
* {blank} * `/srv/faf/lob/InvalidUReport/` - Invalid reports, can be pretty big.
+
/srv/faf/lob/InvalidUReport/ - Invalid reports, can be pretty big.::
No automatic removal too. Need to be purged manually occasionally. No automatic removal too. Need to be purged manually occasionally.
== Front-page == Front-page
The main web page is handled by the [.title-ref]#abrt-server-info-page# The main web page is handled by the _abrt-server-info-page_
package, which can be controlled using: package, which can be controlled using:
____ ....
/usr/lib/python2.7/site-packages/abrt-server-info-page/config.py /usr/lib/python2.7/site-packages/abrt-server-info-page/config.py
____ ....
== DB == DB
Only FAF uses a database. We use our own instance of PostgreSQL. You can Only _FAF_ uses a database. We use our own instance of PostgreSQL. You can
connect to it using: connect to it using:
____ ....
sudo -u faf psql faf sudo -u faf psql faf
____ ....