From 95fb4b198353a6fe65328558ec475e03592c3feb Mon Sep 17 00:00:00 2001 From: Major Hayden Date: Wed, 19 Apr 2017 07:50:31 -0500 Subject: [PATCH] Update README This patch updates the README file to add links to documentation and contact information. Change-Id: Ia28c9fbd8ab7fb3c083259b2f85b5f04a702343f --- README.rst | 44 ++++++++++++++++++++++++++++--- doc/source/monitorstack-text.png | Bin 0 -> 6029 bytes 2 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 doc/source/monitorstack-text.png diff --git a/README.rst b/README.rst index 25988cd..7c708d9 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ -monitorstack -============ +.. image:: doc/source/monitorstack-text.png + :alt: monitorstack text .. list-table:: :stub-columns: 1 @@ -12,6 +12,42 @@ monitorstack .. |codecov| image:: https://img.shields.io/codecov/c/github/major/monitorstack.svg :alt: Coverage Status -Monitoring plugins for OpenStack. +The monitorstack project provides a framework for writing monitoring plugins +that output data in various formats for different monitoring systems. +Developers can quickly add new monitoring plugins (along with tests) without +worrying about how to format the data. -*Work in progress.* +For more details, including how to install/configure, a usage guide, and a +developer guide, review the `monitorstack documentation`_. + +.. _monitorstack documentation: https://docs.openstack.org/developer/monitorstack/ + +Requirements +------------ + +Python 2.7 or higher is required for monitorstack. + +Each commit is tested against Python 2.7, 3.3, 3.4, 3.5, and pypy. + +License +------- + +Apache 2.0 + +Community +--------- + +The monitorstack project is managed by the `OpenStack-Ansible community`_, but +it can be used with or without OpenStack-Ansible. + +Contact information: + +* ``#openstack-ansible`` on Freenode IRC + +* `Launchpad Bugs`_ + +* Send email to ``openstack-dev@lists.openstack.org`` with + ``[openstack-ansible][monitorstack]`` in the subject line. + +.. _OpenStack-Ansible community: https://wiki.openstack.org/wiki/OpenStackAnsible +.. _Launchpad Bugs: https://bugs.launchpad.net/openstack-ansible diff --git a/doc/source/monitorstack-text.png b/doc/source/monitorstack-text.png new file mode 100644 index 0000000000000000000000000000000000000000..d57d9c7de378ec3b3ade55c1d9757ca8ab8bf4d8 GIT binary patch literal 6029 zcmXY#2RzmP_s98WZ_3UVLS@fvxpvBpYe!srZ!)s?NRllgy4lIzT_Y}$z4vyLb;ZV`B|K|}zaQ{*&0ffoWR zEr=@44fdy?^>Z4yLhPn)$Ti<6bZ04@@GY3Mv5T*kXiCj6+&=cW-{VzGz9 zyi{DBoo!saz@IocDjqhLUN+Y3zV=>r><|qdJ?n=ygg7{Ke>GH4@hX)`1tPl#`8Uje@_w@m%`^t#LaDc<7V^q9>?ZeMdjf9%*&5Cp6JHSK=f6f zC)z)T;T0L45*40sg48o=D)7!)4f|&%H7zc9QG%<2C#lCnP`n5#-F*4Ps|!p~LjwbU zI*FW|+`;Lo8Vttp_U+p$k9AGIz(9Q^YCKCi&MY0s!LNylD0*{0+-OQR3C5w`Uc&s4 zYiYWNrs|PuR1#sD#mWHzGKM)B<^jYU930ka5zeV^--hk&In{PGH8d1dRZ)$Mj6mJ+ zEN?*#46F{<`c2(QNJyyY>1|J1MkKkqoOE+#Y`#4O9}G$<8+eM{UU-Dc zpM41k3A0&zdXrcRi1U*0?R8TasZF`Lx!rpIVlWUtzXl`A7yPuR`?C=IeMRuGOzKY5 z&vb$1^>rkzZFdwoRjevJa=y`%x2d_gtbm1RG>2W3vmte0{p@hy5l6ZvibTP7=x)o= zkSsiM+)nIlE$wM(%Ks0;t9{w|UyfWLo#*C|_{=IX8QG7EKkdm}kfe_3=@w~`KnxnW zKU-fGiXGp;22RDT2+HriHzhpR=t+3*-aR`frw9W?WJU&kS63GmD=P&r@6oI@K{#&6 z)viU^OYFyl?A46R>BPmw;gI+0+zgT~bCuT?m6NN7>jMow`%K2h#swpG>=^^X4r6?( zPo8wn&(H5UdU<&*tsvv|5aV_(E>Y%{(WVch+uId5xwslfSC$v7P%A4|VAqQZ3;#o* zPIbDti6nAwgLk$hHbEDLXI*YY360XfY z>M8Q1Nxxgb`87YEI6C^=v^|*R!Gi~GK0ZBPULYED3QI}|#>dAS+*b+49K>g4W(vj~ zK2Gj}V_05U`Onwa_w3?=i=7>(2$Brq{=-Pw&G!=jpdh)Oot=W`Wd#NZ_lr|!J257^ zx|z0oD1RgZA#izlNyWerQ&lCTog+2EIZU2RfyuK>*Nhw*(zUBImXek2Mk4WDTwD&0 zj#R)}?vUVvvxxHgd@1XTRxCI0L^8_yeEn+~?88P&OG_3ytq`d^LXX)QM>t)a?mKM^ zW)5Pv@NTSX*UHMul%Yis5^Q83Rk^`H606)#gGzH0k8Vz1PEJlj$@<>jU|~_w^iZy> z5d=b5i^rcHS6p0NUHz)pBOQ6A&}cd&;WX9p<;$0bN(BaT2S>;0iE@+a-~>jb z9zJ|1C@h@H^4PD+g8XYgI0pO-L}U9cLJFyf1x(-25d3I!*!FqZF}-DLOUvL-6*DuI z+3Ht>TAG?xBAMEHj4?>7)2*W9nmWhH8vW0@(+L|aEG&Yuve~VtGmcI@35x-||)$YGe z$Z-Vt__ie5wcZOZYxd61=h}-g6=4+YMEUvot;)*Ew7F^A7uP;%r2S)EYHE@>y;!`- zJ3l)kqUoHR%&>vONh*j4!rufPk3e`5p?$9VGj*nF_o3nM-rZ4R0&!hEknt!xy&lxC zOr2br^j!?P`OnNJ#_3wHZWPK!vv|~Q>doL52>QKD+dNCF>ZwATgW1LF3Aor(ZS8MA zPq=A_O={uf`eo2?364ayZVBg^AFqRg9%S|2=GBFv5&{AO8kiqGRk-@r@4@hnk=XxS z?(FFJ*czC=YLMqHIdCCV&dY})3vrH`%1**jwVPM#{G+DJczLFuT7k zxG%Lb9@a^V*4VbvlHgyQZ{{0mYW@thOw3F*ueANsipfLj^wFXCOr9JaUA%aj z68-iqjfBgb6k-jP1@{8g0qu2)o_DMfBoNOYqCu3*&dj(SEGcby$;2nTy54>o(sg}x zfudLhIrJo+jzdy%(%}^Xq>Z|+ZqGQvu>8>3u?kdxmw#7~2L1WvmVW{e;|>wg(Od!o zT6(Wr&679tLs-F7SV5o$iL-InyDs*$_#e4#3^Jk{dXw28rlxl*OdG9yF({K85V%#K z%Kf%fv%>ekI++|9AGa}>dVw(bSWwWh z`EUpY!$Spy5OuaeaN?`sl=4;69*rKs=|OiFPhY|+?%8_R%{&TeC<7V6Ys|ba*J}KeWW($^j89ux~f59sM`h&pb+22)R_Z8J%ajrzQR~}@T zt&yVc_w~yyr;1|}6G?slmbL;&rA6|VHnUyZgr&>2_NHrndzbGXg>CP{*XCq~!Ag{(cE8 z9ipYBwb<@0!y+Og(lB~}!ALfekAO*Q{2>(DG>H$;p(UT1E{e{IC+Hp`oE-W{!VWq_zyI-BfE}{Su3Ry5>FX^}Bb;64k=7 zYRD%bu&UepF8nAMYQT3#%5ACR(P`Jw$qDki^Q@kkS)xibg?q8>c1BvUSk-B4wt&Ic zjyPI@f7kP)qg_{4SwfcoVcs}#>HN6>d5ioJdz+exiG+=ftk1GXKukTk z=-tZpBv8d^Z}Vs~{BjcD=Xbll^v`+hPvg-z$0OE$6WIXLVeo_SEvz=i#0c#&y!-br z;HyzB0VL_}a?`^4Kt|&A{^$H)8ZSy*TwEB4`x2e(sFV~cKR-W3LAs)%qFdku>gwuB zzkdAz^iuEHGt2ZmKVM%-3{kiKQ#t%B>pbBz|o;}a7+ zc9kVSsDlmv?RYgQ{o!^~*xufr+s=LLKWf!{7iN6R5#4dX4n%3rekeye%`yE#{WmjC zwtSGxY-^xov-@gKC?@1+LkE3q@%rx*#QsyMJ6VfGH8pRyy<|H5on2jRgM))j{mohf z>PC*W_ZjW?Bmn_UOi$bUFn&h@VF-wb60}!pA!s8*2DhA$}G+ zm=HE*ry_PKDTd_7hkaEUxUa~jr>9NbS5{XWlRQ4AnG=UG-D@udJ3^xS@|XKpTd4J#9x)8L1<}I|6^PhqlEs;o-tuC-FtN!ra)=xw-@00Q#tznFr+3 z5*RWM&`nf~jIrSS!T;HVHK5QtzBvGo1x*{Mb|)+Ar{_0_cRg2o$ltwxZ(L`n3V@%Y zOVPHUAzV1>_}EKTRdopf0ENCeSa09(aBoi{bK?-C$ecQpT8WAW*7n+ekrT!-Ha5mC zEKFV5dYUzD8##R&Bp@F@f7km5CMoaU;Q^rI=HapWU7{04|0U^;AI9MI*>d!SS)nME z7$$@LZfHk`;#ZS;7rjkJ;hqCb`wa_-<<300z=I#RpH6va&dqA9j+N>2@$o4FZh7%8 zSm?XUPX@3ZfS$)hIf)8GfSiu~S+O$*x)Bx;f#)<;)rk(!aCUZ{`tHmOxKr4&3$Nv5 z!lbXipM$H0T{&tCSc9%NDgD-cgM(|vDAz9;$Mx-3o2x$|X^g;0u~Ji0^WDGSDNxyBRW0^=bhOI<2%g>8i!iLTy1qQOb9LqIBvi7p z;xs%P9Mo3YRQz95tSm3TF>Ce#!kn?|CZq2(*DwP2afUVfJYY=4Uz)FL`S?-kmmUi^ zKPf2<4UN*$(kk^wvBFW_yAw)9BV@aBSDOkqoqtz*HB3o`>_@q4llU9+UE9v124mQX zfzB+xJ+`hU%&Vk ztcD|JZOs~M=FSh-!!;pW)XVR~d?!N#6IkV#z}jF?5=kdF|DLeUI1$9LCz3iIiFHSA>py9oX1|m7 z_xIBoC5yieP}9|Y?b9g>g@DLbZ5K3ax&xS3k3W6R-CJh9DmR+jnhA^3)h_cgXnijh zdLq*EWq|cPMsn z+S%FJ62QOZBuUeY3F2v+Wy$vQM4k7oDJL=$VVGv>4$1$`;z#J?%Y*JYcZOHpZzuEe zSkY1y6%_`<87aA6#~tcWV{f*9fA)0cLW+XX)^7+M8(3u^Hhgp(ZfYxg8pEI@3F7t!c`pCoIlstRkx=Gq!wqiGVbDIZvP6%^PK6BCJuh|XRJoG*2T z&-nu-=jH91e_*f5Np0u~aO)*9j`r;M_fy~$OWSTLD=Q%e26Vc4k7E-O$VM-2);2b< zk?}#?kq#smk4{zugw-DpfWpDaNo0Jy)*`8C)Aj2amLKd9IZ+ksoWXl;pFcxt*oLV9C+&V`1)*>h?w||Hcxn3+HDzG*^kf5 z^z`+^ToVRmg%f?MybcN}>*xVZFyki;e)U%F;P zQ_~8N)-C`F&tNchxL8aSxT}hZ3A14f=w0yLA;Cs7aC3TPQ1HMB1-@_e0@v8YBsDiT z5sWBmg|wP0l(LS6tH|`6HrIaN$ji%{J4f~P3C--(uTd=*CCl?~F?i_x8R+Ml zDyFs6-$EPb*X(S(fMG?-0$s-_DHMqR^4{KKaL`7j&9=j=0MpsU#c9DD?Ck6mb#%xn z?n=G%VG)hC|6Q_tu-xr))dI{S{mogg!XU*kg9^}I^PrO#zsdC>LAWH_F2*Drh)jrx zeu*|mD};fRPLM$Y6`A+@U25tZz#&}V)|D-XB%`CFf)1)U2V?qAr(3^IWUcI1x&8or zNI6@#iOPmh94k7e9x)TDT#x%bJ1e_%@JS_^7L)+;^MigMX81aP?)GbEi4nWIyMMwEDSp&rfAGM0O5CE( zAszL8K_}^E!=reG_|(ne$W`{iooyMTLPO zic+$&;y}Ob&GC1Az`H3K8NGG2wc_Hw9v)r5FS(>1Cdb9q_+2Y2E4v-8X%snDJLPU| z*`59S=Ya(LCG5}L+MS)M&fR639~8BCh4wXQ?n!$pAG_L{oIP*l1qJwKf0F6_seT>n zgn*g}d+$KAM;}W_&^7!1q5DQYEC(OXOJtGtf!zy9<9({8p+O8ZYfsmcmzS6O-aYqT zQE@2bDBj(-bFr5#BmqQcL_`Ek&w`{0;DTA)I_cdp-FD{Yta(AFMx(P7d6{4~ zbf8dAwTHAXc|#{AE~PdzqS=y0@CF00#gtH(75(E|^*W2EdCgwh_RY>Sp#xNGQd5x(3N{BGH4&mYfEh zGWGkZ0tyt2Oep_)TM0}M4(O4=q|SjB_!c%t2M4S7Ju_MPGTw3J7VUXDnIgp&<;9>+ zA>qt4+u|>ZsHi~48|vwGr01WV`E}YHEZ$saw1TdkAP-NJ2`G;WboBJS*zO9jIk3RM z<|jKQptiO9x4N%J6>P5m`lxbM!fW+y{o6B8pPoH`9tK)uKr9Q(%81L$%Ym7R1Z}j8 z48z4oVq$lMg@r*|>>RmZ^kWG?KyRj~t)8)Q94HWC5)y^LVgHqiD|; zxrmPwb1#Jo>gs3#)C)0?flgIzqb2a9=79PNDk>;IGuX_`?3Y6wXrx8O$CJ*@%`Jgm zTxci`xJTc*M|1E*e*#e$dyHjt8vp?%s_vm19H-^A{Tm0N5^Pso# B#tHxc literal 0 HcmV?d00001