From 3481a2722fd8c875517056a5041e99fc2f8ed561 Mon Sep 17 00:00:00 2001 From: everettraven Date: Tue, 19 Dec 2023 10:48:51 -0500 Subject: [PATCH] add more docs and logo Signed-off-by: everettraven --- .DS_Store | Bin 0 -> 6148 bytes README.md | 9 ++-- docs/.DS_Store | Bin 0 -> 6148 bytes docs/README.md | 10 ++--- docs/_coverpage.md | 14 +++++++ docs/_media/logo.png | Bin 0 -> 14034 bytes docs/_sidebar.md | 2 + docs/index.html | 2 + docs/panels/item.md | 1 - docs/panels/logs.md | 96 ++++++++++++++++++++++++++++++++++++++++++- 10 files changed, 121 insertions(+), 13 deletions(-) create mode 100644 .DS_Store create mode 100644 docs/.DS_Store create mode 100644 docs/_coverpage.md create mode 100644 docs/_media/logo.png diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..3bf1800e7d9a29f27eac676df3e2fa3d08bc27e8 GIT binary patch literal 6148 zcmeHK%}T>S5Z-O0O({YS3Oz1(E!bED#Y>3w1&ruHr6#6mFlI}WnnNk%tS{t~_&m<+ zZp31}ir5+0{pNQ!`$6`HF~@wys#%ySa9F-MQ=z!g}+asqtpSy#e7#!{|dSdRn?om%1 zxP!%_ZSU;v9iNRJ)2B?nXhJ#gtz^q!4X>bluID+JW~t2X!B^+kd4$9OF+dCu1MACx zITP&8`cgnECkBXt9~i*>K|n+F3|1P|)&U(}pD}JBqJWNX2}EJgGgxVa2ng4ufVz~M zCkEH$;1?#(GgxWV<&3MDVH`7a{dnPOcJK?8&bX(MdSZYWSZ1K9O$X2aQ}|_8KJu4K z$RY-afq%vTw}!#cheesQ_1p6BtQF91p`l=2g$fAhOP2sJa3ATappFaFA` SugU@GBA^JNju`j_20j3}CQ3#C literal 0 HcmV?d00001 diff --git a/README.md b/README.md index 162121f..67416e0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # buoy -`buoy` is a declarative TUI dashboard for Kubernetes. You define your dashboard in a JSON file and it will fetch the information from your Kubernetes cluster and build a dashboard for viewing the requested content right in your terminal window. +`buoy` is a declarative TUI dashboard for Kubernetes. You define your dashboard in a JSON or YAML file and it will fetch the information from your Kubernetes cluster and build a dashboard for viewing the requested content right in your terminal window. > [!NOTE] > This project is in the extremely early stages of development and is a hobby project. Use at your own risk. @@ -55,12 +55,11 @@ The `test.json` file contains samples for each of the different panel types that You can also specify a remote reference to a dashboard configuration file. It must be a valid URL and the response must be the raw YAML or JSON contents of the file. -## Controls -- `ctrl+c`, `q`, `esc` will quit the program and exit the tui +## General Controls +- `ctrl+c`, `q` will quit the program and exit the tui - `tab` will switch the active tab to the one to the right of the currently active tab - `shift+tab` will switch the active tab to the one to the left of the currently active tab -- up and down arrow keys and mouse scroll will move up and down in the active tab -- For tables you can use the left and right arrows to scroll horizontally +- `ctrl+h` will open a more detailed help menu ## Contributing diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..d7dc438e029918b62f6b231ecf551c95502c95bb GIT binary patch literal 6148 zcmeHK%}T>S5Z-O8O({YS3Oz1(E!bED#Y>3w1&ruHB_^b3FwK@WHHT8jSzpK}@p+ut z-5i1eZz6UEcE8#A+0A^A{b7u8ZxuU?*^Ds@8X`xfLD1ajYMEd}uI5Ns7!}KTl**`K zqQ7XuZ{KABo3Sa2S^fJzqIsGu^U>&&x7wYZ-LBQO`qqR0EDJvm^VQM|7k4uZPAvwDF&Sg)P&P>fHHH$$;@ z9OrB(PMq;()3Xi^kIt`xmvolNH%%l5&Xw#Ltl%A#T1~J1B1>iV1okSYiX|ilhyh}N z7}!1r%voUdx36@nm>3`ieqaFi2LTPyHCSp?TL*M_eMWx=5e0O7OCSn^uEA0xctE&L z1=OkBJTbUV2fHwFuEA2HPG?-L4D*GY)Dr{5K%IfM9@=>RU&1fb z_{guP(1;iy2L2fXyfg799u#HH)^FwESu3DDLPNp05)}~8YnK2R;65@?PVE<{L!4`{ W)QGd7U8MukML-ck9Wn3=4158 This project is in the extremely early stages of development and is a hobby project. Use at your own risk @@ -54,13 +54,11 @@ The `test.json` file contains samples for each of the different panel types that You can also specify a remote reference to a dashboard configuration file. It must be a valid URL and the response must be the raw YAML or JSON contents of the file. -## Controls -- `ctrl+c`, `q`, `esc` will quit the program and exit the tui +## General Controls +- `ctrl+c`, `q` will quit the program and exit the tui - `tab` will switch the active tab to the one to the right of the currently active tab - `shift+tab` will switch the active tab to the one to the left of the currently active tab -- up and down arrow keys and mouse scroll will move up and down in the active tab -- For tables you can use the left and right arrows to scroll horizontally - +- `ctrl+h` will open a more detailed help menu ## Contributing diff --git a/docs/_coverpage.md b/docs/_coverpage.md new file mode 100644 index 0000000..24cec27 --- /dev/null +++ b/docs/_coverpage.md @@ -0,0 +1,14 @@ + + +![logo](_media/logo.png) + +# buoy + +> A declarative Kubernetes TUI dashboard + +[GitHub](https://github.com/everettraven/buoy) +[Get Started](#buoy) + + + +![color](#ffffff) \ No newline at end of file diff --git a/docs/_media/logo.png b/docs/_media/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..495178499dde555f9b4f218bd23d55fe93fa87a5 GIT binary patch literal 14034 zcmcJ$bzECrvo@RrcL~r^EV#S77PnHI77te3rD$n-FIpUmySqb+m*Vn<-sicW zb3fnt&imJ!{Py0nXU#P;Yu2pU$;wKYsI+l=0DvJUE2RdzPQs1_WJK6m2-yt> zc7Zn+R}u#Rs$$UYj1XY=5EEH7B>=#a1_1C21ORSeEWbSfz=aI}_+bbD2&4i4&+Ids zUJ1b(DxunPW=cu`1{jSDKmy_d;9wLG_67i70G_nLD1b4L=x^EzNcUedAXpxLn}B zt>=RN)-ah1_cy%&lLLrmo5T7BK(UwAaRLA^yPpnV5+f!N0DypOsjls;t)wVmVrRo* zWNK#&WpTH$e?kF-+y!8y4b<5P;%;MY>m=YVOz}rT07gHtSt%fYM4aCVQ)nxxLL}`R zp%5MxHWoGt5mX2SBIIalCZHxI{a%g*@psGPZMZ7N($hGW7TBFF#F9 z{} zYaj*0O`ZPf%Kt4&e-g{y$k7R^?qLrVrci@A*||8HK>yCfzeeG&^S`X9+qsxnJjsi2 z2(kW`<$v@35#oOWC7%WoYAV9P#=*(V&cV#i|2O_$P5%q}rMt77sR%DGl+%=ri;daT zh|QRpi=Eq)+1QlJl-Y!nkDrf^o5z&X#OQCWe?k5iozliImE0WM96a3o>|E@;{M>wO zf2032{wMf<8>#P+^w-Rpmrbf3ek}0RU|7a#G^z?!ZHDBtH^p z-Q)a<0#EaNe7z;rM+pfD3>4%rWMqbXE;&_tl{h4MFXX%5tOVgg-hLtoWJ2M7exWF8 z5~$Q-5a0wFeMWshO~zsCR@Q13$dLw~=dQIsO4L5IiD0 zB1Ny5RX1}ejDkl5J;&~*5`p&zrm#Um`>CbE&0t*iFgr2Bc4~BFV@F_ItGARy)Fy~x zvnA}DkIYvw7;A%nO6>f>T#EIZ+|<0%`C<-sRB3p>y;PA%haZFn4eYN`6dh(hEs)>$ znD=)5kXuR%*?2-)IetkA=T>otb9q_PxxcJ;TkUn|!-by%;VD-YJH(U*?N>&cIJ_}? zfRBEwm@_E;8C*ar)5yJtlLQ*Wu=Lii1<5>Uw}zvUSfvNSZnK%_xY8vOnq;*6xOUk9 zB92BPuEv>v+kjK4JqY(1oCMIw!Ip8b6hAN-tFOsseOn=1B20m%fx%Xgk+Y?x0c-&4 zx2eN7(?*nP96(9@$`7g}7Qv8}VC_&ql8 z^R<$Z82!q*_*xBtDI=(70oDaA>HPF=xZCTHP)%kO7g%$2Y~2yeo0upxnUxpXspDK^8} z`I*D`2ups}?MKPw=PNJu`%knyFrz*KZl7FH%IuN1t>#zk>ru%OcfO}?kz;m+*leoi z4$%zkWakz`j^~PP`xc=*B|E;(gyR_RktG~?yaI-6!gxgolz0rtORx5fq(mR0yMF`; z{N#~TfuoLu6#Ep_-A{vzIB&)%XrAR(6yf>4Dd*i@xM zXd*(@o<$%v$~C&dPf`HKd;W;IS$J6V_!Z=8nQi60eW#C60ckp9sB-%lmPxma*S&>Z zHJ3tfdKt1)ZwTj;S9o27&D`Jzst@cK538{-fn^Ym;Z?>j2}ZB=MZ5)*Jq>-#ab~oz z@^7-(YIJ5Tjkw)-z-*ONJYD`|Gf%LzoR1C5*=+pX8ceH_A06G;;w(ETpj$6cW~?Yy$+ZxvhsGErxH? z1E2F!&IvuEZ7*J;TIzo*)fAJC+r716svVaRtAgSsQXCLqnqPO9 z-`Gy0P*H3K>20$^LBuLeIu}g~I>-HCF}3a)aJ*V$!pZ%N0=hGYBek2Y%vH_NlHIV0 z^<=_>bjmS7^A}mU$xMt#Te)qR`-*#vMUPckyc!*QAh^Vc!t1AGKKCuR4I zwaPSH<`q8)cjDdynM|SO_-8nD|dJk|5)%!xcW)%ID6I zIPSYaePwFk4w)&yzK4S|hE|`D)Vg3V--mWj=+GTm;(VUFy$Lh)CWq8N$9`=He7qDs zQjv%c!8Cq`?F9=VN7@J9%5bk`o&*VYpQVo88jx`eP+XD5>0|>p0VLx7raPnIFBYQH z$%U0`+6g}zcV4=%3%_ci-`rE3=^%dJ)U%eSLOLuuO$&$91rb+7B8ktbD^Iv3@)9y*;Z^NUR3}H%v z@ps=PqD*KzyzHi2S-9NsPrt(=h=vSDMTr(S+>itB>u9uW=5UI#K*(qb7OlOnV?Juo^$TvnkVcBoi5~PlOjH@c8*|+p= z2COZEuKiGu$`32AT!{=Z92Dz5=BBd8A+I!mTArS?MD9Kw^y4)ZI!>s8LrxFG^xPvOzi_dTR>LE1GUWGTfYWrWXvtN@`uHRy~ zx{3aFZ;Rpb>7@rY)7X!u_iDAEnztTIcqLQ4h zdLg)C#B^-_)SVEbkI8V`GH?n`{X7D8^;P~Phn;{? zO0K*DuE1{Xt?B@ijEIC;tOrR|f^ZCBH8r(#JxpX(={!e8XH~s!uCyW|>DQ-|VYD9o zq-it^Noj29-CUV5cBS&)$lz7Y7_d`wqZ zzdb;b&W~lA0t!lKu z+>E51ja}}cj6}gmCSPgnP83O^dPB!xuQ2;Gm+N>wbI5)u3eFdE*O^LCx^Q)>uUywX zrRe++;dl;qqxm#n7q|8O(YIuacdyY}n>2h?47H62m^1bBrUT2oqOw}2mZqOonh@(` zLQBeLgEo^>+cjHGJ>YCUZ`OLgP)*Me_kas@44sd;$o7d+liE~pD%1#HCcbI>-uLtM z{)cVr0TSrdM3|I8mO@}R)c%)WF$p1P6Nrd^`Fc9+mY%X?)V_h5f1j(0DW*8JvU>9M z=MbGEf$Rvy0;oKcUTUTKIEh}RFu{z5zs&y(8bvJL%`pwnbNJ3a2Pi3Hxt zlg$hA6<*zvGtiop{F$Pu>YL*R_Ppqqn)Ttl!yxrcwwNzIxwT#LmpMwZ_TmkFB;`{) z-=cWHv2-ecx=ItvotF?vEL#0M+D(#oT$5i15I{Z-!IP(t@nY!rV6Y>E9IOzQw%9!| zkKGTQrO;nUHxTZ*58nl#kvY+gH`77>h1TWY1| zCC{>Gnc43zy8r`mmz_jI_$ziJStAD+^_L_stG2kDCuFU7NjLR&{aC-SA$`efkp; zL6?`@1or}bb}?gGYh z4A7%L&aPZ2R_2co;$hJ$qWU6h9#lM{wjIx8U5ZjJR4$jzY!s2~d`>_*!C}5`H#kO< zk<<}q`<8AYij*H1HeOXgEyx%6GC1w^yJqLLkTtdnI=1d0=@D7*m+gS)Y2@US@nF$b zh$VKxa!k&G3WKrd7Qbko{tLAHN{VUPTAMlFP9r32U(l<#v+oF5+B(^qj=UGm3T=L{BJ#1vx#!QP%K!nRI zx71{>LK!7IrzREuNRFQOi@Fb~d%kyHzJaybVoN3Rd^wj|CoViy^{acL`8P@Ox~Fg9RCa`5Aj+D z`2GGcL9KamSvbK^T9h3#-H<*eq$*7#Ky#R(oe|%5MfTblsXf2LleqX- zw*JUyx2VSl)N4bYs^`AfbYx6D++P=t1mA_``Z){|j9RtPAw`_^r4B1&xpCG^Mjj8+ z2xVN3;*abAt`o{z`Lv&5dMET%3En;;BHXP_p423Ks>V4CIJwnzgKWO958B(fo_PKF z#6YK9gX5f3&2hxsSO(&AKu-vqaL>Q1ApMoS-GhaFkx1S^vnx?a%;Xkt51 zeYvlc(?kIjF6RC9Fy$(N0N|cI%eTLwuXo-uGPh5JY-Hb6ASV7b?_YXM{KVKXseo@-U_jv)aA0y7U)pB|EXfAcq#cNvWKvdfeE>*$jCi zUM#mrR_lOl$4noWO27R`;m=u6G1m({g6~@EzT}aj=UVrP*$@tFFn|C%!&P=y^P%;u zL>!^7IwrI?8uFrip*CsJ|F%bIb)8N!=DS$w61Hi9RpAy&?7w z7FPUrs{4M#i3ovCv0(`C9)6EjKu{AT6)jWFLBAI>++J-cJU+o#J=D@yfp=XCD60la zzBp@9^r6Rm-+44>D~5rT@uszcno0iEBrw^N5)gQMvt3Xc)EtXUmP24jJ=Z6AZ#d{! z?f$Zf;Yz$@khg|#Z1hoYz@Ws3#(?o~UQAsx3?-1Z=3}L!A33W~Z%1*br3#v%6?{Eg zI*;cMA1rIeDJq)AH)xNL2a`!7-Tsnkcg#-#KQFSsi9yDFc)lR@jeo*vl`W6a#x;?5 z1oeG>UKx$!JFcyHiso++q8oiz6N7@n_<^wfn5=`7fiG0r(w3%QoV&CaPOO%^RLZkW zUg_3pDA@3ZSeKhvm1am-Tps$R-1*W)s#21urzAdm2J@_cnF)>@Sc}unEQ$F3KvUyJ z%U80T`jFnmS#DO=+6HgoD!-=i^49>;mmFUNV zh)|%;xo2z({iRI*?glTyak8-p9Q8R-w^tq!zX3PfLxUspWu^%8)p%k2t-uxwtKm*A zd2K)7lN<13-qJ$%DEo(?Z3C9u4wG9xa ze;?{s+^}UFHGE>gwzWC*p8=qm&q(7`@KL7ObjAFH$F!nHdd6L{``byTJ5W`R51Ss} zs0Oo6TsnZJa1qxr|302MB)`I{XJ@zAsX707xH+IqiFoV);TV3@(2KTj<%2>`O$9=ZWtRVPAoX|O z_pEpH7hl?0CY)?x$lu=}c@ zjm|tJ{22nbARSzY!J+lRN6f6$Rb3mM#+0n=7pajZ3coDW0&%wGhsDtzRCgfHYUp{~*Mn1elCB z+BVW%kq6E8Elx}$k)ndrRQevxd)KSG>L`4-Ts3;NoCw|AUve>4YZIbyQ?3}mB6ip8 zf)BFD$@sCr%{w*qyRN*0^Me~=N3lk({!UuZVK#yF>fp8Q^@q41AMB;W)dU{R^-s3R zs-AXPQi>LO_2FVxL>6$ohlx|imA7!#^Dk@f3fjLE`aYah^RSE8VKJf>(sG3E<=32- zF^Ik4qy@LOE~w2K;OTZc7A;5ZvohRXQT^!t=yMs@GatCQWP*sqvsBN{82ZsvwdyBO zTki8%9_Xd)@;c&a&sWadb%gd8M5xHjfLpk-7b1!lH(OY~H&sJc_lbM_`oK!m&p_0W zcMW$ZsK3GemH547KSc79zrv|bc15BvWxS{iFdi~weWouKsAR#(R)aEC{5XzS)_m$a z>SU~zkM63&r_F@feP0gcjFnDq)b%J}iQyb0FF=4FXCja)>pX(fRFKxRr5VK3^&8gF z5stdg$Pp5A9Hsc_k9-;keAHAEbG|zX3>do^+-dJ+-5^CJ59T&rmSHp}1^jD6wq2+e=YJ)ym`{25t7V|$l zwvelCzI83|YP-Y1iqi6_H@z#VDe`wsc|SFv6pD=@tFJqM>j`B`jKEirzQW1OSV4<~pRab8s4_L<%?{0#5y8W!;3Zwrpr%Q3s^I02B~hX&F^uq>Il_y!EttG^nKx?H5@QDq9bF z2jsE*ZHiDR7dsOnX=Fd?9nZ+C=v}Esw>}aQbzgWwzWU2NpG=>kD*Q9r@C$9Z`Mvt4 za0^uM2$zVM?3`ges_J&dl{SOT%Ug@Ow=Ru-mecK60XI4=`VmR}9YbFvE&7%GRBP1- z&z!bbwN~SpDBFMZ`?XT=SI53rIc6;#&6@+P11iVSdVsa2XQa{RRObc_-t7aR>OxIj zBFcBsW62cFpo|oYSk>+=4P|ZN#?JCPz_kpbwdn%J&f|b1#oP>VZJ@kRT`aW1WsxdF zw86dBQIx|12dw#qSQ}V?5|El7_V(FAwDg)+nNbIgGTK3Rh?w`h8_KS1zcF+Z9|{Es zUMyEs6>Rt=V_#MY1X%EFvQ~)A!Oy^bchGgXb!=?404Gf2zp*>;X~|J#Owj87Nc*9d z(dT!W;zevnhnk)n!sub9cx(!W$suA4|3s;hq80zhhFW#-SrjP^s4 zGn|W0xel*!{UWLOh;)CKCjC@DB?Vuknfg_CU_uBQ25T&<# zcO7z=Gl*@?+!ixV%U?_T1|_XUpiKndl_9bP?mh!mkwkedsM(9BsF*X=zB|)cIrnk= z6>;|6@E%kP-Ok#54=NX)8p=q>NJvvt_BpBy=&H7-f|=AC3ThbGa2xTfmkp;s>_LkN z#UI`n7m5qDd9)P4D>&8&vzDgo0tCfbVJmXaw4*Dru))%*JqbYQTX_dpdVKG-Sx>?p4ZD&Jh7`4M42;Wm_BOHK!EPLCG zQRtP3Fu_G4qqsm+EUy_X>q5M=zxbTeemPd7F$3JCJv?HCV#BHE8;MQneiBh(-oPGI z2s7M(Ki0EA0e%nT+J&d!gX?V8M0t6AGveX8#RAQ69R4+uMpA(}eY0P9BSmB}i#9g--gDfo_C}V^Sk2d26DI^~7JZGtKNTrr)r{u{ zvv&ef_v=cul$>X!c_T_h?R77rF>ZtmJGk8b$n39v$YkSPkmAbr`#Ac3oyH%>W!Y=9? zJkQg>8Cj7$5P+@ks}fF&RH4S~_ZUmS?w?EEwshH`SvKZ1$EQ&)@2H5>(8Ab75JN~x zMN{eh-OUuyE7hj?rx86SKj>ESXyWx^mz$i5g5^xi@~+ACTU;E8Hi?{8BQVm#qrD1e zned#|bBa>GFe?soWj+sgoNeeQT%Y|zT<{xk>>!FJ!uJvLo(kC&&WVXg@=St@0PN2b z$k=fj5ACbkUyeJ%#n>wu`lL%rP1&rpuF=Oo#D?8>Wbl*T_{B?J6YoZ7eLj{t*0qaa z^c41-tUeA!VejU(r(+A0k*?Kd^s`1e<{V#7g{>;mVnF*dGQ&QoB7T3t#po?smnv*f zG0TGDn@6Gu@5xA{E$Fd{Z*^&|O~VPozCvFy2?&7G#JA6@M6L0to1vttjPx|AUHF#e zSkN^<#{$8^_tSF<|LNOtX(HbB;Yji^k-PBPIpNQ_>v9o(v_FP*TM9VV zL_u=(hI5F3B+*b5!=!0Rol?^QMZ$(6cnkI_-XQhdSTvk6eCv;I9~qz-p1Yxval_V? zi+-}5$W@WC4#F*RbM3R<*4KAYa!^~h!bN>WEt>A+hr|zGD^_L|f8U+iip$uEVvx?u z|K`5q_5#E_N`{*wZM=fxP+zK!y^MMgJVybkQ;-t^#2Gs_()=C4&*6<<+6HWFm>n5l z<>GY9BSlvz%{7PQeGWuK$g`3kOH4WI9ZbucmR_HGy9tiS%jB>z8 zMK@B^MJ)S_Qm{aDY!b{DbXi)C$zU*5W?Xl(xk`2E_M5YLHeu(mF!DfTVEc26EXD`F zk3pH+#%xG0f+SD?^(5UBczidX34NPA;lA)V7+|Ck)7a|16j9oSqYpJkXzC6mR`k`b zdyH@(x5L$c&Z^(N%V&>;bYuzKB7;v3ys!~PI$P}uS*+@^x||7-f~}9>+cq<#I@@$)-IV4fQBA9M42~xn#@Qc7E$DD;Rr%w4 zdwh8heYA5m;#Er3d)Jn)9JSs8BGF1CQx)mwZ*dOybks{p9lLG%V3RpjO3sw^Y36&Z zCb*5su&NSolhu7jyYo|_#?*BB`abqiD}96c$7yy`S`SwATk+Xt6O}l?*9e4Xvdr(G z-XXq|Ak7bhUTV4~?X9<@SiGD8tJ9+oN}_NSKkoNtM{LL#X}MlqvkTm!TP%Sff)Gt| zVp;5US~lWgJWXCozK4*^hRfFUUNK~o)(+m2vxqJmv1GJBxe;~fx=5#Y-Dk(0;@k4) ztFqiBtzfZnQBz87pTUgEAME{sfwvKJ@tx7qm@bKq;5okeZBTj>+9-0lJ6#Eq;r!Hv zCmotAW(mGE-fzYHHJpQ~*alP6h?Q9M<4vM=H$F>ba{-jVNggKBnvh_|1V?ql(Ol2q z&UQMvit6Yrr^@h9L6K-M93^Fak^u>Fc7;t@(FXzX$J^VqX}vAxk`UN8i1wGD&K5$k zWKZwHi@q|gOSHy)KdQk@x28l=^@^6WhXPiF4;l=|jH5{e%jas3S+p=@6eMx51&Qdwz^hSI9FP_joe+PARf|xq#h2tS#x_R=*?y=+R#==TJfy@X(}5a%arEGa zAF-r~T3AV(Ee-WZ^N07;1P2ZNzCW48VW&sJWJI7Nj12}`?vS&(tQ*=u4hCX}L7FHY zOe+3{s2r1UFH(qSb{a5pX6h$s-$UNzp_7zOFK*;%svK!Oc+G23xglRKj2LvUzcU;` zChuOGu|UEH`9cYceEIiGYma6d&)#1yp1+Gg z>EE#=C&CGe9q3W;%PW~E`5pZj584|v;jHMKX{~a3jFmOaMhWaCjoU@p$ z%-sI8?Xhp%YT5UYre^@YmhySON6We;?_}U4eeQ!@4rQ&dsRDu7h7)zK03=V<{P(XC8ZaNGzz&N@;E zhS3~K6HxA@qG4gFXS={lmQdug*cY`-m{ZUL{XwHhaaA_Xn_bjqW~m|}ip9>FSp~o4 zT^iTb`4O+&O2#_4xldmhzHbPZNBVV$ArK8FSCJIIm1QsnIj#Y{dKL4bWb-eRJUklo z?qa9gbs^@4vz|NW`tK zQlXN;Ts#JhW+j;$ndl7A&H;IqI5LEXkuRDM-!-`j9PkQJ2{`k{YMx+N>1yWvp}o-_ znn&UiqRR}%IaYJCHi&|Z9Q%`&UyP4{Ui56GC1ELJW#1lRyDX82D_^2iaQ!cLYH&A~ z-?rc3lEwj+a|MwFR()PdHmB}EiU1itSIGAWBAYa}tKK|ww&*101<4$#79*e6 z7=UP*a0h2jm1TmJmcFUHNAKoYD|kUzh~G6%5*XGsP=o8ib931%KdGlC z8uQ3e**dc54?}YMn~30+Kpd;>u+D*#rJp0cWOB@WLY*%~XXcqt*1HT}gy61?0}{Tr z4re|6$|ifS&>iHYLk`r+cm6bnS0BV^PFS32BfDN>j!>FZJ)uUN%>O~@jiGvY>|5LR zUv}6@N!Y_?)bJY&5cL$2KG9|q3*)kn0((1Y2bg4N#!dIlcSi?^8(M(4wdV!{>SWZi zR>mOZs%HVhMBlk>+q+sOI);JLUrw;XX{LCCzG4=_2MF1kNL-+P8|0gEoINS_Z9CtL z4p?Tj+q5UX(wH9D*{y8!`zck6f?^_RZO=?+1e0aS?#t*a@|ezOyT$45{smVy$6CHy z%QBST1Kun9g!H4;BO<6Y`f(RU6u(Vh zEi7?j=(z9c@G^}x<`MV#d36AlH{dxAyobcrwTTvxbZ`|tp>Ds2pf zHC%KXSFc>fu`n{!M# zN-ow3+Zm9+3M>Uz-&i8>vVSSQetz(pKLo-^beO&G$qH6G+%Ya*)ybVNIx|yt;7vk* zhf$emNhp&PL!4z^^ZR!{CF(v`ka^8=FznavdE(Cru2XJ^JQ_HR#D07fXUL<*ox&as zZCX;|ip6Om`~%;TN$dNK2Ti(BO)M-G@@A8ZCi8CaejF+l+M0RXG#!?~#|Ftu*G}XX z^MLg5G4?D5awP@BKZk9;{k{oz>gO^z@-r_ppGEKB<1%~akeR0jc@!a4nI?uJRh@Om za(9DJ=Pom`eNn_PPc+A~F#Ep4$e*OW>=a;2aXDMhc4u=>4dQ=8-j7(Aq?Im6|2 z_sccfa#?15BH$FySYvNrmhwAZ)^J*UrAWJD;YX6~n6Dw>X?~8^1q6nXz`JfdXyIh- z+52?C^yv}@L^(M{NG`r$hQ-fyo-VpN2c8rM{x@?I9d5`#T1q4Q`;)T=1Hrf5xY`Zo zA|)m~EF5{OJ>)^$2pW6=W;~oF!F>B!%56arzudQrf~IRB8J_LyPj4yfZGzORi_9OmM2#;kiU%K5;akUV4sr5^=H?nk$cUm4V{3cWF)6 zT8$C9I^{o1SD)L&>69ScdkL3zTg+vV&9Q>~=llo4Fw{lr=arLUtCtTgTkH~*OyF3*js%Urk&&n_n6m5V@q`q*R*R|OBxEGqjFi*pj=nO9dq23BqO(lPgrfVS z`b(9jZrIf5;TuVX6uqUF{F#?@F_$H#B?z_tKAz3m{GBsk)%bIlLIfW74jxUck$f~2 zg|Ar_3nO#!Ri&_6S?EPL-?r=}Xf{r}@9mgZk!dq)DE++In-;q%Hp9_&CaW%N z3^ep^QP^(Lo=4(v-V+oUb!|$~&9*@X+tsq+i`heT1rMX%bKn?1KYiL=bt)RNf$=^7 zMv0^$vqxU_i76_1t{c=|hzZ)5u+FXk+kA7mk{(OUW_Qyh(Lia-6ym?kkrpjN{WaXF zY$BRKaPsKgrjrEU*nVD99#_TgP$o%QwJRArz61^vffY&e-=qBYU@iiCWRx|zO}W7{ zHHB0sENalI7e|D>^9O3NuhFx&Rz9%Ve6gcMQQ(A_8Nc3dDIBXay6 zBF9UjWHxNr>UE5xiw$Gh{46f=Ql5|5wm^h8)+dL9`fHQ2el5)fJSaS3sbRZY_ebLM zW^Se0G_5kkU;C{9WC0-X88hwElW9>m`kD*TGeIR@Br2$&15&bZ-L@ zGq&N<0bWLelu-osp6yyotQS?S&uoNok$ozbNXJ;1m$w^kxja=_hM%XaZ1UA-;fU#+ zW7ez?Y3ocKy8C|MYtd$T3)_>YPW2qwSl$msxEm)ZAgp!_Cs? zUi|)`UjOeErvO-18YL_CUabwZ*3UC1(AbCu<63a_p^*)iQu4K_VAW3GjQIH9Dg(QP zyiD1L3A(rNg7UM$=%vt^5^!GlwPd-;p*g4T_u=Kt`obd7;(nCMPU2CHG5%6H4Y;|^ zHXA;?*u|;Q^Kx;q%~TAb@`=pDsdto`mpub`j6+^?tO2IqnoHt%&Uhp$53g@j`;0zuZ=_Wb2s2V9(Ky-`Z5E?iX#2aSTD3Y{?SF&NhzVeMxQ&Im%IG1tjoq8b>*dNXS0J)dSQsokc0sjX;i4m6o literal 0 HcmV?d00001 diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 595246d..c1191e3 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -3,4 +3,6 @@ - [Introduction](/) - Panels - [Table](panels/table.md) + - [Item](panels/item.md) + - [Logs](panels/logs.md) diff --git a/docs/index.html b/docs/index.html index cb5d2c4..9b5bfd5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -17,6 +17,8 @@ name: 'buoy', repo: 'https://github.com/everettraven/buoy', loadSidebar: true, + coverpage: true, + subMaxLevel: 2, } diff --git a/docs/panels/item.md b/docs/panels/item.md index a04ad3e..1c2facf 100644 --- a/docs/panels/item.md +++ b/docs/panels/item.md @@ -47,4 +47,3 @@ panels: - Up and down arrow keys for navigating the viewport - Page Up and Page Down for jumping up and down in the viewport -- `v` to toggle viewing the full YAML of the selected resource \ No newline at end of file diff --git a/docs/panels/logs.md b/docs/panels/logs.md index b2dd03a..9d29dd8 100644 --- a/docs/panels/logs.md +++ b/docs/panels/logs.md @@ -1 +1,95 @@ -# Logs \ No newline at end of file +# Logs + +The `logs` panel is great for following the logs of any resource that has a `spec.selector` field that maps +to a `Pod`. It can also be directly pointed to an individual `Pod` to stream that `Pod`s logs. + +## Examples + +### Getting logs from a `Deployment` + +For this example, we are going to fetch some logs for a `Deployment` named `foo` in the `default` namespace + + + +#### **JSON** +```json +{ + "panels": [ + { + "name": "Foo Logs", + "group": "apps", + "version": "v1", + "kind": "Deployment", + "type": "logs", + "key": { + "namespace": "default", + "name": "foo" + } + } + ] +} +``` + +#### **YAML** +```yaml +panels: + - name: Foo Logs + group: apps + version: v1 + kind: Deployment + type: logs + key: + namespace: default + name: foo +``` + + + +### Logs from a `Pod` + +For this example, we are going to fetch some logs for a `Pod` named `foo` in the `default` namespace + + + +#### **JSON** +```json +{ + "panels": [ + { + "name": "Foo Logs", + "group": "", + "version": "v1", + "kind": "Pod", + "type": "logs", + "key": { + "namespace": "default", + "name": "foo" + } + } + ] +} +``` + +#### **YAML** +```yaml +panels: + - name: Foo Logs + group: "" + version: v1 + kind: Pod + type: logs + key: + namespace: default + name: foo +``` + + + +## Controls + +- Up and down arrow keys for navigating the viewport +- Page Up and Page Down for jumping up and down in the viewport +- `/` to enter a search mode. This will open a prompt for inputting a search query. When in search mode: + - `enter` / `return` executes the search query + - `ctrl+s` toggles between fuzzy and strict search. strict search will only match lines strictly containing your search term. + - `esc` will exit search mode and return to the full logs