diff --git a/modules/sysadmin_guide/nav.adoc b/modules/sysadmin_guide/nav.adoc index d598537..cfce74b 100644 --- a/modules/sysadmin_guide/nav.adoc +++ b/modules/sysadmin_guide/nav.adoc @@ -95,7 +95,7 @@ ** xref:registry.adoc[Container registry - SOP] ** xref:requestforresources.adoc[Request for resources - 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:selinux.adoc[selinux - SOP in review ] ** xref:sigul-upgrade.adoc[sigul-upgrade - SOP in review ] diff --git a/modules/sysadmin_guide/pages/retrace.adoc b/modules/sysadmin_guide/pages/retrace.adoc index 529f169..56b093a 100644 --- a/modules/sysadmin_guide/pages/retrace.adoc +++ b/modules/sysadmin_guide/pages/retrace.adoc @@ -1,9 +1,7 @@ -= retrace SOP += Retrace SOP -____ Retrace server - provides complete tracebacks for unhandled crashes and show aggregated information for developers. -____ == Contact Information @@ -19,8 +17,8 @@ Purpose::: == Description -The physical server (retrace.fedoraproject.org) runs two main services: -retrace-server and FAF. +The physical server (_retrace.fedoraproject.org_) runs two main services: +_retrace-server_ and _FAF_. === Retrace-server @@ -32,21 +30,21 @@ ____ 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 -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 includes function names instead of plain pointers. This information is 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. === 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. -FAF can aggregate similar reports into one entity (called a Problem). -FAF provides a nice web interface for developers, allowing them to see +_FAF_ can aggregate similar reports into one entity (called a Problem). +_FAF_ provides a nice web interface for developers, allowing them to see crashes of their packages. It lives at: ____ @@ -57,18 +55,17 @@ ____ The playbook is split into several roles. There are two main roles -____ * abrt/faf * abrt/retrace -____ These roles are copied from upstream. You should never update it directly. The new version can be fetched from upstream using: -____ -# cd ansible/abrt # rm -rf faf retrace # ansible-galaxy install -f -r -requirements.yml --ignore-errors -p ./ -____ +.... +cd ansible/abrt +rm -rf faf retrace +ansible-galaxy install -f -r requirements.yml --ignore-errors -p ./ +.... You should review the new differences, and commit and push. @@ -82,20 +79,20 @@ ____ == Services -FAF and retrace-server are web applications; only httpd is required. +_FAF_ and _retrace-server_ are web applications; only httpd is required. == Cron -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 +_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 'retrace' users. You can list those crons using: -____ -* sudo -u faf crontab -l -* sudo -u retrace crontab -l -____ +.... +sudo -u faf crontab -l +sudo -u retrace crontab -l +.... 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 @@ -103,34 +100,29 @@ possible with state=absent). == Directories -* /srv/ssd - fast disk, used for PostgreSQL storage -* /srv - big fat disk, used for storing packages. Mainly: -** /srv/faf/lob -** /srv/retrace -* {blank} -+ -/srv/faf/db-backup/ - Daily backups of DB. No rotating yet. Needs to -be:: +* `/srv/ssd` - fast disk, used for PostgreSQL storage +* `/srv` - big fat disk, used for storing packages. Mainly: +** `/srv/faf/lob` +** `/srv/retrace` +* `/srv/faf/db-backup/` - Daily backups of DB. No rotating yet. Needs to be 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. == 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: -____ +.... /usr/lib/python2.7/site-packages/abrt-server-info-page/config.py -____ +.... == 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: -____ +.... sudo -u faf psql faf -____ +....