From 2efa4980b573e08ff3e99b41ee8b6ea733a19481 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Kone=C4=8Dn=C3=BD?= Date: Thu, 19 Aug 2021 12:53:08 +0200 Subject: [PATCH] Review fedmsg-introduction SOP MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michal Konečný --- modules/sysadmin_guide/nav.adoc | 2 +- .../sysadmin_guide/pages/fedmsg-introduction.adoc | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/modules/sysadmin_guide/nav.adoc b/modules/sysadmin_guide/nav.adoc index ce80271..d5ee0fe 100644 --- a/modules/sysadmin_guide/nav.adoc +++ b/modules/sysadmin_guide/nav.adoc @@ -27,7 +27,7 @@ ** xref:fas-openid.adoc[FAS-OpenID - SOP] ** xref:fedmsg-certs.adoc[fedmsg (Fedora Messaging) Certs, Keys, and CA - SOP] ** xref:fedmsg-gateway.adoc[fedmsg-gateway - SOP] -** xref:fedmsg-introduction.adoc[fedmsg-introduction - SOP in review ] +** xref:fedmsg-introduction.adoc[fedmsg introduction and basics - SOP] ** xref:fedmsg-irc.adoc[fedmsg-irc - SOP in review ] ** xref:fedmsg-new-message-type.adoc[fedmsg-new-message-type - SOP in review ] ** xref:fedmsg-relay.adoc[fedmsg-relay - SOP in review ] diff --git a/modules/sysadmin_guide/pages/fedmsg-introduction.adoc b/modules/sysadmin_guide/pages/fedmsg-introduction.adoc index 021f003..c93b211 100644 --- a/modules/sysadmin_guide/pages/fedmsg-introduction.adoc +++ b/modules/sysadmin_guide/pages/fedmsg-introduction.adoc @@ -15,17 +15,17 @@ Purpose:: == Description -fedmsg is a system that links together most of our webapps and services +_fedmsg_ is a system that links together most of our webapps and services into a message mesh or net (often called a "bus"). It is built on top of the zeromq messaging library. -fedmsg has its own developer documentation that is a good place to check +_fedmsg_ has its own developer documentation that is a good place to check if this or other SOPs don't provide enough information - http://fedmsg.rtfd.org == Tools -Generally, fedmsg-tail and fedmsg-logger are the two most commonly used +Generally, _fedmsg-tail_ and _fedmsg-logger_ are the two most commonly used tools for debugging and testing. To see if bus-connectivity exists between two machines, log onto each of them and run the following on the first: @@ -42,16 +42,16 @@ $ fedmsg-tail --really-pretty == Configuration -fedmsg configuration lives in /etc/fedmsg.d/ +_fedmsg_ configuration lives in `/etc/fedmsg.d/` `/etc/fedmsg.d/endpoints.py` keeps the list of every possible fedmsg endpoint. It acts as a global index that defines the bus. -See fedmsg.readthedocs.org/en/latest/config/ for a full glossary of +See https://fedmsg.readthedocs.org/en/stable/configuration/ for a full glossary of configuration values. == Logs -fedmsg daemons keep their logs in /var/log/fedmsg. fedmsg message hooks +_fedmsg_ daemons keep their logs in `/var/log/fedmsg`. _fedmsg_ message hooks in existing apps (like bodhi) will log any errors to the logs of the app -they've been added to (like /var/log/httpd/error_log). +they've been added to (like `/var/log/httpd/error_log`).