Skip to content

Commit ce96ddd

Browse files
committed
doc/dev: remove seqdiag assets
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 <[email protected]>
1 parent 0f303c0 commit ce96ddd

File tree

1 file changed

+0
-59
lines changed

1 file changed

+0
-59
lines changed

doc/dev/health-reports.rst

Lines changed: 0 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -16,32 +16,6 @@ mgr module
1616
The following diagrams outline the involved parties and how the interact when the clients
1717
query for the reports:
1818

19-
.. seqdiag::
20-
21-
seqdiag {
22-
default_note_color = lightblue;
23-
osd; mon; ceph-cli;
24-
osd => mon [ label = "update osdmap service" ];
25-
osd => mon [ label = "update osdmap service" ];
26-
ceph-cli -> mon [ label = "send 'health' command" ];
27-
mon -> mon [ leftnote = "gather checks from services" ];
28-
ceph-cli <-- mon [ label = "checks and mutes" ];
29-
}
30-
31-
.. seqdiag::
32-
33-
seqdiag {
34-
default_note_color = lightblue;
35-
osd; mon; mgr; mgr-module;
36-
mgr -> mon [ label = "subscribe for 'mgrdigest'" ];
37-
osd => mon [ label = "update osdmap service" ];
38-
osd => mon [ label = "update osdmap service" ];
39-
mon -> mgr [ label = "send MMgrDigest" ];
40-
mgr -> mgr [ note = "update cluster state" ];
41-
mon <-- mgr;
42-
mgr-module -> mgr [ label = "mgr.get('health')" ];
43-
mgr-module <-- mgr [ label = "heath reports in json" ];
44-
}
4519

4620
Where are the Reports Generated
4721
===============================
@@ -68,19 +42,6 @@ later loaded and decoded, so they can be collected on demand. When it comes to
6842
``MDSMonitor``, it persists the health metrics in the beacon sent by the MDS daemons,
6943
and prepares health reports when storing the pending changes.
7044

71-
.. seqdiag::
72-
73-
seqdiag {
74-
default_note_color = lightblue;
75-
mds; mon-mds; mon-health; ceph-cli;
76-
mds -> mon-mds [ label = "send beacon" ];
77-
mon-mds -> mon-mds [ note = "store health metrics in beacon" ];
78-
mds <-- mon-mds;
79-
mon-mds -> mon-mds [ note = "encode_health(checks)" ];
80-
ceph-cli -> mon-health [ label = "send 'health' command" ];
81-
mon-health => mon-mds [ label = "gather health checks" ];
82-
ceph-cli <-- mon-health [ label = "checks and mutes" ];
83-
}
8445

8546
So, if we want to add a new warning related to cephfs, probably the best place to
8647
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
10667
an aggregated report to the ``MgrStatMonitor`` service on mon. As explained earlier,
10768
this service just persists the health reports in the aggregated report to the monstore.
10869

109-
.. seqdiag::
110-
111-
seqdiag {
112-
default_note_color = lightblue;
113-
service; mgr; mon-mgr-stat; mon-health;
114-
service -> mgr [ label = "send(open)" ];
115-
mgr -> mgr [ note = "register the new service" ];
116-
service <-- mgr;
117-
mgr => service [ label = "send(configure)" ];
118-
service -> mgr [ label = "send(report)" ];
119-
mgr -> mgr [ note = "update/aggregate service metrics" ];
120-
service <-- mgr;
121-
service => mgr [ label = "send(report)" ];
122-
mgr -> mon-mgr-stat [ label = "send(mgr-report)" ];
123-
mon-mgr-stat -> mon-mgr-stat [ note = "store health checks in the report" ];
124-
mgr <-- mon-mgr-stat;
125-
mon-health => mon-mgr-stat [ label = "gather health checks" ];
126-
service => mgr [ label = "send(report)" ];
127-
service => mgr [ label = "send(close)" ];
128-
}

0 commit comments

Comments
 (0)