]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev: remove seqdiag assets 52310/head
authorZac Dover <zac.dover@proton.me>
Tue, 4 Jul 2023 17:37:10 +0000 (03:37 +1000)
committerZac Dover <zac.dover@proton.me>
Tue, 4 Jul 2023 17:55:47 +0000 (03:55 +1000)
Remove seqdiag assets to determine whether the docs can be built if they
are absent. (Currently they cannot be built when they are present.) If
this works, then these diagrams will be replaced, probably with .png
files.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit ce96ddd4c7da65351deaf14dc4f8b42f5148a352)

doc/dev/health-reports.rst

index ff45429b22aa5b645dc517a2e8a4662e597d0d7b..b95f55c74c181a693443f2c6ae08b2f37bca2d06 100644 (file)
@@ -16,32 +16,6 @@ mgr module
 The following diagrams outline the involved parties and how the interact when the clients
 query for the reports:
 
-.. seqdiag::
-
-   seqdiag {
-     default_note_color = lightblue;
-     osd; mon; ceph-cli;
-     osd  => mon [ label = "update osdmap service" ];
-     osd  => mon [ label = "update osdmap service" ];
-     ceph-cli  -> mon [ label = "send 'health' command" ];
-     mon -> mon [ leftnote = "gather checks from services" ];
-     ceph-cli <-- mon [ label = "checks and mutes" ];
-   }
-
-.. seqdiag::
-
-   seqdiag {
-     default_note_color = lightblue;
-     osd; mon; mgr; mgr-module;
-     mgr  -> mon [ label = "subscribe for 'mgrdigest'" ];
-     osd  => mon [ label = "update osdmap service" ];
-     osd  => mon [ label = "update osdmap service" ];
-     mon  -> mgr [ label = "send MMgrDigest" ];
-     mgr  -> mgr [ note = "update cluster state" ];
-     mon <-- mgr;
-     mgr-module  -> mgr [ label = "mgr.get('health')" ];
-     mgr-module <-- mgr [ label = "heath reports in json" ];
-   }
 
 Where are the Reports Generated
 ===============================
@@ -68,19 +42,6 @@ later loaded and decoded, so they can be collected on demand. When it comes to
 ``MDSMonitor``, it persists the health metrics in the beacon sent by the MDS daemons,
 and prepares health reports when storing the pending changes.
 
-.. seqdiag::
-
-   seqdiag {
-     default_note_color = lightblue;
-     mds; mon-mds; mon-health; ceph-cli;
-     mds  -> mon-mds [ label = "send beacon" ];
-     mon-mds -> mon-mds [ note = "store health metrics in beacon" ];
-     mds <-- mon-mds;
-     mon-mds -> mon-mds [ note = "encode_health(checks)" ];
-     ceph-cli -> mon-health [ label = "send 'health' command" ];
-     mon-health => mon-mds [ label = "gather health checks" ];
-     ceph-cli <-- mon-health [ label = "checks and mutes" ];
-   }
 
 So, if we want to add a new warning related to cephfs, probably the best place to
 start is ``MDSMonitor::encode_pending()``, where health reports are collected from
@@ -106,23 +67,3 @@ metrics and status to mgr using ``MMgrReport``. On the mgr side, it periodically
 an aggregated report to the ``MgrStatMonitor`` service on mon. As explained earlier,
 this service just persists the health reports in the aggregated report to the monstore.
 
-.. seqdiag::
-
-   seqdiag {
-     default_note_color = lightblue;
-     service; mgr; mon-mgr-stat; mon-health;
-     service -> mgr [ label = "send(open)" ];
-     mgr -> mgr [ note = "register the new service" ];
-     service <-- mgr;
-     mgr => service [ label = "send(configure)" ];
-     service -> mgr [ label = "send(report)" ];
-     mgr -> mgr [ note = "update/aggregate service metrics" ];
-     service <-- mgr;
-     service => mgr [ label = "send(report)" ];
-     mgr -> mon-mgr-stat [ label = "send(mgr-report)" ];
-     mon-mgr-stat -> mon-mgr-stat [ note = "store health checks in the report" ];
-     mgr <-- mon-mgr-stat;
-     mon-health => mon-mgr-stat [ label = "gather health checks" ];
-     service => mgr [ label = "send(report)" ];
-     service => mgr [ label = "send(close)" ];
-   }