From 6de08e5dec6478eb22059bdf94c7a1faf4cea177 Mon Sep 17 00:00:00 2001 From: Isala Piyarisi Date: Sun, 15 May 2022 22:24:41 +0530 Subject: [PATCH] docs: Added content to README.md --- README.md | 34 ++++++++++++++++-- documentation/README/demo.gif | Bin 0 -> 6119569 bytes .../README/high-level-system-diagram.png | Bin 0 -> 154614 bytes 3 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 documentation/README/demo.gif create mode 100644 documentation/README/high-level-system-diagram.png diff --git a/README.md b/README.md index 64eb622..7456fac 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ -# lazy-koala -Fault localizer for distributed systems +# Lazy-Koala + +Lazy Koala is a lightweight framework for root cause analysis in distributed systems. This provides all the tooling needed for RCA from instrumentation to storage and real-time processing of telemetry data using deep learning. + +# Usage + +```sh +git clone https://github.com/MrSupiri/lazy-koala +cd charts +helm install lazy-koala --generate-name -n lazy-koala --create-namespace +``` + +## Architecture + +![High Level System Diagram](documentation/README/high-level-system-diagram.png) + +## Repo Structure + +```txt +./charts/lazy-koala - Helm Chart +./control-plane - Kubernetes Operator which binds all the sub-components +./documentation - Thesis written by the author about project +./gazer - eBPF based telemetry extraction agent +./inspector - Simple HTTP proxy to contact kubeAPI from the UI +./scripts - Helper Scripts +./sherlock - Inference agent to calculate anomaly scores +./ui - User dashboard to visualize the system +``` + +# Demo + +![DEMO](documentation/README/demo.gif) diff --git a/documentation/README/demo.gif b/documentation/README/demo.gif new file mode 100644 index 0000000000000000000000000000000000000000..78f5a51a8d0a9fd3fe39f20cf6a9f29fae637bb8 GIT binary patch literal 6119569 zcmeENWltPzuw7trr%>D}EEFhK+!uE!4y9Oehhn7^U)*K!#oeJe#fr;f#pxo&-HPvh z@9(&GG9Mi8JdxGBf?|9E@A)M`{4h=-3}PV>5n&U61QkF+T2>;wQ__G?61FeRMJv+} zkj)pB3jio6t1Hw36eHn^V_+p!Ri#u^r3x7}R5~^NkLsFQS^4RET0IeEj?S8-q za*Pji0NqVg{d#RfLqns#03)QlNeINO*~knD{A6kK=>lNR4zMg)utEZC>Wyt}9qckc z+aUptb4b64H$la)lA5kr$R98Xg`VF%%pr35>L~iJSvO|4NRH zi%&!Xl19T))6&vzlHL85|KbhK^>e}U^+6S7tVWYaymHN4* zhFhP;KhaIU_nVM{%`Gi0zeC%9?{xm@=<4d}LOOP@9(C{K^)6)g=>Yor`UVFFhyR?6 zL^+HgV@3nMkAW%18WzR@I^*MGla|g?i8<3r!qZnJ@XnPPXzGA#^_G}Mv zaei@0Y;c*Bbc2O;b8~YWse7AW_;2&ioqF(HW8>ZZ{XO#W!3X7`zyD!o_Tg;hF)Q<_ z#rNsy={fY(^H103fuQHvnil}zh1~1K0r27mcnJi&q_DpfD87_xztmg4OlH3P>3Dg5 zLIP}&NF)FWU_|0-$m@Op%V^2-ar2;|0002SdmuW_e<{xYV!;2x1oHnN`G1i7Uj_*l z67Y;oqf`&;3&ncHVLDP@FaRN9R>@InDEt*e!SAp((oi&QEn_AO#ywVG#za$ z8PDLc8p}~`DxJ(0_B>o0Z7Q42mk!0DRcS7tDN;(|_&C;FF;}Klq>`)BQn^rN*yON2 z)>5@tXFd>3tNNpQxyf#>^5giAn$=df?Xg_d*4p(>->bv*@z%OOKZDS4>D1clHwPkL zy*1-Zp=}yYWLC{nYj6BJ4&^tonP_j?n}*qo{#NT~KA6i|4mX?ZXgOLW&>qiIH{m~C zZSy>mH0^9XTj>nNrPo+HIolp_CjT_m)$Un2TBMrr)YWlwwB)DpCr`Zd-x*>c0lA~G z(Rz2aKUZa7*z@dkea5_hWAeI7E`>C!(h;=v2&B6(y?x)iG zt`=vTS*jtHqZi+={D&qjOCnW-g9L%eF<|)e;J7Ko-utgrz3<2b#XB`6oHVblb5xvu z;e(pw9j~R6R!zREanj}F@mSVvj4?G1ka;KL4>H!x{m(`&_e?U6%@%|BUUv3q(N+v0 zg~Wc%kv8;J*9E_b^2#w1UQ6Q@3=>Txq7l5JJZfZBJ%-KF_o^xJO>i@kDo+W_S*JKk zUeZDl-_g?4q-ptU55@pi(qLR_pzqeS7}(HbV%qQAlYdr)|08>|u7P?+evm>1i-4c0 zFb2+F-J>X;V!Vfw@DHRbs^}K`h2x9;4B(ycWSG_u);yjMClTwrNSVKjE_2$!e-b2h zHHzQEE%qe!!ej`<^(G((nc0GmQ@9&)hfH;>sjto(9|BXh?WywNK>5X1=n0Jb{ogSyF=xFR2w5q%ba^)+*;xIA-*g!=OYK zOPH@y6=8Z@QBsjX(oH!LWvFx^C{GNKC`+wsrgb%l8lnJzjF#(WqMG6S{g%Xft1N~k z;H`5%Je&poOY-tSR{OYWwXpGb4UWAM`JW<^*O|OElS(_%8|Mb>4(3481qSS{{$Omv zC8m`dM#HBdOe!z!XqIXvdOIQvk!!_z=+dD&syjL`qBlyfz5o?fc^IGfPW-;D$c{Md zqsWr`2!)1=<@LE;tGCtiBXzw2>8L z-9@MZ9ExL@o%MP>G_z@%a?+XAz=8JPJ7A@U>DrKbzw!XB#m+b zEKEq}(v-xdO$00Ik4GC{vnvNokoJA4`N7Mq?DBT?oxnT@RFOdH^k`DxCBwq;YdT;j zNM7}u2*|Y5(k-TgwU|Z*XT@2Wf=ob8WP~w>{QgYdnCcZO{cBEd0WI=#a|)6E8I1UF zaQ=baK(Ur0KpEao-UC;t?b?hciae(kP(tNzF2KjzumaF6In+3LwY?>cqnFA?d1tO5ddLv8`ldWDnAXYS-PqC)pSYQdCtB+$(3K48R0Zckj&NIGTh_=E*> ztayZB?@~Dv)Xq(>5@$ftk|+cPfk?Uus|8T>DkBPr7|%!}eZC|qe7Z=`IZ{FaiXy^y zB%19HKDvG_+FN>95dxLCn|y|nW)ez7{G1?)fIVf?ABxNQz8!nThC3qqgkS83o|7eI zF29Ldi{?ohj?FfTBIccFm2&7+FD*D~v8i2|_sdbKgs2OF9cuXg?G_8$C-JSvmAfHP z_WF1eu@tXsOU352Bb_@Le)KrGeqoKqWc$W#R?SjYoG`9Fw;!o)z0Bx9)5i4H05Z0( z_q@XPbjeA{mAxMK6Lv%U8M!$WgdaqZlWy_++P^1kL{{&o=88O1E++OQuau|7Zku43 z&iONd6^Ss7=E7;KeXytPOk#XjX!1bg>%$z3pru?<{ZJ?SVZL0W zrP5&XP`~qGp+3H)+E)F@c=h3T+f+-f&*YKWgRnW&5qfOsq0d)=L4;Tj`=c;n@W@CL&NEg->p+OwO^l)%n3V}hBa;* zv!9RcG&@%or*40AKA*THbgu1b{OeeKKJ}gM-1s;3ujldkEQqiRfvI`dPyKQpsoAwf zK7BVN7ASlX*|o!_c|T_IatWR8+7+6TY9}z+$$ba&DFX!1mpBQ9*-nZ5TCNzJ4p8qbTxI_4TckUDOzq;=i zR|&)~N63p8TVj;E@3BHbq!vLys4o_X7#A88u^2>z5=@O68Z4tua>jUy7dJ7HlS`0x)3FW5n;S(l$FC6OP6Z!%R6>jqu9SN0y zdP`A+-R=d;wS8Cc4f`n+rh*lqwiE_{hG`iF=?I5M{|nP^^EHHq;~0jU-UXT6g@?6< zTN?UW8%B^)MA$)t9oixSeIi`$eB3A?--IAuZ9d+<5WftFe|d=W5+qPKAZR2aL^#s* z4iX{k69A1Ah>VOyV)?|}MT+c4CNFs>8AeGeMM2BGGuoo;7Nhd)ykQj4)ldAi5)5T z8f%MHT8y2t^MX^v$qB{HgS>wG#z|+yt?YZQEyaodi$j!qZVAT=8^rJ0dG15w1zO{e zL7t~~@jT=Sm-`;qh6$WL33ufl4{Zsc#e^3-4*+E%i%=qv-2=lfks%`y=fE9rIg#dH zB2k4qiAWNKLDFk`cZ$p;($*vzc6Yk_BqH);rUN$?qhvgvWKe}0M|(2XV)C*KKA%X6 zfKiH|Uy3j?GexvLMSM9$@;*hHGF4V2wGu03Nd`k+3#gKqs#=k%cAu(2nWiq1rlp*w zW0Yp-mu76AW}2Dyu|3U>6zTmt{kst~!Vemm35{-tdQn0-P{O2Tp|K*FsYaRUewp3}&{2qO za#UvCeI|@D%cmj}gpw&Wn^~BdRoR{utDH6MV_QC&)hLqPoS9i>m%2!t-O`@jHJVi$ z^(|*PyI&-y;y(M0MHYTx_F#L?L=<%B;9K8v&a6mo_;TYQK{KL45j#)kHV0t#qN-E?We@-oa{!-K zi3*|wg9wFNI)j)9sNx3XWGL}e$xweNb{R#*>MgZ3F8jt_$g)xtnN=R$QBH__C@Oqi zJjq*}a)8EX4wY~Nh}EM>5S4niqhTV7T|`PH5NO1JN&+5KiNwlG<6=H7piFORsslhz zv@|OkP*VvkIYcv9sZ=ztl0=|l!qGeqP;DxK1Vkv3h>9Glj69r56{3 zHzkS$yvfzCTG0(ifGD>1uXUvaLJ!kD{7YS;im~6eJUygyFrdiuGi?wr$sl&xYy89w|cBL&_CKUn$T<>0ytq+oF+i|EHoKFwH{S@ zro)eC(bCgHK*d8N=36vL7%B$5#l^3h`v@R|D04Rg+QgI^`2)z^+S~lAt~lz*R*T&^ zs@1+Ws1UVV<5uow6&F6Ha{?+sM`h0(8Cge7Iwnn+JY^a@wF^|F%%ZJ>CS9?{t$E(9 zgNzj#3^ghumG=+n-;TQE-8y9-TUx7t{Ej~~7@Flxnt749rDjwpe{g%W4x3c!(YB82 z(Y}_wtNP)zg62mBd{xy^ja%}%GxcxZq$-GCN)Ue)8wk**?^Xm{$KgY{NAFIqp!4jobA-y2nMie?_$epxVpP)h+{X zzZk2i=**}{{8jIU$HRx;4Z!V&<8C0BR{;1^Fnmc8f=zRAR^BeMry;k10`iG`M?b4g z|1x#sQu*^n8Tc^PF_0Y4Bq7$T;?^P`GzcC?4MeUDA7@oy<7T{jY|A_>6|M%}WDi(y zl(|&4YOS`WIF<@N)ngw4u)db&bfvc7W&|I%;2pOpM0aMJH0e=|g;i%51&o^qjJF2h z!2!4(IXJUgc>Sh$)rmL*ZX7#qcoqS8cAP}VF#I{5Au`53chkw=6EM%Nf-g>1n}=;G z=bZ|NU4JG}iN^JGles^<-HPq@}s#33M#?cl8PLC%zsU zT!_kCJngVxuDviV4Rcj#zCTb?v~+K*;?b$r#bKU>dPJ|XhxT}0JG<-y&M!BSMMa_# z4A_W4O=<>ShFD^wbj;7X+|>8g#d*D|ph9OUPgSo_SG$5EpirXO*>OC8 zYo^R?iToSR%;e&X^!i{9PG~Mp1M++cfxk@UKern2$wwUS7S*ovF+&rl#jhe&1GbTQ zw4th;X*-r0=!b&+_K#=OpMCW|_f?CFHRI#3_5L+HH13%ia|C70_#fI0BFVm_IQx`t z>OJ+MN#&Z@icNSf!pLa`gKmkgc6`zt5&3PLFt0|*4GZLt%i@MhFowqC0&5Kdvea*3 z`lAbJpo(v7b7~Me^=>=4!CGP4N<=uA{#b(XKz@Q9acNWoa{^o{9Iyrm}){XP&K zmtz|mxSwS97gLllx^`bF2#CS4ANI0!t+lNqS@0^*o~)MIE^oKPCDW4*|A#r^m-wES z3!)vq&aN@161d+K4|`9ruXDO}&G1*a_HPsS-(A@8mD~Od9S%(61S1*<4nzlYpKx-Y z-bfP~*TNt~f3JhK8#GYI=}s=q_ICj%J1#JT^KGk_LL0MB?L9|;pHR;p1jYtVe;y9H z3t|R=AYC~SI^Da1ZHKtP3ZxITrqG)5PEYA}v;tu?-_bK_VaummUtM63UW~=lJ?^P3 zZaN%;sqKfCeNv<*D$W=N%mpS$f5fOsD6Vy?oC;{5a@L*b zb6-Ca6hEIDBI(ZcU7-x?#nCa7%uA|$pWtLxCY!O7G~Sv+P_Xg z`-<;QPo}n<5C^FQJBi#^I9X@ch-+NY%chsh5bnPRfrlD(I|QHpinv}@_Z(lJ{uS@J z!r-`Lkva-WfNi*3O2l8P{#lAs*(H^{iPO6=`2G-3G0`<4`r?Mi>O8x0K4F^wYr$>l zH|-D!*X^t48%P`i?_EK7;AsKRp`6B*W5Ssp!I7}pwZr$5;P{;@o^2KGzw-3Y*jbk% zlKa{5rvgY` zGlX2bb$Y}xPCi%ak43K!wsXE2OKsSH22$yQBv@Dy>oaXniLgu6UBj7B1V{-zwGJ}3 z-S=Ndnd}C+IFDTuWtVEXetbh5O{ZJx6!c%$u82rrPW#5_{-pb}O?pL*?Ts0y($}*2MeB zw+U&r_#@ZkpUXz~H>8<*>89J(uQ+%Euq49)|5X()hWTqyxWAgy$SGWx$#Y{2-kEoB>JpD>UM0~YGRp)HwTB)23um2qqmE->PSL44I zN5dDU_1S4qr2p=PFT}t`;-SQxAjdbl9A;Ik%$6UY?T?lo1zf)^2WZm36-LTcE~0BEF2-`6Z<%GP{6#}m`8p4A@ahB!Qzwud z$VA~+wIpngvHg?66Gsy*mZU0j6IkdR+b>xn>j64bYb)0VBMSH z5KIN(O&yDx77GY{gduh~yFbKWI97D(zXPG(+-QtHgAWH<-j_Bdzh-k+%a2vLU_g3~0VLq*+? z|7c|EZinNp8S`+aS=)Gn;>Sz{{&I(4hGffdWh?r2oH>5|GX4|ia((H*vSO!PG-kxyn6NX-f)P|cDGL(Kz8wn7W zC84txn9ZD$hq+5*oLYZ-9cF>|8LQ(y7#J^YFmt)P#x!O~th3W1UL2ik3{ zVMn|qrSDK_@|tCc#0IgLce7g@5qlI4Aw^z;{a|t_%3uDQ_US2k{%mA*))7DyKG;2* zy*@uAp}380qqLJ$t2`{RR-jdptC@26N*Ll)L7aNA$`Tm=5*2_?%TqzF-)_9bXX=9we=9Xp%@%4) z3pgAv{SA70SZR#o-iTTc;Hj(a6x91cBxZ?qh$_>H5Cyi#ccl%)rBe%ylhux&-XA4& zYq&P$KNCyAc?o(0Q>q#^A&jiD(I1Cwk{^}qah_%3EgKW5%Q~H0Y@tT*m6oQ8duP|L zkBhUF;QICkpu)J{hujA=x|^V3Rc)w}x2}HcVj81s_}c|UUTNp*NtIAE?nvXxP-#SX zvD59QYUdDH=UEBNyYFcBEWNbns++?;<}1NamI8SP1Dm6B3c;7##nh*I?f^18sr#)A z*gsnQFxq3Cz*rxeu@-y*Ds27Tp&{yjBM`lti+JLcr9oEi2Fc$A@m~g+UUQiZi|Pby z5l{OL9^GLG7A6r=6}1fu24Y4p2IDi4FOSI8x+kU}1Gc@pw&~cWE|N;rtm)8}hYd6? zMQ`grb9+(}%Xp(Fxn9I^XZR78?DMAEt4(45)9Wwr^UOw3iHD}&(op=E@ zzk`>nl&#Xrl4sHW4Js4t-J5|X4#MX|6a`YX_ zh0o4p+^ET&HMyxoB1;tQwjV=bQrI8{P4M3`ZFEbO@j{k1=gjNI!z51SJCt}EfzZ-o zN^`rxnwiK%Z%W}lAq}|2sCOcmKBgp6;8NlonXR;)w@nZyw8Mjj9~6X@K%p+u3kZo2 zq5+Z*3+E}vl}Kwo*1`j^MkIO^L(_lE{Vlm zZaGTK@1w&N-*ANxPSg|} zXh~ztx4-Dryfd46;5u>tzO5Hie|y+uboNeBl0eyWV8-c%&U#>OKar&SY>cAC;j)0x zwarQ(;OtSIrH}s22;VMR@!j0cpxMstcBRNHN;`_6KQJw8 zT3kPMPxKdPe9wXVs{C}etz&;yxW-|lfdH71!Bl_tRlr}D;N8;8)-r=4=V9Wb{z%_5 z!`+t)J(Ymxf4`~UWU#xnHPwG$Sy*Yh-irHAaKXmKbWy^v7slL+ENd|?u$s*+xP;^~ zx7oPi`<_?8#zD@J63Zr1e_nN|8wv*2M;J<@$9PIr9sLa6`bjZg{Sy^JJzx2aS$d%! zn6vt0JUcED&_D|Wc_m_4!30*_IM40hUe5Fen?$^{G?HQ}-Pn5lh2SV#h-e zO;~{-$V#Ua5dcU9ET@zMcg{v2-RpCz4@=Kii6bm~2)5%I_zR4B*&wQ z!faq-1Ws`ut}wg5GF%^Z{yZXfmd3zi8hGpsolWdehoUo>f}gbq)MGhZ&0+2oEQYhP z^!Ifx+x&m*M3@BLTo^~#QDEwe7ad?hl!`j%9peJGA?PgloX28dmNaEADG`b|bq3VZ z$6)pILBhkq&${gYr0HpZEXK+5^DyxkIQpxlq{Xc&xAF+gH6dnf%;1=AU5bQJWBgxR zknj9)Ut_v;Xwv9GU|s3(4D265#e%Cf85oeq`MW3Z_tF~X*qY0XK;?K31@K2xt zrKjN|`yuFHsVC7$aI8EFuXGG7loydSQ55+NFzQ4F@kWDSiznMfcH0qEA2i0t+Etmk zMXWbOE~v^)zQzAEi2b>KB!?!g_f^-^D(H1}D4!`>R&!paoT|S68zEAqZI$F59DE(P z0v%($k956vIi%aE(ZQP58G-RRG9pBdB#E=bMi>%R9EojRX=x8 zB+luW*aJ5GN`4B@Qpm@X?Ch;*oF~4k9VC)S1t)e4*BaAKF5lEp>*suu7-&FLI$VdL zYon>VX@g9YKB=5kgv%IfB5JcIa~EqqaQa|C+Q|(V=(?b4QG|nGduRjAUS~F37$z9j_SY zx_b2*J%Uuj00lFKM%XtM|I6C1BW5-&QYG|XtqxkyfaY#>5ayZIsHjo|A8=Z-n@mzq zZ{Gq^M-9;juodf)h~nXstS9a1%y&DDJS>A@=Mf**$IZX!x%vJ|?jlpz z5&5hI5u5KSV2M*}%$ab~CwiYIM>2i!Utd9BA}xj4a||=-2$wg|H=hkZan<6Qr2Pw< zM$&FV0+tqtuI4U-dV?(>)*w+UBI)m6;x4{MQoYBwB~m(~Y16+0#iwRDcK>wxhGoVh zLj*+;0nI~lIUs+R_bYzQqC##3$oi@9P1lpY_Re~bK;C^xgX9PZeN6MT8w|fzAC<$W z&BZR+5wVAgwDH5EC?i5>b&LS`TF#dBO$1#2`w}MC`#8=5dF9;sSN%P) zazb{{2zNaaN4RM$SSLDCja*#k>dhyXWl@}$xOoXsp)*0Y#+(1!8B2fe}ZwC82gRiJuUww&;oPO@s(Y*-%1_L;fYDpZ!3B zX9)?pL7hEU!@S*OA!xsB*$%^oyh&##WhImNie(dNNmPoKd=l4*xAq61*2kg-rIPuN zGOE@-z7xdv0$BxEZ8mctibTy%-=^8Mbc;%dd1`fKe-^!Hv2vNT(wF&E!?$5FBlsO2 zF5~@&muF|=jwgXvn9;ywZ$9dYAZT2?wi@KbR@(qzv*SnA`$XGb!9)|Y7o#YGLuSgFSt^LfYYJlLKOn*22&OdULp>JW zersRd-=l}YR=c#zpT5ICE}dhf*Y2@YSdfu)U%)X`xbZ*0k0*DJr*54lU!$=nqEaM= z&{3Ss(w%7RJE?%2X9b<5?v9tzPnJthR(_nU4xOz1c3xK4LT=$_e_hTeFe-MF0nOFz3WJ$v|Z_BeF*^xO63)|t5-@kcNYaayXN5B;61stO0vfU5QU zB)?E4Z=-D-22wdfPX}m|t-4iK5i7~*ZudFTmi{&uP!%aWu+q}mE5!>^g9|d-i`U=J zUNp!6K4ceE@1%OjZt=n2h3ECPd%xZeaerK2T0SrQ5Ml6}Sa}!X6)Cw4kHE>;B&Z{? zrQ7%CsJryOcsqQ_xp>Ky?@HlnNNIZ>y