From 0c7f8f2ce6202e335497e890aa309912c831c9c1 Mon Sep 17 00:00:00 2001 From: Mario Alfredo Carrillo Arevalo Date: Wed, 12 Jun 2019 02:19:46 +0000 Subject: [PATCH] Add an overview about FM service This commit documents an overview in order to give a general idea about what is Fault Management service and what is the role in StarlingX project. Story: 2005863 Task: 33669 Change-Id: Id58385cabc9c656aa03132a42f39d9663a6be08e Signed-off-by: Mario Alfredo Carrillo Arevalo --- doc/source/figures/fm-usage-flow.png | Bin 0 -> 23063 bytes doc/source/index.rst | 61 ++++++++++++++++++++++++++- 2 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 doc/source/figures/fm-usage-flow.png diff --git a/doc/source/figures/fm-usage-flow.png b/doc/source/figures/fm-usage-flow.png new file mode 100644 index 0000000000000000000000000000000000000000..1bbb1946199b485cdf6679398cc1d946dd3090ca GIT binary patch literal 23063 zcmZ_0by$>Z*FHRU03xsz0RbgMi9u07+CV^%?ndbjX&5jtkP;-MrMr8GQBZ1-ZXA%3 z2I+=x-RSeY`+dLTxBu9O$avpZtT@-X&Nbe0GU6nssZXO&D3XT~q6#R~32OLr>dE8q z|DLBaH&Li#C|4yldrN0=yT>*r($)rs7AO?Aa!+%??X#E&iE_$)7XGoIGiNxMIwQ}0 z3vNB^6`G=Jyqx8w*BE|N-%T(|B5%M4`-U&rq2HPK(hQGE3t zGd*8vv-T#r<%S)jJ9kqKr{h3zth;1!tm_6ghI`i(>X;z~9qYBAJjrWR z6+D)U_tkuA#?9r(&s5}%sAX4E7F3&Nzu6tz2;%%vS9x3G{EwrttG9Fu% zr&@}io_0yhJ<4`B*olpd*wyja@3y9+0@BJsjge{tU++HD8_kuw{Xr$5`F^S5J&V}K zlQvh{gPYg1BuN?11m7bx(xvfPcO9nY$l!c&;@WqW9+%WonL%Ceb79lcs!r|Kp1+B& ziCMU5*sed`ajkLgY=6_~tGD^xk3DKtviuO4dU5sL=lJXGHJwclJ|(~UIZN9U7dxXJ_S4ml-IX_&KPR*`$E?Say)S+G&GraSca&qk;Dajg6c&$6L zs64+_F6-mdVfU#VO~PPJe9n4hJ$WX3`tCH=BK0)4u_I-b1iv|%x<$sv#kW)L+?W+C}igX2{=adwNQ;bdRnS1XLluTYdK z?i0%yj-P|oCT~n1h2J~-S>;rSvDC~y3o?70xO`IaVDj zHNYEbg6fNjZ5N;t*-%oUV56~Jio0%}=kv&k~RxYSfQRh2+Dy~wyQm?yEtCa_dBpx069 z@6JM$nE00OLiGvz!sK`Hbu1mJ%b1I@$7UMH&%Du6XVe#S)KM^+tIfsJv6Ij-x3qb! z1yMFk2l>}t3?N%p_R?p2YV$DGnU`?1;Y6+T)}{`{CWpBBJBLlZw>vVmIdR3VH)hW) zw6^#Ba(VsrpU`xPBcB_Xrbcx) zM5@w*t8&I7)MB5oI2<*y!r_B4MvnQ@Or}bu^!zS|2Hvck4fB0C_0g?~XyA444bNW} z)~R9=-zM&-%zH9kn8Jy$D(q2ibiU(2p)R2wir!Unj+!O7*#D#4zp*HDc*^U}CH7Mn z&Xb+Yxg*MR$dF3zgw5l&ww_r3^8D9tQ(uz5F8zMH&d}iO7gav=%lMzQ@mC{HW?vfN zI-F0Ge=YL;ol8<8I1#}z#V&JYCuP-??QOn^m?Kl^nk7~}l_glKE=BYqh{b>Z`=BL5 z`JX?dP52)lD zZ72W!bcWyN=d+5Hb}75>+&vN=9#sa$#!_?rMa%*Mn#}?Wf@N#{=HugGx}h&mkn(FQ zp-}e!^ZpaFLpa@9e_FO8vo7*5{5h_!Y;Db2KN^-3XD-@cCsC-kC;z*=vkpGzIfAeb zGsmNph%3&RUJ|x$1!DZxbBo`M~qRa9xyFSCP1`1ih%ecL*4CGUH z?nU0vf6c_qJXJd*jM=JRnd&ect@Tq-P+*`75SNL%eVK;WDtM|RMJiSpV~=NHW^O2G z5uRDeMxn?r{(VEu$7quk8BAA%9#wq!(A$E5RgQ5UIn~hI-2F;xd%k?Z0?jd74JObj_~5~V^aZQ- zMDJNbId7)>+B|{HkA_#pMLL}8+epx1lpZk-ZrMxs({AvnMSZZu)3WmR*5$^Gj6$@84 z9;(7DO(q0Lw!{b_R`kQFWNduA;nUrh2DQFab|YU;-5;3k%}bE%+FOp@uMbhxK^FKv zIQXAy*RBP|dTc!m;kb6~;hBrK&vGpknfIhSw70j9l?-{@RJ!6-yCKEU^}}GbH@X+u zD#N`E?j4zJ?Zc=inu(aTrtq6xTP`jx=flpl1x@O&wol@@eaS=>Bb<4CP*-uGHNi(frNGEKVRzqE7Do*W(S8TrsRibDO2lGvVIsM?mviVX~WY&&(9!<*kRN4-D{YdKBv>I}z9;PSA3QpqAi!kt=L802tnZ{}>D8zT?sOH4PIb@y= zNG`G*;3?bR+fI5q(Hs;K!VCuy6c)y!U*{iUjoVe>pfvNWNh7^EqgJ_~tgO6LOJiNH ztg6i%E#MUD>q`uF9XeR)hL3g{yrx-faYJeT&NZEokdTItH}sj{-b-)~A3kg^ce1{Q zMu$G|Io}WEtJ(Z&!qhoLF2Qxs!Azr37YURttK zuXHW4pZ}pA)`Q#MwZ1=q#KUjnb`NK|v&I+e=)=DGP~s_d-7mv385pp?)4)*ez^B~m8CDbkY@iQNFB_-eeLrIAQCHwfcX^bw;qjGFw;>34OX66U;xc$BN z<1&ffwS;n~ZNUeDF)?VTAxz0^e-VCaIxHStPOiZfmp8@C4VHEVHumg(`u19mcb@x|j021RU!oIM1SbVXnZq>Eq*#>d3C)HbJ@oUpk?F<4V`n>4)WxbM9B@S!82odqoqv zwyTU==(L$mhT)n0sJVmC+Sq!&i6}-mTWpJt=dMGnAQA>c3h`$9bk@ZdeGD9$#hr5t zU8=g4eGgnwYyCy$VZ`*pT0O6yK7DG~kt{7k$uV8HKwCJSmeby@5Mr#M5ix%=qfUIT z!t%`pAmc`)d%~5<5w{$HxIxpXUy`i0)nfZwFg+tA2lFN7^ zA=spCIBj{&ma^+)>*a7>>zIH3`9}hxTM`5e#PF?31SYjZn8>}AJ_HTSg=S{5n|5c0 zugvtw)&|gXE>E*@6~>`uCSTaK;(ajGg?Bv)lE7j9qr$BYDHd z@nJJpuE6E8scPB2vI>`2yG*wOS*^XoZjeBr z@N<~%Y{M9>ZaA+KoHANMIW&!~;$FNsT-0n?LO5?12`5Pup2Fj91}I=x_}b>$fOUo; zy!*n6*rkmpJI5|Pai8T`H8+@QPvWwll*2h$1xYX|#3y!kDpB!Rd>sBT9dW1JbNJE@ zHAK5Z6MRexJISK-<+3q?*9Jpa4c905_J=m#fmhrC<(>q|H%f~XbP zm%(^rhzupsouew5YL{21yAy|c6Peqd*Bdx2y;1FYS+`C@EKPSuv#>gH&Gh}Biu9sfnjXQ6?41FcsJjJ{LH zsx`rli*5-CuNuc@S>`7mOC5L%lk`+!+=`m?1BA}oUMO*RFrNr`UC#JT_{QT$KIrX5FHKYEv1o0W+0#|q66$f&4b@j_7>dMN7sZsqbd>!rW ziHV7#n6-8(&a@VE<%&Yh_L*8;)bnFB%gy33rs{NTbuQ4=U{=E1u8wYh;4(%>W?_#LJ9$(-lF>=i%x_n&58e!(*j~WVujUP8x7w@^y5(4v?{2S$K^~F!*xNL&8Rx;0a);NA zw)u5Hm~g^Mpe#OBUdxBmm7!!|9dwzXEoy}E|9k57w=j!uXD_rF|czPmW zS**<7bVg1wyW?%t*O%Jmjt#$uYaB3!R#w>-{e=xv@!>{e%{6-7NVv*)c)R5gxoU+! zLCjf@uCLfKavt*l9VT_2Q|F=$tw41Gx780dOqIio%6-FqNR$b}jsxeY=R4CB?cmn7 zv{M{ry6s@ejX%nsj&CfEk}ceqUi)%_K6O`8R@T_}_(*4Sw15MJ>f#D|{Ek1pNVZ!` zh@%~Qa7v7;q>kGhH(}@xz^t!-&nWIcDa2_PKots7rGo68hWKgXkDw5h#1BF&6nz?J%uob zMq#S0thlJ%WxwC%aXpuJG-iJao_Hp)<3})p9ZwD6a2o3XV2DdIX@}bi7f6L2ri0_S zVg+5eru9p- z#X~LRT4=VwDCTQ}y)7R{;t=uS1LOAk0%@85TH0nHqj)1A1A~RZ%AgM)683~2S09aC zEgba<9P;UZpRiXODupf+#S}lTIj%2Yai?@N90IhM*y|{M2g$wF9M3cy!M;N}G~@=^ z^}WN_tA~2CW-9TGjrI$#(*d_-YL&GIRv*42o&V(9X@a&l0qc+7?+0jW0Up z9!h**Q*C7JaNZoY+z$C9#&S? zM8y=DyLF-BbS|QpU%SE*o`5WfsklV#?Cjvy#f@5G=A6nTYHva+hk&BGzU}ty-MQpt zDJ5SV%6Ey^amLkpj>x;Cqr>of1h-7cIh0uxWTL5g56**N`Z`=Fjb$gI%mE-94H*4T zj=)+gjyb|U)K_Opqu}y2ip-LhZn=JV@A#xMJ#Qeb)#i&5Br2$bm?>Cflqk2f&|yCS zBpvGUuFG=+FEooqSNy)0;&bHEY1fs>xc=P%Yuuc@ZTu5RoJgcy+m3qL90-dzrfpp3 zPb<6-o+I;o@P6tp$5uUKz|rsf3!eMsvQ>j?vwaEi6rJhHYzALrz?3zdZfwCBdxZHI z2zI=dt(=Va>BIp9V)Qs+#PE3MnBMF4-YnMzfX!;WpDTY?6Ul^9pv)4(ZyKk2+ya0t zyt|^9;$t9D%Ch=5Oh?tZoOyPK+;aB(=C1dvX$SM3Y+4&WaBmV?ex-322y8SO;xtd1 z>w9VOal^%y16Kx$EkEdbY%)*USy!%x_Im(OK7ytU&|mM()9(^KM@cCF7B7F@u<@U+ z`MLo51=#klaO0S^T`}7-EiRj%cfz^NLoNF9A0YVz%6IU6G*Z5MLP>~Cxsag<7MPfs z*|fk@xR5OK@L?d;O(O{xmolqx2$lHN9$ij|LQr7;V`o7n;!$C>lv`TbYpgW@W{NJ1 z0RSs7U&^SbEy@*RYW=A_`Qe8v;mvG;H^4P&+-4oUcRb?M+{ByU6r<5Bs7^HmLQTuM ztxOKv+Y)<^CB__JH3tavCz;!7trk`*Id7{JFbei7$_gcw-!20i{p3OiH9qA?_n$*a zA4+mq{6=}=`vMfI9bJl-7H>P6TR+jvH}LNGcIfOeA4<+{=|bk9V?^gAz-@=T^QUQE z9L6L|gA@Fw;dcPMqL87&LCA-~%nlxee@n*5#K|cu?bw~BC|(6X<-NX?x_UTNI#MNC zc6RxN<~=gNrX>5EmW#$Z&atw{M4eP44fHqe|DDz~^@iT#BwLQ?w+*7t#0z-?%<(vh zsF)bKr8+v)rCcb)rmuwFdqwVjOobpMvBAARbJpX#`v2_q$gAFB*eoEdc$%=+#8eE% z%~6Yyy6}1}x49x=$}_uZ*W!k^R%cRb6Dr--k2hI=d2x&thvY*onQ~IGn6b=Lc2A#n z3D5QB)l7|`-oD7vEJ=5ypDZF`2-Jp*e#KDDYg6ziQQR>+qV;g1QD_;7z^Fe#FVBDZB1(*@y_X{%_puP({tVwo zMmGmIpo3$ez*trtYo8YJTM)BV=)Si(fnE3T>K}?Ar_TQL=?+I2l)F-)>}{1I(?B_J z0c31wYEr_VJ9q9_lWaLbk0OlwVKl!(r*KGcFcSOaZFV+nyXI%QGA8V8FBW+2dxQ(Q z6>DKuyV~>g#Z7_G=>+Bs>b1+5t(8Ee_%dqx7*~FG^7Hc}NGYuB>A5pXzxxaG`{!MN zhe0cI1FCSqNse>EZU; zoZ;`EUlf#-m>}u!7A^$F^f$HSLwl*M zK4H)Q!i{^`6-$lJ@I6QS*F%6y;6u(*PFXo=#`tkFP<`W}npT15IW)W~PI2qdfNv-Bj30Sc8dpiQKUXs3 zh`oJRov#g?p*rUqdGk}$$3O}Fk~O2~E7B45;LKQc&-aC69qvqLVR}5m{c!5VT zHSsjRXL6e?&}qUDVlflkLDoXF*%;GNaHn z-WB9i_O|RPLgHDFo)I9sr*Xdj5~{!+cNYlNj6Fr56Ycv@m#iLzb3Iti0eZ~|R`|g6 z-ot|xvi@D6lc{OiEz@?E*6 zUSl6*h2`;7gdsIj64g0KCqXCZobRB^#>hju$o7RJZkX_1vGTGL` z*8??pO)*)GXIO&fs9tEc?ld5(t(G8WsVFoJ>MO~dH&lH`qR}#PfiZIA2o}kE2X1N9 znV2WgX0wQQX**4*bs}N9(l1<{B;<*Q#{mxD(`LfE06H72EFX$Y$%?Q^BsqLts)yb* z_Fi9}{+kX%xYs-YrCm6n4cezhj-H!3#f%haMq;;Wa%^LceD;mF<;X&f_V{-EUdf?c zB1?KPWhJG0$ZTVPUGo8CnYP8h;&%k{RXD}RIFeL&M5Mq26sXHIS;>oZHA5KESBV%w#oMOX~>cuEdA5n zSu{NhX~b(v2|Qgny1L0S(Pmq}bPmj5SJq*Y7nl(+dYLd1)QFg}a>%sqhYug3(PwVm ze(tDKSbeY&;@bJ%Z@siMCke+tqYE(?#;xP?WTN@=U02Oge2mITMRu-_iRwEv0)not zzK3AsxC&EP`_i=2q$uh$dL=K00;%4e5VDS6rXe45T|Yk_L&$}2lAZ!%np3`CCN#BeTpF|3#j{_sfpsqA~$rN zoQNAh^*%2qy-;93rJzXRC&qFSdHEA)Q^b1-^YAQIem!2DbLj1Z6&hq2#mE75nQT9^ z1y-8GJYQY_?S^X!`af@&J$S?YKW`v~H>i2T8%h984e%D}ehn|t??4F7~iRyjzXG!OgB{8qi zJhSz(I-++jg+)_>soj$Tbz!*6snr|xO#9DHXD=f=y^A|^L41-2rDE&)I)f)AM43II`c4N9PO?fK^e3@;8mQ(|greg5C0LHcO&_vnedz~51MULHqI z`Xb(QZ{Wm^+y3r)*U{0jh7aR_Gm9N_!&IZZ*kp!#zrAm&>C`1F5U^xQF4?Jsth<*Dt2yXcfpf4 zIv||?X*uBlz5oqBo|Y051oU(G;Bj|(k=k%R6+nU(Qv)SAf?Jab`L?5CDL(!e&M#QL zchsj(aL@#-jN~g~>RS@?KqGBJq>e)KGkpEy_v}A?ew(A7Q0*Rv1Nd~K?W0L1m|GOz z(^~sJU`(L5#l}kE2Ps^5UQ0XgfiYmMb4-a30GB&dRU=0uKD)u&8JVPNC@l_Hn zedirY_3Ax)u!2~LX~&VT-U{;a!z<`ZkN#sd$hlni@i=00-m>+ArI4Y4fmih5arNjy zw*{dN!|k6hN$<&+X~b1jXi@W8%{plgd2DB;Rrq$N49uNz&RYRyo4bN!Bi_UJrd>sH zQqnO&6{v}3H$;yOIn8>nFL=S$866@4$LCrRojx5kc+AWDuYr74M;x`y`hxL_jNv`G zFT}8G$IcJ9HMb6F-tguL;BW&PMMvEhDpQtZBqiI09=Hr)*25d|CVWD40T%_G<&dhd zY_(gHnU7E1$rdUsPd{fG?{`}_noYC;%1R*Y3Wy6=R{^WxgkO`7E+R*;_FV z-RdKDyL9JQpr8AC`6?%8*lQA+>80G6?FzV9rNJ;QJ8xfl5uIHeKy(G*^={|b;5UH; zl+4m7>cm2V%N-w(_@^_#cDOU7ZZwd0(E0wlQX6#SEG=OA+@*y9+%NSXa6|@U1 z`@|SNdHDJyW>>J(?Jw-_wY(;OUHjj&WBFnCJyt|FD=ae7TyaV-g_^f*a?yEgxkV%l zQub6^!W*O|54&YzWV|22YmG+8JtTAjxEZmR=P(>APdhafONJCAb4c_15dm|RVF?y9 zvvlF6(W9^9lAZc3Z=LzpX2pc4C?^>bofvkgn?8|DQ&}3v{a+uYAfIw4#*J>@f_o=> zaoXs2^aXu!A=71~x6p;NE*(Bz{gXjzs7n11y{} zyu)y90*olD`+IY9u_2B3v#lHGc5DQ{L%N2Dh=?w*H{Y0v{T2k)zHU3+E6 zSptN&QdegC6!QxTzCrP&qZ5OKP^dO91A%ZoN>zHqfxXs>CEsJ$6-wF_Q$gq?wP$M! zAT{bxZ5K3``YPR=>UZ>Ah8~bFRI5O$0v3zU%yYUkjZwgH_GDQMIHAbiVt`pCboA9r zth7Z9^R|0^PAuBb_IbN<$!MyAK0$dyX2rMgCgU}^n64>=E7vXtjQzPaAlXE!a5>Lx zu~b%!d8sP$+(X0&pZ_sJmkF01ZKt$-8~~2XJ-T^MUTIW)`t-Tj4sKr+icF=d{mI-T<+|SIXYVg7LANR^BSVi;t%!P zRw{`O4^Faf)HpryCFo<{)un05RRN%;) zvHP3!tDD?CTKZR8BpTI~loGq=K)=EV>^6c}84nj(uSa1Sk;+ftmBW4t-Ye9Tct-&>NpGfM_D5r_;ZFOEu+>)FBKyjG;l0<p7dgSkFE6 z^|8k}I+cm>@eJ{E;-kIyM9A>KQ5 zJVlRdUSkEHjJx?H<%=rD&zDF%StwTz>^^rn^(QIh{qj2dz@hu^xUC1Zw6cd75xD}_ zPb}mjq;Q7UNAOstH`mQwHHMzOa*XHhj4nplb29Et=LEQ#-Ok41dzaUm%}G*Wl0a>@ zE{S6OMDOliFn*woffgcbz(JeA4pcdc_;Cmj>B<@Qlnoi_=>|Y|W7iYT&L{$Clm7 zG1>y^h%T;%h6XO^KoHEk04^BxtbY2 zS^4}F7=H=KF5lO0fR8Zdoc}S0yNlD#~~;g024)KEka#KM=l;; zJZdAV00H6tC3hBAN8MoPY%1;Rl-k4%3qrRlxtm7B!~GG)I!`IoM6z@D{KHucFa8~t z;pn*vz?f~_itsGy6riP!eJ|)II1Od(t$}+VV{d_D>9p%-*~!`y-UpG<OjR}Cqq3O)YsfsIr z#;5`8=g{&t#2Y@GB(EN>DL`b z>wa*?#OC#RE8*_^7`Hp<+2*7~KeTF#f6!{E?=Y0{&2@8j1-L6o=n{7A?Jov+u55nU zgHGqvv z4|!2|zUhkR0?)eYx~}`;tNAB-mq2y5?AF#iy`V^QXe!{1#&wLAyQfSl-3;<;qU7Y%Kc273m;g@*6->XCG@iamcD_^Vg?waxy;G zl~lB=VufJW?pNe2%jp5wL29^x=VI!U*%)y>}~MeIx^nqjLHhC=A4b zU6e$E6p)4zkjaMfk3U)2UM`sfQo9i%cM=pNL0}fZE!%xLMp-}EmVlv_y$&*#ARIK^ zz;q~)aF>{pf+SJ|rSe!0T3|D~=-g&+5cvDOzruqg!B@MCK~hp+q3|VJzXf^}+hc9w z^dX?qk#uw{MkqHt{sVN<8lWdR_SKu>b+P$MX?wS^jEsL=E4*nd1C3sNag3*RKry4vcg5l`hS~uV(Z#K7Vh$|5FU@YTWmN z^mIuejlYd=2{9madHpIID{H5;F!aMdq^Gmu@l*{L48}LrxY_Es*jg5=r&>njK!lmub*LDtNS_lF? zp{3%+co*6g%o8im6@a@S-d+3Id&VEiig#G(oGQ8iH~l~>8EUL>)-dIvlD;{HT<09| ze(8+?ZpCaH1)Rt33*jz+H$~P%IvmTr`T?)FQ$G1^d>`lx z8A1k_h;hrFCn|Xt_)-(!c%5%>Kn=8A^OaA~VfbQiv4wE}|4DE+A%!>n zhFsLgx2yW$ArsC<+Xc?RtE7ba~MQ-zD;=33iyM<>=6UcmN1-gsv zJXYGoS#t^t3qMgZuR~jLV68(|g!Y#8T)x=7mNOTw-#LBy^w`k;UJ0lnFR+T#IocqZ zJ^%+MLc~T2>jp_ig5dUSL3@$8s^a)N1A2x&B>cG^;L)ZrWepA1A@^lJ1YRkm$j}z) zK)1)CC)y9xEc2D?It07_rGOZi>nljn(B0Ol)zk6VG%S(<`SGyjH?EwSV-WX#Kr!c{kYxKJ%(_;Zm4FHXYA4Cvs^CYA*%K+072beFW;=r*3ao@ z3=kYqwC?NcgMYKIes2;yl0;VT4S#kaMaipIuP)>JORRN^c7)b{P}r0|2c$#=jeS`c zDCyZZH#e~h-Q!!kBNHIvN>H$FBhSECu;<5T19f6uco(8?jX(?7!=v4O>`XRMS(Rf{ zs_;T?e3XjcU6q)Cz8j(HF8;>JB0k1Yh$6P|=>_jJ&=>v&dw4p8k4uPAjUouUz0nji1rRZx6} z0MC7*DSK@$yQ* zfl9O$(3dV{*QrngDJoINWiek5&;IddkYzlSkqJe*Tv!mD(*-m|3#d}^-)beD2I6vZ z3G~#d?z^i!)6Fj%8znb~-_Vai0y`UqPnth^WG;ftU3` zE7?pOiYhK>Xq+=@0W~NhUz|T#lrR|2tg_v!X7E58Si(V*m#&VTZ=7QKbB(B|sP5JT zsX!=1;<^@2q(MnYM_pbfqxMopbKNX8K2x~vW`XP?Yv4M8{jawQfr9@=WklVm{6q@a zDVD|-z+9)mo1Mz|nsmDueuu^d=^~?cKtqof%0q4!zfAD(g_P<$nCLcEPe#RS71iP( zWN8Lz=m#PI@y9t@{?C;LjwMx6@wR5v&-UiPxw$|i(;<+gQqjyT9q}$ZctY%I5iYCd zA>@PP8P@Y~le3Ntpc7S~jNM6sf)Nku!7-q|h}rCoaxo>0kNllBfdqK{Dc~s0rWIV? z;D86*%MtW;falJAjvgowV_Se;8wcs43jT-VfaRfu;&o?11Wm@yMGh}I8?=79E9?Tr z?IuRV>)h<^HMnj2$=18$c{an<&+sbHhl$-=VJWh3baeb22H`auFl}mi#xj%}C)Hj< zZKS~A1ljl~AzK6xFgEOmOgIwl$~K%+)f(n)?^QRB9)G&4>qc^!le1-|C!k~K)gW|k+Wu6 z+tk$beiZ|)=~$;@;h;iB$J)FU(=DV%X9Nh%eIPy%&CbyaxhgpY-fE>FF$&0-PNCCA z580$@fPzR74{3pI(s9@2K--82Wwu0p-qs`1&7vLM{Vmm1r-Qqw4De(Adl#;qMBFj2 zBq2vgw+d!pK zw!s|0N1Gs;GXT;ToBFO~&^5z~Z*IXM;i>#${S2?%_es%oD8T^aEkS>^5nuuuP%P0# z0-A$ETE}_#)q59>q6M*byWxpa)D_*vw>&tH2ziE5e{vW08FDI&kx{$RS`!MA)U`-2B3gr^n zy_m$4tC&ICI@;-F(16@FD1)@Y_7^x$`O72sVJ1mWLj<4>3IdwdR7#T_t_WY5Tc8O? zdY%xq-q5d8KL3=TuTa_ZS)fxRaVSz*|9xA&mqu-KUQ^@KiaVQEB18wB3jX54RTE#@ z)qmIlMkO%Nlo71>Ja$U0Dq5PG*G@&6Df5xi@+X?V6!TbD0SAo8CI)TMYPr@ee*yow zpQ-et3|Sc(Ri*AfYYaL zOCY0KCLCvb;ED~vnwRjLxTD_}vPuROT#Bp+8tZ+`VOsIR1E4Z%bsq`uS%{B-G716< zz~pNILTew10qRhm$>*1jxOL5hE^yZE_G7z3ygPJkE|)y!kxg*fESE63GPK+*Ad4xs zpK5>a;{6s8ug-4m0jS;ezyb6HWuiVSC!3es>?-hSm~0G-;&o8W$+f2$Q~D(_msV0=^|&;_=r3Mun*u}z&`l7-ntS2$PWjJetH>% zY08ve^nl zz12!EV`w7Ui|MD_d9&w71qyWF;kdl9!{}vOP?vtl~zNA&|m<1Zzlwc6^=LqXUx=0!?G$ZEH z2$jS4@*zNtve|C&D&+D^38ZE4`_13;2Zk`C1*nAd@-!3Bq!))206Jq0cz)zWgbvPn zsLE^?&H}_5xk*uRf3gOpj5g>Q!bLo*Kz<;eHISjoiIZhe1z(BQSOdg%y7UL66DAvH%}J|P6{AvU@Ql^^@Gpwrn>Zq zv^q9F1*ScLum&aLD_^Y@ATcs3U^wfdu>0-FCGJ-}MLrwTqA+%K3DjCD+xA_`s>if= z{(`qhfQ0HXHzJJ_U8uBmH0e`hqPc=&*D6ho{EI-ln(koMmCj7VWAPqYOLZ935})NT z{T!WnDVTTHqk=<1#+}NI0@%m`H?S+IX$yLU*EWLB(mx$!C`eEWsU%|ODP^NwK zPrp*P{KnH+L@Nr!#TfJmf}z8ezDmtwF}d#jKwwR3J0b|$7V01soR9bl+1dbxQlP|1 z3x)c8sR2d@3PJHUGV&zWCKDN;K-BJy4xpg-%1nu<&S=)pp`f~D@_uDuNOx;}A*cMR zVKC1lV+f0&$g~)mJNZGsI6JGUqtViwrq7>NfOxzFGJS`k8j#;sv~$~+fC+UW81KzH zpL`Qt7qce60E;mN*pdde$buUnP9Xugvx3w52Iy*2gx!8VKhZhlvD ze0E>$>0rXNwQ^}JInpY>B1-I!7o}unz+?#Snvf77B}*mcKgumT0i+~F1a>{gA%L&} z-pE2)AWqFfAVk#`%?C=L0Tek$WExEv-;a%rAxgoqMz)+n%)eOFM5~Ms#lHP3P>YLY z34_{X|4`@~+BiUh9T>?*mu z^l*`9UXM2-&I)N5+8(`!P*oZt92^`!?Y^uL{IByF&Ga`4X8mwnrS*kOgUqm9#hqhQ z`N&$6gWF?;($s8oXUCoI=`Y`{AES$tI@kyhT<=4(nmB~{0#f`;kT(Y;+^M##fp%zu zMvg0a4}2^Jk>MNn4s`uO=2#RBJMtm-FrSA~=A0=~%IwMgy|$h#%@ko8VfWIlZJ3hl z91_`@WW@ik+%vkv73Dtq5Xn8mNbWg%de!7nVcm)ugn(9#3AWh1 z?u$o`6U%J^OQH&TUsH8HzmY#2P&rA&L*5@YFVkoiLBO3=zE~@Oj1a@kF#)vquogXO zPmrVe(lq2`-Q!56R#9@d-w!i)B?v1mCG`RBkz;xlnbd@CnOOajHl(U0=$f8j*MwH2 zmgny3*Tae;87G{WGYv_lkrpd`&>?Er$qsbdD1e~m2qc?v&AuZA0%Ju1IU$BT;s z*hN-a@4sGho6V~u4*LR>4`?^K@_~d{f|mF;JK{RpZ(89P`9K&Nw{-N$L|#ht1p*)q z(ecjHB_y2c`J!2>yJ&&A=-#+N47do=kK1zZFEqW3Uj`aU3h8UeCy2F!#Plyd&I|BU zhW-K6Dx|BaNVLO4w5x}doh6eA-DULu&~4DQ+m%6!Y9JNme*iM=MA+~cjV!s#(048k zgfO5gysIBCl&rc8r%z)K3WAH*EzAdSlz20H?2X0Q($D?tY^45_rM`v;-HX4si3kC31ekX@1hY_`YUKT!r`n*lIbW@Rv& z*@z5uf@#92tTtls?obtYEDO3UB|eG~REPaD0#^wefX)WG_<(l!)5Y}dwsb&-gOH|? z9f%T+MSm@D!+C5?vA95}84Hp^2ST2H2d?(xht`1%4Jj(=^?n;e4T4NC1B)MgoP=5e z26hU8Bs@+^#}0GS`5>~bap_{x8M2&pVCZkX018xY+9gSvbsn{*0ljT2@sAe;&`0|m z@~-wS_2(ubBgg>Qj(yL7d7+3~rcX+V`<*hOp%u<$DB1ii9|pev!6M%a@YygHR1SoE zNFiK>p3i$-W`&mO8K(;%EWc^O!^OS7d>@%efbNX}u<#yXL?tAk7e?;A6N}8OB16Kv zo)F{j_K+57&$(R(0+-5;d?UtfULGF+n%7-IwyRI5+N{35GK9npZU~78B8gkt!RzkD z3wy!@%s5gE_vMKHzbv60X-AzT7@h0C^!_8LiwY3E;?fp|(k;3kkVK-#?pC@Mz|bJ5 z2x&Cd5o!M1&xu%1Ive#lyEaG}b+0a!qt74Htb)_X&(H6ifaRa2-jj7(L@QCjOnDj+ zrWb(wC(08*S0sAw@0o1^iT?IpVxP+_uzKQ9K79qs1X=+GeffrWm)*9eQj~ST0?yD2 z&%&Taf3D+`6{NEb-8gT+BtWvp%5fQ$xXt$7AW)=uZVwC{KH#IYH!@XqTpnPI{*z)@ zqmUGHFOF_?HZ?%bC0iG#gAs-~M1so~XkA%eOZiu|;=e4lF#aNX;v3@@$!JB(;&-M4 zvyc!wJUy0VWQl3=NZj=;N~+ zdu#EdR9?q@@xfG2POKHJC+9|YJDSGtI-jG~$FGhpxE!!3>=4bJ@;LeU`mAH1BZ!rggvfH2vsM)uT$q=cf>KUktmEDnFe*RjCO8el zSc4jbHOkoCHW?IFYgiYd|O=uR5?o zc}1t$!s|_hzemmOg+*35=)Hk-QZpGCps&!8d0{;~K+?6>GxCJJKVO-6Nsl35KDw8UGK{K5~FPmm2E) z5pSE<*Y_(1nihn78Lh{`wn!OWw%i(xA?y{0b^t$=zI>y+mMf!WG5y#~%Lwg(vDh`BQODgdRc*FDo9F)V?m01r%t{f9$?6`Y@)VDxxwJGcUm^s%OjcOl(f z&>2FG0kofGds{R2e@!@+8$y{Es;jr+2#9NX>Gt}MrzEc=Zej`0jzGFr%wT4ddq9XD zCE+l10IZg|o|pI4L~}XpB<}T{KMZD|Ag@L5&!>V=msYRYY1}wYb^mDh0cdqL zCtIgVhoUmY1hTP zt%qME!o&uQFJDC>d|}}&1lkhQ397w&_s(E{Z};_*cOi+J?hZ0tY}q#tv^kp-!66J` zB)M+hWCqC#rMwp0Yi8Y`?QJ~oBRU@0Oc60bErQ+j8L|ciL1I5@I{BpfY z0*(Lbrj<7@`mPu+vTE!e2Vv#@h4SZL4IBnUAew;ke^WHi2AXA{5me77xfFw(Vn(g> zt@vM>(757nhRil*Z~H723ndpHl zUZExnM80zXb_(hi38-9*O`=cGyUWoU1BYKy=5=TGts}kE2KSu+M5f-?Weqaj>#y@@ zBpwA8??R^rnFv9O028k$;9Xirf{rXchbanB$uclND_yzn5s;Pl2T!TU%U^~Fr#b_? z{%uL-V^QK8+@FzoqU%0jF9pa_|FIenfi^87TZ2(Qdixi7Tc%>DJ!B#aM6SqJAxOZm zai{GveBsK8C<{Q2OP`OBrW(@RGPwjgbbmYVLlYoUw>b}EicO$i{Rt|iOEyB7b1*+W-6j6wGVurT96*VyhDAK4jJ<>EFQXKPou|yZ1|YjcA(7lrCW@8#DA9K zh0FjkgW59D7brydevc>c9Ux)A^5CU;2}}qd1+A0%DTc%T-h~H`q&j$H;lU$Gkw?0e z>_Pw+6GRS=Q+NLN;GsO28U8DU_8O=o_aMnVj-2}G1N+FO)aQNwvCwiq?hRc~W@hGF zmJ9HWG0vw@zQ3mh4#ew5+iD;~?jAu7;`tT{D7f2@gSe8yqVj)q^uBAzkxEpyZM0VD^+va& zo$N4T+O$M%K7|Za^b3djgfImaAO|wf3!-$|~>?7#oPflxnj z{|f3lgB6R6_j_rBh!5BIkurPM^Ur!bNVjvfueRi zFuf3WaL8*g<83N(^`ayAsE8(IuS>865v>1V^X!PvMS>oyQq#@N| z6n3Q*tsrxo5+Fzsgm6LeYjug!7Sefw-yZw!zB59UzrZC)IF}>}E-39Dt5^GU<;vwZ zIT<2g{CnLH(L^>U^(Q`p3Mr!5bnW_4S?E>}fg@bsTe&bRH}D+6)Z{drl|!#`MExL% zUy4#JeyK#AU)nylK{%qgtq1d5C4C;wUZ7-|jCFq7<0nt#4#mO0nQ|K7OHpchOFVX{ z)5Y}=hq>d%ZNnwQy9V^u&#fws!_|xTb^$7`pb2UgfDOu*mmAN>wt&ASS5LH9)PNTm zCmYeS@u7kc+91fcxga-cDBrYvAjS8LfY3lH#Lmk4JoKQbAL~8zV}j*0I*|V+No9tjds|0Fxwj~G#KNt+*X|l$6wG_ZEf@^CJONW(O zUd86JvNFwK&``IRN*Oa33i-eTRA4JZbFc#ZMI)2+VKAQw#2M5#@-r0qlAg9MaXOz}1G*)AlgJlhCv&hGU>uLx9}fsb~9&cv4Gf zLVUWSao3Ko*&1AD21uGiD;L(sw#6ew_SPGtvdP-B~yE44w!W zrL;8anNcv`%!#gRfEvlYZf7s7!_$Qg;L-UGk^~yCvJ*T&u4zr6aT(PyR)Ivcc#|h1 zore|7cj(!O#GFm6#?)SbDWgJtp4SqBk;q3`N9`#=jjQgGC|)fAu6{1rK(G(FRI)a> z8;uyfyW(>FKA_@-c)3GxOmdIA>(^2qxNKkuc0 zht4G%&d>(~Jsky?T%raahR~@yHTpkX)tU(EuB*DtKOn-Ze;ydSWJTZ%MR$tEZ&k`v zXs+4BT6EZkIt*0W#RHk>JLn0F2LQwEr$KtgRiH-YqKcF+DG6&_P6SbL5u>H1tF_cL ziFN(wkBp~fpZ*xZWfg2ZK6-55Y-9f7WN~Bmg`baue?cx`VwkUp3QuZj-N!%meQ5Hai%u^u- zBI8jzC55aOx3J)S7W+p7pjkH?4jo4Uc_!DzW(5ZHrMHO3(52X`8YQgIHVAVzua zEDM04fGx;o1QUOGF)aNxLWhj54eCR1*rnmYsUGO`~CS0K*_KS6mV zDKBL_v5<8f%?K{}V(@zuR2j=gljgpq9vfRMx;ICywt~?CjAs~or0XAtigEbOQ1mjCBJUaA1E~+Y6cL22A=-;Hi-sD1{F0%50odlO|5T?Z`LV zHg&H@uGXtPRc+VfqBB0qh(^4far()Oab?WDAzC{~_dY{gQCr47G%!1jj?cKJnoyks z#qo{HyL#ztFaS&#>jn&+9`{B~gY%mA4yasV?}RU#3Ibhb&zhBnTZ_8(ssksxt+2?y zIOZxZyP+v+-S*QuSHi!V;LV^;Isl=()6VXcyj}_z2AWX$^98q{rv>@IakD+MZ2PG( zwsy5qob_V<9!T4xW_}94gBZ+Lq zponqkaE7iizgjhc9$;g}d)aUN3UhHh&%qN`dzO^~fpxn3nlt1L1w1(p{4+^kJ!7HV zWh$FgDJ$Y}zq2PRJ1k%FzQ@+bn1TSF;@WnhUUOgQh@0gbH*X#x3=qf*h=13?zaVAZ z#{L>62$RCrr`}7~Z@*308Q*@)dGG%BUraI)ZLrP$ap=sd#cr?rux}oovNWOp#=k7F zsv2$z)BT)M_YCW$v*OIrnRhzq95^F%o}DUPn}rZ{aUbFT){sfa*{kK&%Bl0HT@SZ4 KuIHBvzxx}7m_EG# literal 0 HcmV?d00001 diff --git a/doc/source/index.rst b/doc/source/index.rst index cb1db0b5..73156abb 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,8 +2,65 @@ stx-fault Documentation ======================= -This is the documentation for StarlingX fault management. +Following is the documentation for StarlingX fault management. +-------- +Overview +-------- + +Fault management is a component of StarlingX project that detects, classifies, +and notifies different behaviors occurring in the infrastructure. + +Undesirable behaviors in the system are detected as alarms that usually need +corrective actions intermediately. The severity is determined according to a +classification (e.g. critical, warning, and others) that provide the operator +with more information about the system's condition. The classification also +provides which system component is affected (e.g. network, storage, security, +and so forth). + +Additionally, fault management (FM) handles expected behaviors organized in +events. These behaviors are classified and show relevant information for the +administrator that might require an action. Fault Management is a useful +service to monitor the infrastructure's health and allows you to action +according to priorities. + +Fault management is comprised of a group of sub-projects that work together to +offer the FM service. Following is a brief description of FM's role: + ++-----------------+-----------------------------------------------------------+ +| Sub-project | Description | ++=================+===========================================================+ +| fm-api | Application API used by software applications to raise, | +| | clear and audit the alarms and events. | ++-----------------+-----------------------------------------------------------+ +| fm-common | Includes libraries used by the fm-mgr. Additionally, | +| | fm-mgr includes a client that interacts with fm-mgr | +| | throughout a socket. | ++-----------------+-----------------------------------------------------------+ +| fm-mgr | Creates, reads, and deletes faults. fm-mgr can access the | +| | database. | ++-----------------+-----------------------------------------------------------+ +| fm-rest-api | Through use of a RESTful API, allows information on events| +| | and alarms from the database to be reported. For more | +| | information, see the API reference. | ++-----------------+-----------------------------------------------------------+ +| python-fmclient | Allows use of the Fault Management RESTful API. | ++-----------------+-----------------------------------------------------------+ + +StarlingX services can use Fault Management through a client that at the same +time uses the API to handle the information in the database. The following +diagram describes the process: + +.. figure:: figures/fm-usage-flow.png + :scale: 50% + :alt: Fault Management usage flow + + *Fault Management usage flow* + +Finally, the StarlingX dashboard includes a view/panel that allows you to more +easily view and interpret FM operations. + +------------- Release Notes ------------- @@ -12,6 +69,7 @@ Release Notes Release Notes +------------- API Reference ------------- @@ -20,6 +78,7 @@ API Reference API Reference +----- Links -----