From 65c2c544e53598d2bb7cf62bd31cb5a86d2eda5a Mon Sep 17 00:00:00 2001 From: royrusso Date: Thu, 26 Sep 2019 15:00:28 -0400 Subject: [PATCH 1/4] - updates to docs and readme --- README.md | 20 +-- docs/.buildinfo | 2 +- docs/.doctrees/environment.pickle | Bin 32780 -> 33624 bytes docs/.doctrees/index.doctree | Bin 8623 -> 8623 bytes docs/.doctrees/installation.doctree | Bin 74656 -> 77260 bytes docs/.doctrees/rest-api.doctree | Bin 160815 -> 160815 bytes docs/_sources/index.txt | 2 +- docs/_sources/installation.txt | 70 +++++--- docs/developer-guide.html | 29 +++- docs/faq.html | 6 +- docs/genindex.html | 6 +- docs/http-routingtable.html | 6 +- docs/index.html | 122 +------------ docs/installation.html | 109 ++++++++---- docs/objects.inv | Bin 962 -> 994 bytes docs/rest-api.html | 238 +++++++++++++++----------- docs/search.html | 6 +- docs/searchindex.js | 2 +- docs/source/_templates/globaltoc.html | 14 ++ docs/source/conf.py | 130 +++++++------- docs/source/installation.rst | 70 +++++--- sphinx-requirements.txt | 2 +- 22 files changed, 431 insertions(+), 403 deletions(-) create mode 100644 docs/source/_templates/globaltoc.html diff --git a/README.md b/README.md index 4f2c8a7b..d53dfb9e 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,16 @@ Simplified Monitoring and Management for ElasticSearch clusters. * Active project used by Fortune 100 companies around the world. * Free and (Real) Open Source. ;-) -## Installation +## Quickstart: Docker + +We are hosted on Dockerhub: [ElasticHQ on Dockerhub](https://hub.docker.com/r/elastichq/elasticsearch-hq/) + +1. ``docker run -p 5000:5000 elastichq/elasticsearch-hq`` +2. Access HQ with: `` http://localhost:5000 `` + +For further instructions on docker commands and configuration, please see relevant documentation: [Docker Images](http://docs.elastichq.org/installation.html#docker-images). + +## Source Installation ### Requirements @@ -44,15 +53,6 @@ For **full** installation and configuration instructions, see [Getting Started]( For further installation and configuration help, please read the docs: [ElasticHQ Documentation](http://docs.elastichq.org) -## Docker Installation - -We are hosted on Dockerhub: [ElasticHQ on Dockerhub](https://hub.docker.com/r/elastichq/elasticsearch-hq/) - -1. ``docker run -p 5000:5000 elastichq/elasticsearch-hq`` -2. Access HQ with: `` http://localhost:5000 `` - -For further instructions, please see relevant documentation: [Docker Images](http://docs.elastichq.org/installation.html#docker-images). - ## OpenShift Installation Please see relevant documentation: [ElasticHQ on OpenShift](openshift/README.md). diff --git a/docs/.buildinfo b/docs/.buildinfo index de623a26..843757ed 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 7941a7fdcaed6c9c9192da5b0438d143 +config: d95de450ee0c2c25942b746b3626a6b0 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle index b554b675fc9fa35a1d50c6b68d03490bb756c8d9..dab97a47326290f25d4c06761a08b4476e14c503 100644 GIT binary patch literal 33624 zcmdsAeUKbSb(eLg`~H-zj}Y5gvjimY-paP(7zYO=>uia$&Zj%crYg8Lv%7OQbK2cm z&4+YHObTQn`&5&{DVC5BQV@sD4W}wlQbc&f2b1tC}^x z5zZVA>`Hl_B)zS%|ILjzHui;MWvAr3rdhV#MtD>HlxMnL-gP$J!1J7Z**u#!D~9LW zCC@b6l9fApB9Aw`{G5ExYlK6dTjH-D(0|=?0=H!1-I7yVwbvTqq|`fl9=cs*#EOnO zXHD0&%ccjt!yTUK2ld8cIA(76X3evmn%B4w<%!F`;m;X???BB)cx40%5=)Gau?E>R z^{j24D>-GP?iIAq!*}iCoaOuVvQsteS|hwVnZ?+%?73ASbh;5{x@Dhn%~gn83*PXC zidhhp1>Z8O5IJg8j3Pib-G&)X`DV3VF?`c2)D7Q4p~A63oYpXa6vwXM1*@y}2Fo9u zb3Gq9V^z+iz{|YDu9eM=MmSt|oprMWD;S*@HF@*|{w_K7P1jztkUo9mfg5hQK0|Vc z0TF`~^}{s*(XeY)Ov5u9*8Xs$V${|GhT&p3V{VixLD^)=q5!-W!o5bhTv!ciB_B+X zC<+zMys=m3#EY~Y|{$_=li2w|`T7I=6 zaEsx2U8~v6)i+`Od07ZAZ=EUJG_y!qfO59V%Ygd?bavk=Not{F6NMUW)>i_;R{6rc)=aEzx?Ig z`ll++nv?V46ENH=xJ|89oT5?jol=w_{J7|Bhy>FMXBnwwR_X<&1*;R-hxB^u40tdb z*eIa>d7UtM(;^9m7Kk*so|O$JX+HGApoa(+NDLNl*;0k_LpA3kU~go2$MR z?o6atnRz$1!U3bs;?W2KlaDu~U6|FPSr%68S*GcOa963~7^e#+VoId|XK+nVc*aEC z6jdM$A;V&ecWXX>?%X+8G_%?{$6ezw8I)eW5l*0^hF8)ev(T z{`U%^6+sgR{So#u3nV~xpa7i1?d+cs)JL@r$&I%)!dJY0-@YUBhfm#k|FOk8?!N!t zL(7ZD7Vo@&etG%s<@;CW@0nko-=F`L1G$6uy?%dVA#<^@+(6}CgXmr@tU8Wgb9@u5 zS4~8z5(~`+8m6sqdJPo`N8+Lk#LtIq@7e=aj?^crtP9GFIfX;z%N z>E_k~_$R6e*!Tu4OW6IussWFRV)F><-p?6zyYX;10wTeP1(Y^McOLr3(xHz$a?lMq z3-S2=m;Png=k=364#J7DSvS!t)Jir$hZySuQ~Fv| z4U05+ySkQVEnT5(cvjId-11xB`E{RaMDF}80CUdIcID#Y{QYN=^JIkH@M;ty|H0!;dcqY3;3OXBf{noH&szG zG$JfUz{b4D$ae5-n2hZDjJn1-*$=U93r9*8`be+=1Rm=>;owQsJu|PVI}kUHMAhmw z-qPS5C+m^6oN!3AbPel$K@m*{8btIU0<`2z<#50*v!E6Zm(UC|kH_CTL<@+&M#@3G z`A|fw1e0VmK{)IiYa%Mk5(GtS%X+UUh4qMaoArLE{K0VGjzcGidi>FP)OrHSSbxH5 z`@W&KFWRcWf7$;C3W| z+^uXTtyFoaJR$3Y_3~;;{R4OJyt&P52WV3N?zb71J z83lA(Rqj4N;&;4MV!N`@pS@z+ zwit{QQ)3R!dWdN09}0&cC~)nD^$`4|RzkmzTex)_43cUAz7q<*?2VMt;mslb=K41L zFX=4%)_1g}t&g`S&9o)K%_cB15su9o(HMi4bcnwZZ}$pFIGL3r5ri^`Lt)pi17EPu zE7&vAeS-9QH7T_xFyGJLNP%geHcq?ZpqZf~&n93U2q67lg}yqb6znifjaS@DUDgTzD*FMXgL zi}+$dEk!1v><=nb(<=K=mVMw!SjGhfUsB{ZYmiFI_;n3Z>5>A-7sw@d$1M-SCI4tD zzC|?~o=y~~g2xqw(yD?z&31=zTk^#hX z3O%)em=Hj)uagi)Q23#OJ3-+G8l=)#{!0MXLnm)0GLy_ve7s~c3r&RD^8iz3pbveK z*=%GgIZKKqSY4wKL9lv}25ADT?h#A|J7I_2NmcHu-TxRr=6L~T^9~1?foX!DNCxgp zijr!Yr_F_7ECOK!^5Y8b1oGEvkS4(Cj-!NJeE8~4D!E>v(T8VT**E8uSd!B6>vx2b zAFQpv$Sq;(zdfh!#I4e$F+qSxfN)sB zoq+Ia4N~b+uhJlujw+zla@3#YTvH&|H^PbA#p;z-3rwa1^*~VqEz~g$CB(Jao~vL_ zV0T2R+viZy+)>;3;sW2rW=iAWgZVfK5KjjXzopRhCj^2|%(BwS`M9?!*b^Wg)*zMk z_ZtGU9-7&y2nUQwDrno92({(_qfaO_)52&vHWrLWm`H-s;|c);rN=Z#`-akVgwje- zts3qofvGJEIDJE*n-)%p>C&k@DU<;9ltKal>PZdKz5z8E1BGEZov&=k07%<+^xpJ` zQ%#V#KmyV88s(NV;LmB0CLrn_#%0780j)c!Bm(gp`+@ivzL=KH zwm_d(@FoU%Jts}+Wb_p1Ct3NuOuK`&WB`X1g|1reImL1Caw*Qaq~K4mIIck|ZRE8A zwjN@=u!dt;Axq*HNdz?K6#8gEBTa-Y#ihaBSMVmVoY5fd8!Y3}au7fg{ZpC@Xnt3r zlNK}+k=1ZvBwGEpf;$1{?HZ&BaJq*e8Lfm@b|>v$v>H3c_8+u{E1C+#zo;mv7UJVr z6aZ0e0qgS$<^=H1aMFGUtYJW4mlAUZaS{su9ff{cg&$#s=R%07eOtkql>FZ`NTpGH zOMuivc$$`gq{Q&HEC4h!)QA4VOaxF`9G_H3AV7_2koFCzaR3G9Vbd&$fJKu5&_RVx zS{5`R-G@!HBnH$sD7X`F<}^tA2F|2F;dTcd^%`BD+mZo*UZ>DY3!o_p5LVD~fyB{H zDfknJmNiKG2GN8x6bozksR1R^0nq<+W7|j4ViqBlv78*b{utYLNB~AL(C*Dz-u4 zNhAZE_b7DILMQSsg9{_z{GNh40q30>qEc-gdBgeJZ0I0>*kqtHbQmJv+r3LylLrxlzDApfF4ngFDG&ro(E zMNg?aspQ&+A@BGR8+%_IzW+@wJ&P3M3HsWeCd`3q%`dsk{k9lMo% zFY{6?3aUHUM2zjFi9UX38q|udD4ABR?8$nO8dxSolpt2Sst`mfro>58thT4mH4`1+ zNu~pmOA1Z3Aelt8Ob6mY1$zR-1r1VZp>GzL^)MJ3jZKL}Hj)TrKBUk`3z@N|vCwZd zf2`n5VEKRsX#$q+-Y6YcSY3D0{u zPTFrj97W07*6Wc(l>T{zj#{N3W2J9jtM{COH!1%QHAtmJ{6Ij}i~9kVWry$1ZO(`> zSY#q#$&U1)Tft#*g&#`Sv4ImAFhBm<=kXs71~B-MGGH~xj%~pq6hoF>#(53c zFg+=G%7m?Oq!!?85f>ZO7q*3CVsE)qt86y57-o+^0#415r!3vtdO{9%#&$T@NxYKh z15bXeP&inzYi46%2-W{ya1Dw*8QRF*I2(eUwnPFNfJEiD4lm zJLQRsVQ5HW`+|ZsF}BZ%lJDDDn;e%aCIZF{PyV6B0A5hn@^*lQ+BPICu6b#x9 z)QD@{`aV#(R{?ao51jAZ+MHA{B$a%Elcp57r!n#DiNG$M&Y?T*`k6cV2|;m@!<0;b za8{wS4hZ4S>=`Z?-E-HMM-vg__Y^V+E_Dr3X{l8KVGq&Z%4jz!Ta+z#`;w@cnhnU_ zsnAgiva8~qrA)Zo+e<^}I}}m~XblZg6=?c>xhv%seX&P+Mf3rhW|o=_)Sgf%sfk*& zL7(r4mK_jcYJaYfLQwlSC+)Wj;`0-H!Ifv(HDO7n1CM`FXsU$=`z%Go5g@*;^8N}mKGJ({<*yXg!$vBM=6lXNy3}Ezbg<_f*Vb=~3NG$VR z3jPG6-{GX14WWKNVUJuvlVJn=%o5Ip!x4+gP0Jlg0MK743ZMnhUhL-Kt7>vg37p0o zD?y<8q(Tyb>Jy!yN*SkUPr#1MZx}d}*`y=(W*VUQrb0n2DDYKOh@qbJ4FzXX^rtjP zr6)b9Cgt%fxwEkX z#1f|za!7TIbJ7&2O~I&tmUyE=K`l!h%-ZFfs1@cFTuHI7*C3TvxL-}mtxzD@n-yv! zJdD;8%_lvTCr*N)6%{&b;X9H=i^+u$(<&%96O3Q4K`Jrs=$6`mTp4ZR#8z!S3}0Ef zi*znhvjNmag^pT4VfBgJ^olLod>HO|6>69dD5Mb3-lRd=H_%3o;Gkl5nmR$MnFe_N zNTH1uJfm559x@k04CxOQtO+K6ph4Oasgd_s@A1lhJh5J}G zhy@Wt{XYe70`>oJ(v-%ur?0V7cVP#k=V$Jbw_P+rXw3l;OyP_}Wb`6Kw z;=CDVb@w#hy;)00`YbcC4~25N~W|?J!jr*irZSafu{V#hHS3t76-MHnxtCr;Tqpdg&aQp*C?AL1@Cv1pRrF7(jC zjJ35eU|m|c*1E7TXq{iUCctfmpu|ODVzDB--9{u~PJ|@Q$fcXONDL?9h$|kg3s{Mn zx^U79XZXs>g74toE`AXJyI_ga;-V_+!oz&2rTmjExRiggWtZa5Ae>|?EWv?ae#tMG znvE7zCQ@-fCc6@gIhVM_$@9znk8$*B*P3?#hQm&gU9-rGh+7kjW<^~4G_q#mKyeIaUI^KyoL-(;f`aR&qdro zwf+TUuYVE$yafwVix0Bco7{BM%ZNZWx{Ak z+>X~+|0)s_Z;!9=J3uk`!_|+?m%m0{o)l-`XY4A!!_PV&%9NZ;2~!vCK>ukRKQI_a`&y7A1YCB;pK)yqAEq?I^v3-`TpfnHm9Qo_ zHb!oN(hM&)*8dI_xBmCMmhr@@Th=+A{+T78U;iflho^rPPfv@dXT;OD#nX4h(|5(w ze~7356i?q5PyfxIaFbc|*<)c_5N@w;a<}~yG7%Pr#hswcY1Rj(wryi1SCj}voH|g# zO^a~&aNNZJt>A4|iw>^3jBb7v4(rV^s&HsUE;@gU;dt4^m2I+{z8DU}#Q9}ai|pPtEQ|aY(Rlkh_xg2FsHV#7f>suz zTG9vEN#DFI!z7dpvSXZ)8V+Jd8-FjnK98m6d3juzm*2-O5UH)*DiipXqxdRz~`vq|V0AchB4MvyuQnZ;{svLv^i0r)TC%Me1ZsRfuRifk=hn6arC+tN) z=-EkhqE+ltUA5-%qE`#|$@Pf@V?+8smZ^d;ynaL7UVolcmh#eX$+#JmttK*khwYYi|$7RP7#A7TV6fw5D19fK+ zggf}m59>D#m2r0;+A7vb)N2uc(w@^#uk!*&-(^=|vp#tQ3+s!P9NuBaMdvlvagX}8 zxD~r(!}w6UeC#`cN;EeT9|mw4?iPNR@WY_qI?paOo{~d>l4aD`ZSSnsq9Niqxgop} z&fI}*l&r&js%D=#VxxP@JM(XC6wwv0h&`6;@5YD$cf7L1QPzFO71n&fjxmC{%KE+R oDsLuax`0Kib!@^Z;0uI<%fxZD^lX8B?!~R>W}!I<35s+759^HQE&u=k literal 32780 zcmdsAeQ+d4bw67=Y4t6gt-B)_*T4o_hgq#{jANW~;La!e6#3+{ba$ozXEWLzX-2oZ zvo{|n$!7sR2t`PsT;&S?gd#Y< z{+QV}`_;{9i$8GHo;BTX-h2J)*RS8qbiaOQ|9dZa=Pv$Vw8yX6PIYtEs-AH?w_35P zK|Pv06guV794UHF{lNY8?fOhKTyl$nXIUl3t4FWPpYScu&wK8c7y7=NFIi{uR@w9e zr|4UzSG03S?#km1KR+w)^Xt)o?-lv&*XrNyyP;RKaBtDAt~zV=XiVxIUk}_WDiTG9 z+%uNvIVH=7-qCK~3c^}_F&efu1FPygZq={fgZ3ot-wbBWFmRz}J-RFg1%*Y%$6SMK zT6)H@Hi~WurTYaf^awm>W!4UYTFI@LPPHCgk*;FwS@rBH5IR+ljBeGZJ!=&r*TQ@6 zEn5XaSqN;aV%6tH8Zf$tZ2B9l+{gO#nCJH;p(ch z$?E%OJwHIraD_7|@K*13swHc)9u3w!cik$&4ujS+ANmClEsuo19(3~`^{3Ruo_m2 z0hpl1gB{wIkIs8Inq+kqw-f@1s#)P>qrUBK6o9DhdW>egwzbA=*Dv_NR+$-!fDF3Y zL8UB^OW=8Pv*FFwwlDzlvJrmXK3#a-?2WV6=F84XzP1G^Rb1zNC$Mrgvv>+E@$>Ea z29P%7v7Xw~xGcCe);ea7Gts0387(@)TUEDT9qnIp-8Hn*teWL5HiimjvFL_uNRFL2 zn7iTHn||fS8{Tk3?z(!ELHApQ&@0!YUG*@Um+wr|Z!;>$J@RI*fzJM$CjLf@OrF45P))Mq|lcv$&%k?MsZnI4nt_12cr7C3nkM zVr~JwQ8BBbS*|mi8^YgE5eTvYXlLz1_K|z)_Pn`p39Ft0Tc^6}GMl858JRtAABt`` z3V7Dgglb@z)sj(ht4`p0PIb*#b-maqh5IpJX>63h>x>@(Q!Z`h}>^tT7jofiDSghwMnJvSO8l+4;6*1t6R*mR<8y!Gaqo z7ht`f}$T!K%VHK|^#x7_8=Q%K6M?jswxa31DBF0IC8#_xKp*ez=k@ z9k$JKP$*kxta5!}ceHoa!7WY|o}Ld*n9oYtDq+y|Va(L+zG!^I^r{R(A2WklsYg>{ z@XdySQ=YBDO)~uN7DUT}Ch^l5b~79KK(?;{oTE$GKN<8#r3T6M_tc|n-ZnFHc<#`N z+wYrSyzS2W?moD*IKO!NeRE4ocP`zxJa=+#Y3@M&t=HymxaVyL>I=sC`cfU8`wBSZ zN@3M?gQ^=?V7+R=trVFzH8Gc5h$hz1k(dv-C=(9v;V>F1H1x4&7OszmS1|xf%o_dr zyD@MlFvnSCw`O^{wGh(_x(L_=CM-+Xec!5y5fwYr4EjFEnKh^WSd;;gV8lECr@Q^& zKcBel@qr63iyDNY?DU8Cw#q`)Z~l1Csq))O;xn)es0ms#{AgGcJpeOjEq)>Jaa>a4)!fkrf4Iqfepa%*zb$_kE8FI zdG+0P@UHrUbspf@9}<_*fS82p_T%9SygKG8Oz$BkS?<33oDy?i(O?lXBpciKd$*XJ z@K>f3)*2Tpm@r^`j3$f*19MIIU#V-jVxO}=AoR6AWZzp3PVeOfP`bYv|Nc1zmm^ z>tcTg{qSA5VZFNnbq0d@CFt3$)BN&#c)kw?XJo z;xSumpJ*C1_Q&ie*C#L8wJSlOja9Po&mukq0uM(6;2wHT-M$}#t6D@H$A^V|3v8E) z2Hz0{Uv@{ECgINA{7(C&^zfQl??-vMY<;-3XriSE19RkvyJ3`EV}5pamY74T7?Q8! zk~@!39W0`uETY_8$;~-zM6Vm*3D&a;){OLOL3)jvl-drM&+t2T0?@t_J{vKOxNyS> z>@-*%Nua<e;<7>v0r8jy>7AfS(6hSv<@8v_J;Fx2-m@;* z@6yoZUQPpt(q!~)x^za{=o>Rn;sEV0K=;QK3bpU7bFCvjw(Un13`w^;Oj0YGt_tMF+r3%geq(WPr=0}rRJb6f=EKu~RnSMecf#C5}TRhryyLPXS zG|-?(q>6#U^9micP#7gBq!4&c!JQ!RtOltZNnh3=Wg`jA6S!)P&yRAhZ6MdTz|mX9 z6Kk{irOTn#u1hawvP}=YXe=uqkXsDz|1lP>XLXw()La9M<`kM~jn9e1 zQfwiTpmazffS~k74bq;WG!dh;99Al(w?$xTsRB-pLN_g(;LXJV&iPU(0cuqtfdEz1 zAnh4YV+l}rOJEV0nkoR&qYAyWKpJm=#03(F9#QZo5Iv+pnu4gi50~y%bjy3ywQV7I9uV|(g;=@_?=-1-qpHc88Xg|$Kd+O!KSmS-8b#yjW0EBNU6x9M@ zoP*%E8=2ow@Fzh0iw3DQkbmT)J8|^F6z1_hoQz6R2xup>tO?Ss8|r{U*I8f}$P zz)v(tdj`vhv>bSkRAfqv0nJstfMztd8ZL~us;q)Lu^B^yGzCs~|07+M7?Rydd*`Z# z=h^4MW?w~1f%r*9L$$`~NS1$zZ1Gmh3g!gxW1O_7-f9r-cZzt`+XzRKBD8!%p`2FB zGpyxY2(hz3!I?Dsv<9iPh$<)DiEo;afV6SoEmZ*M0}9==0Gf;eYUjj%Um<}2^KNNat0W>ZF!YgntkPNhMDfknJ{!N3lXAq4_L$UF>j=G<8IRF~$??EUq7F&=I zNAT%auqXIjqCwg-eB}5#SawVbPpTN`T%*uQ%Y5STWpZHzoEZgo0?w;7NP7m397ad6 zb^&k1$>h~k0f6pQ=%ocvJiaPYAc5!(1%Cq3yas8{AR1h<9KQ64%HdFj#tnZHssOxoXz1j4<$xtBfV9=3;dpmXW0b{LVD!l^-curqwI^vVN>a&Z9~Y zlYLPkh;+;goV3|wclIv612&_na^Nw&yC=~{ClvN5*b@{cG)Sd+j&jnSjOn4oj)+eq zg+S&F3VpOJWw>D}^cBsG3f=^k*J+TZVCg;-<){@V*PXO?bI9P4yP97?Bt<~lQ8ZBt z=}gu>-SYBbRl%9yT;!xZ9fU(@HhX@=%GE}YLJHCJM-&QbHGP;hojp535NnbA4)&0O zH);I4G)Sd6+|NmOH1+_?lFL`+rD2hUfaOmW`sl;r2|)ywk1Kc+Sf11%?HMeCbIS%> zKS*pPDFP&4Q|O`vNhWLgn6dDAmH_hi3eE(OuV|2_0O{^wq%#sjuRCeV8FeR>T*Xq8 z?xd3ILmJ=B8CSkIvuW*0n~|WuaG-hdW-=b^ub|8K4UoC{t5}fuJbqup?;r5{C$?m@ z-O{`VS{LdxEzP@J!51CgVQJnJzq6-Kaun-T#46qNlWw{kXxyaGS_cibc7lrIrVYMe z|9S;`Mmj4zgYNN4EGFtefTrD}&{qq&z1hYZdTb#`_MH(3 z-=dI1AiSHCHXBkKfV5XvOf6dhR!FaeYewK2$Gwn#5^qxpT;8tGR|}UtS?nyym6+gM z;N}7*m|${NA%kGDsX=-YG|)U$leR2b6p%}Q*v6YMO(gqXm@D6n$kvn|^Q_#G*i}a3 zpy~DmXxt|ijnnFuz1fuz`v%y0(i#+y+uB5YbhQBS6AC$`Yo6ky&E~qJC$!7w#Ril- z$HBnHIpYM~H_*Nw@I0?jTMM3Pye~$?ST5%{OgV_pg<`?7MCUn$7=q5T8l=*)zRXE? zGS2rUc4HccvCxcf@L+q_8lJEt3DEnILRT&H_BV{n%$2AT3>69Biwa2uz!x+~dj{YY z$FMDd4NTL(wiaX6b1Q5Y;3>;H60Q&wyVC*6{ewFXPoh_3YeJoznS(kxrVbX*Gj(jJ zL-3qdh$DFJ(I8FX+1)EXf$l+jg%jvbs&b&()7jWkSY_MujN^#bso!j>fL=!wt<^H= z@vJ8V=CE5zeuR{UJg4AKfIp-`s)Fceh@P>j6dP1IM1YFe?s!uTP%0}_(?V$?i_eb` z$w6WwiG4Z>0R*O1PTD-3?8GbXUc|mXY9_J(4S!UjmsZ0Eu%3nqAnkob!I!l6Aq`S# z7Vpv^mE%#M_;VVMdy{DgzLIZo7CT29vrZ=pbiwBpjne9ZeT_*6{*kCa`s5jfAkrsK zYmoMEs2(|f{1{%?`!(#PPZ{cXQw`wywn8;6xF)h}*EM_DAw?3HzNrvEVEP6pZ62yS ziu^`+i(6g{riy{WrI{W~ucHD5@^Vl*^_TP^_=yIow3Pqlq&snBld+8$SS4R#NdOun zthEj>UDXSirtqOx*hvm6<+)g5E?I>LVlIXTX$q_E?n`<)VT9dDRby2<@)()-{ScWl z4uwdT&;UPG4BSsDTBkr>n;l7;p`suEblhQ`^qT!G^whg4KyCIox9_R#*4K#Z<9G)OhLM6H>zpA$dV!NR zw|ZthgKBK67io!FcPjHO^6gYjHu!HxgUBVqzx>`)pIL0m=Ww27{J@YFNgUW!O9lv5 z$g??|M>d{Ond5+E&EOeM);|r!*FVGld4~P-Is9WG*MYf-Tn*T}^Xo6+KO_<`d3G4E z>R&6nD@ac3>lBXZowqR`;w^{hE22;A3G{30= z7`&)ZRA-Fg<@70QE4L~Ia(5_kctOFQ;P3+t(mpXbzt2hA7>D*;F?dX7ok~1TloSD# z=^+xrT&!hevTkZj4@js%lA{k#xEJKY-*d3Y6OqfU}(^nY$GXNe>_Aq&*$_Q+I_<@l*~$ zx)&I?^OQkJd!sg$KwwLuunq#zp6qEZ7y-K%$XrFl?9V7<5Kw##QfZ?#PTIx~=!YU$ z)eM#6bV?1V(&a$ug9^2@P-3f{i8un#`xWd7K)=UHdulaUU4`!RWIi^6LaH1nd_ke6 zCJG)EM^N~zf;~auGa97QOg_a)+n9;=bTK8Zq>*QYOsZ`vfz)>t`e`AxC$^VHZV@`W z{<}g3f$Lv2NP7m?n0PI3%vX5gy@owCRRE@e;ftAR)9yDK&x#lCIY$U27S*TVPaxW* zLE1BjMmv06OqT?5u)6L48w$RHEJyBK;^~3~POm2sreb-<>yA z0HY@qifLkm)jmWZvCI!E_!EpC=cGLi6!yuTa|U}-H;y5p8?q>-Uv_pR0XTo7P+kk1 z{a6acchlvV63CF7C_!NQONAr?)8{ovr71nbNp})SOp`TG#!1t2Sb9_Xy0QZS!23^y zo?77T&5|`xxig6Z1iJ4kp2zsYANK@!_jkS18CMMIabjp}aKj0WTQA4Iw zo>jZ?^h64Q`^OY*)WUr@8zzE?q5hGAH-Y*OIcZOWjPW~=7s?NelQPSH1A*om!0>kp zRkdK4$g=$N`066_Pg6(sC4~Tj#b0ZXO0)YSC*4UT@v6i`jH6B!S(aIP`eSBLv<=w` z8dm5~1I-^QTA+nywqaDc3R5iy)exsawHRRW%~U>v{+B{1LHK(bq$z~E4p=_0g#mY^ zQx0tHhpp*&b(~Yh`eK|i!Lxsosi*@1y5@?}9>h0$lhtxg73+%=1<2TcnL-ZfjlCMA zvNwA05H@ifd!kshY$I2EIu2~90$y)YD5qu0li8q2C_(BLg#?1s&78ESUh)dLs~bod zaV&;JvN(o@9a7Tpnce9Cl&NTj7ErHp!D z{OO)I=Z+zFzA=xi;h1~*@d^zT+tmWQ2NfD>VRu<}6W$SDZP>1;STsTGoI(ge>>V1U zJwt5tBtEV)^TUG~wYYRSP~4S@w~gnHL_>QuD`073>KMOJC3pV@ZXg##`rGvhdZ`tB8(=mD6N2% zS~!nMEHC57c`WqV=N7KCA6S^Qw-@^DvkNZ|qj5%w!Tz9>!p$(E+cKiL8`@n;x~ zv9)O6z|Z{ShxAOvOV3iJI2Mo{E5rtuI3LFkO8k!zgtTjogU_NtcZHoT$D4?w;#RD( zI8Z0EW?_#CJAZDyir&R(J@E;DWw&Uu6Wyi?$33&^i({4$sc&v!vERB2VjL;9C697K zQM7xW^Er|54PGg@{-Gq9)~^gYixn#&lmNm{lxqb4phS7F-VzmZ0cwf zvp$m@hpP*$2hXlQg8$*_QE~NK;_A1>)$fR__lm3E6<6;QSMTRnINB+GRk5%uj4rKh z@zJ)9N{r?~aeg7Q_4OxF#7HhF5{jg>uZTnDFixWp4-ZuZf2*?M;*h`ioJujy{8>g7 z4J?b=88M8fDA4MrDtQ=H;X zsvJgraLc^w$GFV6Z<96&RpR0Vho&xOWm8%g!09?4c>B*05&!eF@RLE z)A#%WJH!(g)ur$cGBIl6f#h}5v~zLY)?lBEY~f23E|z43Y;|B_VAHgGiS8*!orpZb zp-J)@wx`Y~47U=3Mo|+QBZ8yIOBNfXD3n>b;=*e=C3^*ta7`)MC>1MK4#Zkxvcl21 ze6l)vkzI=u6_Gt6ksvM;0g>>r-3L&27GboTf3sn6(?AJ{P%u}qP*HD2{8=NXU);e9 z90QM?0n8%v7#0?bvNO(EVV_xL|Bqu^91C1@V0`FZ{@^-_PP8^tPxVNnbq>D=@WT_i zeU_c|IxZgwiZ)I^M*zlpO+NAA@up@w)lGgxay^>74ZFoy*nOhvoIdOzyyYSNyXz|m z$jf3Y+4|f#KeUn+4zVB}XZZ4`Z9FMht1RwiXBjgg69p{it6|eY0k02SoTiMkb*BpK RT`fDZULK{+)CpH+{~yXgl)nG~ diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree index e2af01967ba7eaa90c21917840be88d5bcd2546d..95839178c609cb0c441d96a934cb9c59879cb923 100644 GIT binary patch delta 31 mcmZ4Qyxw_3E0a)14{v5(a!zSVYDQ*CN^0Je&dt-AB;*0hpA0_$ delta 31 mcmZ4Qyxw_3E0a)X4{v5(a!zSVYDQ*CN^0Jej?L4VB;*0huna!{ diff --git a/docs/.doctrees/installation.doctree b/docs/.doctrees/installation.doctree index e4ea9531cb68feb890b8a180ab8ddcc61520c0a2..a8d1c2dc8a3e124832d91dc179b1eb354062cc99 100644 GIT binary patch delta 15007 zcmbt5d0bT0_uc2r@CHU0_CtRWGbUDmp!HO*;kxzsc~ z*{x4lXuZJ8BD}0hjt6JD^?`0d2{5_az=5ITY8w`m*VNeN)Yr|kO|4s4Kii=ve5q+? zjB`EQY3LmnS|yOP2sx`kATM;LI*Sox9eim?lALQG%hnTSg`~qQLpn4Wv*0;H1iWD! z&$a>c>jx8!`A~1lf^Ehg@SI7Eo>Au#?Fn<`3ln0yl$Amh^rK@I9k_=Z|;q;r?3h(vJjCA*$SG4%mR4s7Sm)EpHE9}`n znB_uSTqxYuFJ8_jlo%xw2W)WOZByT3fmcL)xn5mCuF9 z{u$PE!b)?dJ2NI&5IY6d+A@vQN`O7KR4L8?MSEhJA`8lE7Z=Pzmk4VMgU#}9B^f

pCM)pl} z=gkzSfjIU!QN~bG{TBim*&jL3Y6i6ZhorT<-cENrsB@1}EIRBPsY-!V@7HC9q6| z4J-s6OrK=#Y2*_2FamomEs%O-99+aoh!Id|u%;TM#|`cK^BFVe(sTvJA!MD&W;u}1 zZ&K6{K34ARLFuR`26Oz(RxOUq>XI6S)YrxHH8s{qfn=aSf<5;{CI6S$i9m+hen)6nr4GrxepEwiHFD=@pAT|?`%e<2sE;aLGX^DnIgTrChVA=0$lvi;X z;O)WjGABu$^Mh^K&Ihy=c&XjO9l8h>qg+HYG$+M4H)_l899hA${8DjA_kzRmQN~>e z&EUO4zFwhclE3v2Z_o_fSqh|36I9u3a;S-ia5zWUZnGGBBYH6P)kms4 zawB`&24pvOO1k}ME|AY@>yHmbi6OTZO19wC+s!EpIi=}1QBE6`7;Pa5G?AecQ`W7C z@m3#oGbn?x&*4yFvhj0-pTenPf&y!{f8-=$<*`jJ#zs$CGkt6^P?c0BRhnRb(oAWN z3DT2qk>?A+YLP^GAa%4wjPtmNjd@7FLX)$MTLh-3luD~i@LWoD_-ewa@ZL$1U|C8! zID3__^<1!7BMsUbS}lm?Bhi(9{BfETpf+V?dpjCo&sZFcghU($qKmaoz)vjFFG4t9g8O+#k|RMH$46lqEh1PmL@sz|(GHCfHUNlbO&EeUXNXd*l` zELWN%G$}#~6`YF8l{V|NohtvFZ>e-@Rn)lf2g2HQ##=0}8R zs|D5JNOh$z)$t>?&U`xrtk#jY~OvSHA;G;=tj^3)B=xMw4CsHfHi%KsoJuLr`xIz7`g z7Ns)EP&t0c)jr8!^uh{IzwcOTMkFA|6F`l^-Qk8EIdr7M@31v}^ zV!J{4R*Vo?TruYcCqn3iOm?+qgV?JX7n_$w)4Xjl5tdH)N~)Ckimao#7-b$uyin-h zod&d3S;@7u%av)B_z z+#P0ZoaQt^^TMREfY%674e}Y2`(q#>w6-?)$#C60HhG^$?yJdzFp_lS_QCj)5o{k3 zHC}~8_u^zCP~7j9dEB!pzst<5N;Ch$2COvu%y3JCyV7-hNgA(46F39tJcY-no`HFn#LTYlxDP2Gn8Guot0|3naYvPL^Bjkeo z63A=dLPOyt#`?qj1x8teg=NQ7qAmJFI5$*KkT_SF-g^>yWrBb{C&%OkQ_Fg>dcFL${?O*kFwRBss`YX? z^*SWY>SgyQ#{~RV5B$S=U7VMrODr5J4+-@0#hY-UJe}>=tFlk9 za-u5#(u?-0UX{42c=Kr?+SeZV6J5ePXFq7ZB7nQ^4-fpWdR1P%JXQ8r`nbgw0H-UH zSt49t=guo}P*j&`tU^_K(6AO+Q78!}0TEdp4x4v;76rhv#*u72gT(3__NiWvk2t4l)Z+uaV2Aa3JaEep z`Bx#>&u;L4cL`qBv{nwW@R+m0#l}n{QSS~3i{1V>e0h3=)kb?qN}dG<*Y;<9iKbS+ z<#JXv$SRA5wUEm|LEItt>aw2lR3TZ38{FO{`0l!$vLe8pZg7WQkqiq3mf4-ss3!-A z^|=Z&cRWnIzPr3qBUqun_uH_AEI~$JfCoz zgm@33cuBEz26R6Scs{h|qwc?9)s_wyTjK)#v$7num7`%T&L2htFTU zz*$#o%bI5^pFh8*YIga8s=C@v@af`EW*f4LAE5+L^<|--?)cNfPiR_|AZ)KxtoXZx zpLgkwYwC3Zieg~@^;4SEVxUnsNoB9TglzG12xGLCYajp4q?xTPvN~LV<0&(VozskD zyzMz*zFN5IDW)l#uu^I1R#nOR!1(&f1NC(X9?zAjI9l!bKH60oj_z{To`jDhcy5pY z-`D5kvO=TqFQJJI7W>EEez*zMU5eP=TeWg~=b<}04W%hmr}PgCrJ_?UO3ovBBs2A*jUPIckeiVXz?*_lnB{=R_W=kNC z68}Id#E87)7f6SinkEPSz9!3-x8-E8{%e+O1_pk?HQ`ZQ%d6{Iw>#vpARcBRP_$lruo9CX?75fB5w4837tiHk zXIA&(^A zu{B-xCVeLwR+C%5W71xk@4f#j2XGtm+IhW=H=$WEi8CX}UJ>D+*Qy->0qY+Pb5~^e z?z%Vm?7H=6KV=s(aqqhSqFr~Fh3~rGtVm%up^_=FU+7L98oh14w!Nfz7n7TD6s?~F z;dfrm*7CSf^GS1%{%#9YCn1BTTFgJL+xm}g|+KZpYTG(9-^Aoqx~9# z;OW($$_F&e2mdpNeW1rYAYfer_Nq07R-gJ~EuMu;Vn3jEeXJL~HM*}o@9yDDVph0e z?MlhtikDG+4RngH0g?M=J_WbEwJU~5tdTLY^AN%WzHwWn|F5VU(mv3y+I0N*&r)TnC-`H+O zQD$1{Bu&TJbLF?{Z*X4W;k!w zmR}xxgq?wn4{ept>M8vw1XX={7T(yngq`JTJdPAj3qGnE9cYnFBYbt(!gUB~>np_v za~*2hEY{dyFCDhEH@Af_b2g2}D7}Lz*i27hGd39B-~78=fD?Sxe)MpOGy*TdoQWx_ zNMZ`l|5<_OYMeTVU4RU6C2kjlHVsXNeUIcuRS*|EAX7^5+e9lLm5N{p+%ip?%ZZ!S zo7hSr$+JjcRxn)b-bJi` ze}4Ty)00N+q&5%PAVvOFR5()iRisW_)|Za$sUGq)A@>xL+xQa7JqcThRz*ENnke|u zr_Lz3TEJGhVdoI6zXw+T@iLC)1}N&+iz;5{ua_=9Ufz59O7DEz8Uk_K$FdDX)vTyN zvW`pgGD^LM#@$l4c%+U6>oaxoP9b@_8-6>%yCrW4(M!Hk%&GNLUWi&h$x!yJQ9IDU z7ZW6hT153080wJ*MntJS20nYXPCh00p2Ydg&{w^qf~p~CYu}DLUBWB20lvkG(ok3X zmnRB)IXQS|$9UiLvkg*rj$t!+5?Z}8m4(AId&TGZv7HucNT>)*^?vQG_J8lpU~)2z z#wdvhngqF(vgK{;X`r0al8)Xi-%aUYhsB!fP3hhCGacE?FdRqW$-SvW#drv*WnCTI&@3%aw<`@=dT>n+FwoNgx{N)^9cfHGf@x{x-*o!DoJPdm!B(g&_ zlj_kEXfF2)gXOPGWe4EsE7Roz1QnyatLb4piM{>UOO@UTt2g1^$33L3xvyZ^-b~}yi2J1ncZTF21`qBTBU{2$#BcXhu`pPB5Eq$>XbGd8 z$#@De@xu0Cl8NqsRn9-`-67?N@oUK|kpfN(Mv!>GYso+wpwlgS$%HUO<1{vN^fWL- z_xoF~1$<0(63)Fg+1JD;!2bFOyo{uK{_U^lvszg8Q3{y%Sy(j`e;nJMx9>EQmk2R$ zLMbv$=TV;Ou=Z(h7D(om!U9;}x%T(M0`HamLosWuJ=pn8-a4-0Iah$x7Dg4_AbLur zJ)7gt67dDke|c4P5jn5qMln$ng*fx}Jxtyygvfza@62GYARo+)svE?VGaLrL+XM37 zP4&Q5ygP>-CRn%2cA^Kr%9g6bAmw1Cd|IgdHG*WCe&pO>@4?DQuiKrU2nZ_;WU%JY zIJo1`KiJPi)19+_rJN2v}(nCOr1Rjnb@eNd7QWstAXY4~wN5e4B&^JcO5kfS{u+WyS&Gtzs-hr@xYzO~2R3fM=p{91GiI6kS8-sZx|YN~y+ z{g+StnEWOJ@uiM8NBLna!(c+vRw%dY~GB0M5~`ag9njc8c4-5>>L>7ffGoVX97PHdIM z0IvOgCzi3nf}bjE3grA8u07LC!SmYb>3+p#;+lYPBHIYz+q<3og0U@d;_F5>n`roJ z{K_KQSDxy{%w?P}y^eH$q~X_g`FEYy@FE=VKmos>L{=W_AM1{sJRNnLx+5`2u@?FscD*1qW6MJ9hE?41MjO5=OP z@T8z`R8IyIw_{Lo@h90o5{cj@;_72&nWiu?vG%*Sq?kx3{r*WgM$E^G`3RbiqBatZ z5L3q@AYnxh(^a?#mBX;+hcS6R3Is9j@}nmszLqPWk%hvaaC&pd_uQ_JCttr2a$(dwc=Lk`99+ z+gpEPOs>{w(aFjJRWWrDRC}Rg579%5;{>{pOZai+&n224ZDJNq{XEjwk1@iJ*Zz{n zHoLWq-Jr`|8@;tnf`h-@5$#pxJwp(DLui=?U;Hu;KKXSCYv*Dc`MPsm3}88aDI~?l z$oA)ci(&FxgoDKaLFGytBfJH^}_J{LSx%xNA| zmeOM)S787vlom(18Uxr+^J0N;6SqRj~$|f>)q~lmHd!$?icY9|H2Xe|G$;!RLh&@nN3xbtRWxY@Sji z98?16pm+?mvZ*zQTK(xK2gOxp(pV4{_{vgh@!MT~A?&$Pwkve{+{6`A&S6tINuWFM zluR*8_>)4dMEZ%wvlOK_jmboE61ALI11h&rYX^-zM6Gff+e59pv20K-P-_ykCeqI+ zvO_2>&ZCrF^QqOhiB=rXw)xcJ+4=!$Ev9L{LiwV+NMn3uUrA(k)9jx0{{Y3}?|^$R6!t=XSzb-X{Clxozy+F3rlQCe*>s4PsYl8){a_ z4t9lXVCVWbE2O(!A-(NfXZu2DPtuYC%Nf9<%9({B6+p2=e?cJrQs!3vpNOarXp~13 zf62N<;s3p^{Lw_QcZxr-79mAXoJB~{8(R@lxzyqzMQ=?-NYQydUm^T8f^rDgg=oD= zEqbOQB8zTJlsXD8-f~ilu3tp7H8xR`hZ`NHi*SpjnB(C_C%Gcr=wMZZ8=Y5(aHEq0 z5pMLwC&I0oLXd~sXo@)=Zj|UmxKW)WqK%3ainftgD7?wTjka~ZoN<%F77sVx;^9Vl zn1>r?I5gTd&PmRjo%PO*&h;HLqS-m-x*?XWmIg!v3+*NKjiv-G9kRGAu`D~G3=^4> zhe3n+%jfk*8RqqTL~{0UJ=c@1l%@&-lR1HCvRrwKvBq(OqXz$0sl`A+-l`NwyV~Md zc*0FOx;}SP^dv*jWtpxQV_8C|_Lw9wTf1}<6Fqbj-dAk3LY8VF3;C{VSqk_clBqgs z7i{Wj1zrp~T0$1om)ADTsjHt?HqX(}!2e*39>3>DyPip4Nv_a%HbPoO98($ou8VhV zjAy};s%l`6rYhHqqa^kli`J;Gsj98EiNE->CE_38=>OEl6@;XvEkcjYmmr(mnXKzS z@vKS0;lv6IA7b?1nFae^Wi0M8av@A()R-VLMQMrD^}i}5RzOkC$b``J085LhrbrscBEel&3TjsSS*^SK}@8LDCEPuZW zH%hqXl?6SGm25feHS~b@jiGEQT=t2R?9GsMEB<)|#s>6(DW+cVgfR`?GxRP0Yy3(!0xR-Gq8}z%o--xc^j6n^qxc>+Om5e0!w*V-g0;J3&A~k@t43 zHBxTF7E|Kc4E&9OT%Rz=HN~~gSAGfZq9CiUo!PzWr`UaxHCyc_yLV9wv~;UC_|;D- zg=2BUm>)ED>t>xz9rh4UXSnpW&$dUZ39u|S8e)2z;2-gdInL0j6XDyF?8)|&(Pn~S ztDxH0&17GN)Y&?9#9A_?GrsEO$zp*$y>p~I16=7HBj-_Hq&f<@QjHx=&7qv)K`mBt+M! zeoDE$3xz`zdf_RE?3>))J`33gMZIMl>8>XGE@WQhwD1kx!iPL9i~yhLp72}WVrh*5 z?(A12tuw%D{T`5?5sE#{0gC(kbfy>DfU8IoSd?Pyf)ZA7omY|%?v>s&z=)jbrniW6 z3apC`gST_$vcrfG>!ZFe5Z@BKU6FT>i#HO^+;Xe*odKc;%o0N za7Q8cx9;3CZ*7%=jc|8?O^!D5VTuCQI~q`Pe|n*79t?r$8O+T4Vj^V;6(?s~;xgk~ zgnsS((*=XGQ?sF}x~?3f5@zO>OCyYMBDY>1Nw8B;%ZUSLu>y{`WuigW%p3`WQc{gE zsOK=fD|Cp^%u|953gc`R`#IE5ok0XCqhpclA%o+T#6lswuOG}A6yJWVBWSD>PHR)b zbE>++%YGV>9z^+8*wa@rHxRsQK3HK>{3p^S8l3FDNd!oEr) zJeRO)!1MH^so3mOQ$DS{ro5`Gd}_;RhB5>#PEMBYlCBOWdDuy=FePHE!3bGLEwC@6 z4n}20$@_$aLr|SLfW5D~N%!DBIG$PWq8U3pm!0`D%^O*Fvwd7ZvP;0il#8a{I5<>9 zr^3Uj@$3)`{ArBjV}kDgvA~t+Zn_i`4D25R*EaY_p(ZHq5e=0w{_x?GVem*yqS;_V z14QyjMfBg`jUKPE-(Ysya4EwCd(&d&G@_uM@6xQ;LxvKiX6VH90(m4-@G$vT`dVom z=Th_-G0`-F$FdEQU>F-Qp*p6fzA8h@?lEQ6RduBmRpm7~dIq@xg>$`7D}+{eqqLY5 zQ-)I^uk4Z%*s!E$L`ez9Qx9Rx>#0h;54m7&(oh(llx>JqXM5;cFR-$lSTH`hM0(W3 zr`+R0-b(aka%XzbryKU8g$=zpmk2)hJeFiX*X&g>HLIoE9*tS8dr?cXw#39}OH8Rf z?s_k+MJ*%(R}i&blDDcmaNtL?=7{oH_mr2_6=SGEZ7+-W7F0{EGQy+1q7C+QY86}_ z6ASMTN|APAOe~9su7mx|JID^#1j%mgH@F{D-WApz6dve@GIyAG9Pb)(w{k*s9uu88 zqVv*(c$hzQfbX}|iK|u;W{Cqs2S^t^T>6~}GKUpP_y>Jt8i1^4O>j9Tfqeys`*(q> z!$$a;yE^{%6)cYxCHcrh8_8iqlwFuFgJR(r$Y z+h373q8e)wFiVA+p2LxD&WB5*^MiOeU@fAq7B*nkO0c~gzKx!=tfd78r{Ufi!bJ%c zdyPrSY8Od^+#}WgV5u`iowXPIa3&Vl60*cHHdXpWSTf1Yl4G8hjDY!Lzm~r7rb(k* zroKq^2X7eEKdCc4>9Yn2C?ZB;?=f$PA9pI0ysL)GojTQ$H3~Mc&jjJ)Z&3{5;h48$ zU zkB;~C#Qv<92=wfk2czy7A|V;-Yb-$2q1YP>V{bJ|gJdd;fKB>CUZC?A{<@Miy9-z# zIL9GpgU-nYLCoaT>qixdKudX4&7PdYMsVkUI60NIAv;!nt4!VJxcPq@S?7wRiRcxK zjG=`S!nCD!5(2stalAu?eb`YQ50dWmGavTEDTJYSE|*W~W}Uio0z2z&)+rf^@7f~a z9~#HIP{v^y1{G}zFe`lI{P7Q}5(r1;+;W|F*)V3VQPydp@$a+bL4q+CSaGVc7y$=B zR&iWFj(FWy;N1eB@8}8*#ToM7#QQs(P@eW;`!6@D7`EFIw%5dRv*&czVJk#t{pFbrI9pE5u&u>qT6Ku0 z{&zv_JsHy9If$-*p+KL8`cL8=x;hh3x-+(ZzvotEo=|75i(yvB47+D8Q(6SWau>r= z&Y);BdjdX{#NJ?P2iHb;2E;aB7*LxnZ5J?FR(hG^!v|9h(o4KUw_vlo1y3|ZDIW`k zK5{X9&@sasb+0Jj3x@M9hO?YOw_r0qmBi{Pb}7%dkBV&O59Xq1xcy##*;l-fc|J0U z2QPZ)!o-8;B4tCT<61Xq);ND{ty6Jq4$FL7>6@f(z-5w(@1Br6du%`VH4t~8g<7$s zZo>+8UW?kp59^P&aJ{Qlw~IH#j&ES=>LHc%v{`>fchB{w{@z8dBQ+z{8q_`2 zcn`L!VP>6kMV%pJx>nSG2=YgqxVN<2}RAeY`6;lD4F3hArW~ zaMwBcfp$Uso*xuEkd5U$0_*kIJ6v83TJyHMdi&h1`BQrQ-jC8FyXX#d-U)QJLm(iw_qMV-Oz%TMUkEs zeC7|YFX|_q7BHFxCk1{zT5y7Q=oWnJZULpot3shGE{0z_X2A3)hjivaWP$EYsYViD zhJq&NWce7GZ>ayS#TL&H>I0uGPGx-wM4uSFIQG4Wok_2C-P2IAd;G|E2vsIH$qPCp zpVV9~R|@j!PI9}u=4qWtb49B;_wcEpXn8%)5BCP$+!OmSKL51DKA0X9EwT6X!+mxH zjC#z+x0mav1dcu#4);Bl(mr=rw#(fcQAafjXPz^6@1xuu<%hYuJN)*Tm2F1#dH(Kt z#%=HP9NFgDJI!q^UABwKui{(u*degOB=#m*o1g`V=;`1L@YT+ID>M%W;JMCpc+#r0 zY-jRG9qqu12k_X#4NdfPfOb-#H8|1W!l?qc&K&os=-X^82}HjegwBWgrBh{)Ig^Yj`hA6Z}Zpq zDLs)1{evs-iZx5ZZl|X|oj>%1nJYsS?Q|6JXp{Ib>J=NnkCoP}t(K>e>_~O0up-va z)a2^FV_klrN3CCn#IWYRD2QI44%gNduzPjm_3*FJamljocI}$-fA99fG1~ zZHz&|dS|xz#eIN(;R9@5hHB_I-0?ooY+_yErDy&rcQb2qihvT_fx5x*XXi=X%oHMU z2@EWfdUYetkr6}M8?clc5c_;@HWrCRU3UNTe&&3X;%3Ck*2kX@VsbIPjZ}+}G!`}_ zDyGNrDc{Tk@#h!L%hPq;&TTGWbtK)Y&3Dm5Gc?C_=1&g@Fr8~`S}m~XIP}LyvM79QML6EzxLQ3bX`fRg8iK zqz2Dy>!K_a$}Ql^nVv@F=5xdK<$0bEA*ygJtCh8aVYQ3F!5Q?e>^$@oernWK+&R22 zR;#QvwU*pyYjB%qA+$db(qGM!4saYj6!r<>&!Dz@c!#d->+agdyjHDzBeea>#qc?2 z(6xQtL)+IxpH?4~VIS@LWT@V0RJ6Tc2`5ps8lgx$X+=W5SsVa=zw;g?B8U%qSP-wu zpXY-Pu}M~VVb?QKVh|oUN5j`iaR#-vx(fV~;{vV3AUuVQ|1VaS;DT@P*Zyl&s2loj0~X97S5#76a>@X>?bWoO5BWSUqv3~ zd~v%tpK}rzaa*hNX`53Yh}yTaTLgCC-j|=f{|hC%pS`aSf{5|fE^2qAX*QLWSJjo* z&^HKGJC3&piP0GIR##8OUJZgdZ{w3Q7))_c2(|nf!7F6dxF7aeas6 z9r&Tb!sGA*G*7bd1a>Wm=kY}chqEql_+XwKg%F5&2)ey9SF$3#>trm-!V9FM$Q|Lq z-S6Fj(qIeBd3S_7RA+zZ-3sY;5B8yg{X=9Q=)r#Uy=~HT3;z^zFBuT2)>-(c7<$5? zq^m6|5>R#a5jO93a%1l8a~oEDYA*c@#2>p!9Yk%a=_m@cy9DjL_5r+iXl#48ABNP! zLs%!VIky1 zf!sZq4^*_E#C+daVZre6r#5-4 zkYVFwbbo|i=YAz;yj)e= zqVf-wS@6cmEZ2w1GD77Wh0&ia4xcAv@Eahm50waf;j_C~83{Fi&4r3cK*pi4@YEdX z@nB%5Q>E3xkbXL!ZPIO3o)Sjj`)5yY!6F_3;Lm3f;c&GoSP%xd69(aYDWz^!QGQ#R2;P z!A=GPm4q|De8=}H_4Ch`twpe&x;NP9fY?hXB7HN@0RRD?&R# z>B&^%Wdyy#MbMp|UxRsai9UPDw>NU?@R8?cN&P+Gvs-tcTf^}C6=IlvM2wyxJUeLs zhtGfQd#4+~?(eFl5)Pm*C`BQyh2IZna*?j!vlkkrI!>Zj$)c-+eQXhz{2!D&*&jW>l{6!!zQ!087}vI*C{SwMrW#~PnN z%YQD?kGOy4eRRYf1`qyxtAWB6OrNK~#h)`7LjNj`ImWt0c2KBCWdGV)`oEW%9E)!e zoQE7sMMmdNAU2dIrr%LgP$(}xN`L!O9!w~>!XPEzMj5YCKg|369cf%B!Bu@LD5VOe*Q8I-;k8_-!O#B+L0GvScRr z#)@_9qP$Uuqm!7;?r@@~1GtSG&XO++IH4yWVn>6-3ObAL82LV;n?`wPpr?EC4U96A zqri*xWS{ExJD&4me&*wzhWk7Ad$ET-i?eS-9fbz=6Yl)c19}oViw|PNyaPz`ac*bZ z8%BnyiG}fTzviL|bkR60-fV{FniSx8)SG=K1%|m-IR5w)lN^_C5v;o1uKS)z>RJkj zBcYBjWfrHbSQOWZ|8tlW7TvR*3;dZLA}Oexx*yGUhR6|oz&8{kj#&yDC-n@YYQu3! zK?h}!Ew0E2ZS(VCgP4>X<{0D4T9i@3)Vwe%l7i_;UlenxJ;fg4X!K)a9kcw{UC2a{ zVaX3ClXPGl%7mb{Ab)mIlBSU0=ze{$u2i$>r!W3A8>W=j+FR8A*nULK!QXkjsCI2n z@*@Qx-=8>UnAt>gJM%*wN6l=cG@36_j#~nmRa(G}Og`r}3+8*;YGv*tAhShvM*Nk3&+92<}4~X@<~+JTZb<+a`yz?u_NM z&5dBUGv?QJFp_QZYOtTf>G0pkN53zw>tIPigzNht;yf1t1_ zt#9_ODy=N9m|9C0(bco4fch2v$aEjci+*D8$6l;{M3@wPgCn6 zw(6S|@@n1ed+@%!?pGW4sg3*7#@%V--n4ON+R&GHp2|Jh#JyqT`O(lzM z+}b9UEVXeXZQMXxy*-LdqA0QZstpt)_B0F-UurxkZfiazF17E+OU^t#=w7n=BApuZ z7LSw{=pBy~x|As*h3*B4NO^@?JW}X}orn}V$>%|iAGxuWjG?VI@Fou$`Yf$(K(DC0 z#lwd_aftAtvwjgi`PAa!L#MSOdg$m>L=WwmMfA`Kg@_*7<%#H_jhcv_2PlLrUS;@8 z`ALKiRV{q7Vda1=9zMLq!-p1TKKpQm!4}W>yv3u3awv};Oh4$f$@Ve!`|UOMwf5z0 z&&INgjAc4Ljc47%#sARIuFuA%>(_=wZ*==!=T;pLJ|fjh$59KjdPS3^rFd8 zWo7Bzt+b`Jhoe}!*^Gaji^OOvCc27nV3l1QE92Rt>=7N}VGc2dMxnIXIHUaD@)>wl zyxBle-=Z!+ux3+jb$v})d5b-{*)RhyIk${1bQ9!xn*qC=f=*c3BW#l{=t(ZfP9yu* z1y#BU`tyB-^5&qrn$oJ;Y1K8A#g*l?wfuj^&^2CeYNX>#4=lkaC9xrFudc>!QX|^2 zqz4PKc3@qsE>t%~1By#w`Rt?)bmHbflR5wjN@b(je|4ZAZw{n(0CX)Cmy`g<%oLW$ h{OHe(4g2}JFr!$qKuB;QL|@-ESkegy$Hp|4{D1Gp?hXI| diff --git a/docs/.doctrees/rest-api.doctree b/docs/.doctrees/rest-api.doctree index 97cba0b2960029ca17200613501647e29c82af10..4a8a8dcdfe18c368ef238efef310d3a5bf9f88e9 100644 GIT binary patch delta 16026 zcmbtbd0f@S+V2_Rz+nlF3M%KYBgkP#L`8NL+;UHEAqpkNJ>f2HZK8F}#9Rg(_tX|M zO+_lQuBGiRmEKBQ?oI9X+Tu!Gvul~}Gc&){1K9g{`=g(~-aoD1-mAgmhgf#_6^LsLj5|W;eHBGC+}R=AGO?nnVpc_6t;e+TS(SCJNYC4DtM#5# zT~#%ud~!t{JysD$?{{wVQpV9v2`A~$`{JlA@i5J+%w`wPfe#H&@}bKsopg115X<*~ zaC)KgWg3#wkFFXWZmqnn)^pNdE2<{a&7*_pvC*BV-4zKxQCnQJ^)gDU3~^oXq=WAa zZJh7Q1aEJP_++8YJ)`OHg#kclLuRz~Hu)Jxu6#GD<2g>}bam&C#KC|pzW1c3{uN8k zdeTlg5p;a&gODiboRTiqLTw8>SZg7x4hQqM;xy{Y@TcWzA@tJZA?#Rx;z7?(E`3!1*f$<^U^>WB66dum@l#oOkF};IrEgxDL z?^>ZUU^hxgXEN793+CDRzaEcQIDrWst4gm{Io;lz9XDPo~o0AJh=KmDT!`$bD%c+FQcIY2n77QTS za64@%(p>24rMWP2wHG*OV6`o1CDO*%)IC(!tP8J^!4JgWYuDczwx{qS3WglCpyBlfkTLjE3QrW<~r|1k8kNj zua&<=FD6984bG1qi1Q-9d9iXoh@_j|>;eANHY|!Bc-mWh?FZEeB>c;?!`{U1%|>KF zUq}*PPRlO`vml<2ZQcnnv@*UM6c{+r$jUJKReV3X;G}ObqTAG&I0t{@%3Mb$xEABT z=rE^){E8X`!XW;%jU;(&)6?KbD!mnbYv|hvL*W69?;LNgZ$vxSJa1Z_m;y@-zetIR zS$<=@QGgJIqau@1$t-UM*^u7&SW-QBKaIa)z->XwXtw7R1cEmmlhO#g@k2OGP51HV zvHQJ;7_|u*RCb^@SVeOwBz?e|7p>uAm6nHJ*WZ^dbTo45p-cf~C2 zB5Z*#1@DOMzFA{%WUWW#tXb3QTz|oTFLB+4|9_~C%PittOsHz)L~GM`z>g}URLRIS zbLx~o$B6ZCKuSOYicr(q^}9DKXhz5U!A-KNCSAif)iI4#8DT&otn7FwB;q8G7#Zyy zWfiuD;Y$=f-7}DcSXpTpM9^NDIet0(M+A#*E_7E-W(pK?8mr>1JS#hxO*+uanO@dB z9ErdbZKYdA4uCOySb)M>{!|%6pXzC+t9!nAHK_#J|vqhQxw znt>4+mXpbKn)2dZV5MiuH1~S?7=w|&-4u*8Gxq_6SQw8e_5X^+#^Ai|1kzPb|L0(& zA%&^tSnTIR?<&m2bsz2VR>Gx_o*6GA(O1u?4s7Kx1gr%XpT@+#>mdMfQIF_JJ~C1( z1si2{CvrBtlp$q4GE&z)k?mLGV~Er(1B2=5{ypJuMt3gq;nAwa&mtty19q(#sYqDl zL;qEjPVm8}_z{#BM;`Q{RmH`AuN%d@SzHVUj3V}%MeH|;_{1n;zYje+AerEUi`b`% znEGU{-xZ^XEd%d>Yeo@Q%_6QEMG${q+K>}vRm`|5ng6UZ4;Y;9=kztWsbugdk|Ifz zDN6J;`6v-bYd#`{Chm#8Ty^^Id!ohqj{f<0$W*@xM*f5D7)K_W_?Mgcmuvhn&Bz=R z|8ieCb?6j=4-`X6eQCkiSUw9`!|wK5Ym~w#`=h#^WRpqKdb6bUnk0lL(qNLb-j^P! zA5QSWB{5A>*@!hfFKuiL`NG8eGc)hcOuWyVcz@OaoG;kJiMXGcTtxOz>GvroTr$j>`IO&#IT3Hz9C+1SCth={T2i4wy zRIJ*OQmupfqzM8`<=^ujhW7WzRgAFu8WmfU24jqU1By0v14Ee==07lb&aw%vv= zvYadR!`jvnRfhabCFM@DWlu}Xo>nY-TC;33a*~#96#wFutrMaY%a*ih886xC=2GruXoY}{7Rc55G7mb|PiL9{Dta+EoZ5En1 zKi*p@d}FxFtY@)|#KH>~McCh+*Li2|Bi%cfqJv}^tkj*N2tMSm6qSCB$q!8QPzpNw z<0CP|X`z7&?2tzj7xaT-I(@;bp=}mwG-7cqt*QxCmSOsBjo{(4(5{w(Rk!m5rV|$W zBEO-#)>F%(gj@2o6IXHL{fpMLQ%1H@-J$fpTyn+Ysp?X>oi;2M)tHcISR?yCz77Z$ zS!b4%k|-<9e_}JIRMtD1vNT4m&3?SygycWoZa{MS!O|E`eR1h`oEn!g8n#TMj0rGN z#snBCo0bX6e=Yk`%DsbHmJ44cF1M?d*?1GhQ_Ex21!;VMaN_mlvp6xXKJ>j6g82Lj zjhL#$tRa^Sq-86kRcb1!_pf}KQ{&n~-&mz7{efBO4^%ElG!;#4TtG8HYRngl5*{H5 z^_ox;XtZ%tJ-4y(o%+Fo#Kz|H;mepdJli;Y)f(ZE*fsBa8LK>MT|3bHVanPV6~B{l zHrmE-j()WBIt?S9lp;0sz9sgpTCah`P6}%TekZv@UIXW=gZcA;9L(v<>re3XT(%)z zh3BPGz7Ed<#DX_!3SQC`lpuEcUebEoLBP!K8;5g97`myGRq4oBZ9@E#O)s0ZrYYDSa2+hrIno-`%eHu%x{R zLw%BI#tW$g`!qF&v+33sVywzaR^6U=z8uwZcnhta)fQI17gA})ju^ESwv@tl83bgv zh3?v+`MkQl=z`I+J1~6tjujhP?YUD_Wc~}Mq^WTpyepCNVh;Dtlouc3IdS1d4zku= z9At;?dhgc$fa1oXyFc~31s+HA{(6av3+8#+_6t&#PxmJ?5vV1 z^m?t$jEH<)v+P4*nOhm~53^;5B->A4|45zlxgFF*`1tQU5pbr18UyxEvAEBK2-{O{ zYsNNpym=(nzya<{PK zC6J`5>lvh~TmN1!p0^*rcO!#0!x}IB_Ch=MbpYHQuJ?_`hA1tnTFdZZqee%h)K%B} z*9XET(VnW`2gf;S(+&VDVOKgpk)h{wHG~y+ggBPq0U2y-M<}rlu!}4yveSl{X)MnI zzPCT!57>C-ES9t)CFsx z6B04o5$HwMnW$ECDm%dkC!;EvXg!ijIaHa6v3Bl7wf8t${-)GmeeKwo=t3Xf=8$kW zhI}f2SGJ1B?8fc{e=C;GfMRy23+x~l?DSwkd_|vp^RpZu%kw0LXPCQ7iS5 zLe!b%I3Uj4b_j5Y78tQ%ixoG*imLwjrpy%RwG`_Y3J;t64QUS1Zy?AbaUW5g_~*>(pB(N%ay)7;BUFz zB%cT(HN=le1+~Sjt^FoxmijB}+eHU0-!a%7o`2>nb$I>}?ZZI-(IIx8_!I&EowWK} z2d%Nkk~5OA67R=i@-D;H~BL%&h!ox!8h%wG~ zE=y?3Th7s(zi!gtP+`*GP-zmr@*Ez3UorLjhYFJlr2xgGw9qz9;tLb0GnuqfH%YEd z$KzW&6ye)Vve#tLZnHsd3(ZSrgLX)Rc7(DsPDm&C$_;v68uV=FpEwgDKbYj7y@mX9 zX8GSp`S{?+Lipg~PnpEu;!KD{gb6HBVlxyQ<%S7$vp*`#G@)I>#DsPUlSe}M$`uI4 zuQ;L4hDuQ0DlJrIbY{m{W+I>f4*Z3KGU zY_rookkJL>w56@~$}qmwX8nEPC_CK?BFQu8g)idC<}iMIGn(wxU-6uYyc5Q39q=sa zK$tjXBL6^hPl#7>#3ZRA=$=cVCoC6_l9jn6QAo*ocOa>B*= z6r11yo5;#=cEbaXSvQ1>s$pF?J@{cafBuGfU)c-G?UkHcR~j+U-|tC2NFFu0we)z| zMP3d!qSIc^rG+x$m>8vE&{6c=JUdPuiisnK@NH}?yvJ-w5W#j$fncqUxMCt}mSoM6 z?4n9`Fd3P=Ek>#Z-Cp62K$p_W*)6rwag~QGbYnF=Ksylc8qre7c8zEyWOt)S4I%qv zxabd|pZT;leVz(Iel6FjY*-Fxh3baL7Tv{ya)H;VtWPeyz@4$D2(nmY9%x1NSF9ix z9PF=out6{w0a2U_Ip@jR7hoZG*0X6y0qpT_#g_5I zbX!(Ow`@zyaB0h+;Rah$M}W3@{4APB1DiWSw`Fy-(H1H>-((9NsoP?WG1{U=0iG(} z4bj||$WhXkl2H&J?9IC(wcxB{BcibSdg`y>+lqO9F5SFou`QeT4;-V$^%Jqel92o1 zOFnB8${>}+R!Q@RR6$%zJp^TE%wFZ=>MiW+Di~?sjTNP-5qy|S7prp9;K?u#)C^&N zOwq+(m*R`2>W-WiYjosfX@kj;qgBjKi)+b;X{>p+^x>sx&`U+=eO;MtA!Ia7oDRjU z#kv2(y7RVmYuS09;270;2fGR9*&l(&wU9sci2nOo`Fq>~-MVevjMhCPg_x{MWra0* zn1sX|O;i&nBwh{qV>L2Nd=?@S^IK3&iynn{JlV^Chk4>66seA9S^J?YJNE=EW9Rq7 z?QGFfxG09Ms)c9|mi{(W$f0ALa%lgR%24vNQ-J-0@4)v>pRa<2gq?jKM##|~33Bv_ zdfe1)_yBsclGV_^mAE8KckPUXmRy^|4l$fIgpi92wrkOHe2wnUh6Hvd1~DXLE!@c_ ztpPhDM#^KgfW; z8NLLu;j^F|)-c-^aFV)2dC}!Lp%@K}_u`*;4I$}s;WZO&;8QRGj!4?~6GiO-U+A>> z$w+(QX4=l|&}JxxKLi7~#< zVm7<56=GmIw-oRCoy?T~?8puTqUVZ|RL6YA+ZW`nB-;F&lTF`_V^e=Gz{@@At8fXK zmn6%X>Lgi~Elv_O6}}3a?i7^l@~c?6tvAqemyn&37M^Fjx1mXv9g0cMn}}EUfk5`= zThNVsq%r77kH!14ub+o|4NaA?N$lcQh=!3|=3x0ytoo0%3e)zWu*xf0lxXdeWr-G~ zzw#0-E?L?Xoh)tYk<4v^Xja~+6lh3@7n+8UfhwV>*EXF4C$l297?ko%7D|!Zl4bdp zwF`2r6O%>Rc26>IA^1(;Z*A3QvvHi>=9!7ZTdL1iicu;QFGHQNK3m3hjw4Ut8}1Dj zC%gA~UNMpFm1KJ**=`frvkefTVar!0vXjXITTV*V+Q62}l1#yt3#bq7$=$H!C(cL5 zmXpa6TTV*lPD+v<@GRJnT9rAmE4;hsz?1Q0Fd5)w*84m1D^S|y) zE=wypQtm!%0n8qXTIig*pmuY`YT1C(Hfkf%20rsD7x zKnd}O8?A!Uk~C2q-~$^LxWJ;cII<|s4U}N7iENi7!v`nZp_0jauM6Z*rOz=n%~(!W zNv+Iz5C0=5)V%*j(cIkU_(t$)A@8fwOnG0D#`7M2*XKPbU5#!(cEq3fHf=lxNdc`? zfr+Q}DsXT27G21G!ZE4?k9HRYcGekKtQCa6osqkf$Zy~i{_&S@piCVfoFQ;II76^* z9hccV|3)DSDko-eRK^oMmisMehep8}0)(4pe+xEH>+ZeXjqctpEik*ASC!p4R~(q*wOaPV1+>&@VaF~29uczh7w|HVxIBBb z?L$I#`7-cp6HPrY!3JpioRE(#{~IV$ZdJxrbZS9*x4kXKq+{S~w*%G&h$6}$kInQ0Q{%rpx7{FRcH2e*ZX@qx*+4}47+@G2bw_X&#UdGP;p=ZQ)ss5ko z_K#L0{{2jBrRH_2|6}HD;=d)eUi^OlylEA6t}?&+Jfa2k+nGF<>gSUaYBX=pG)D7t zQo0_^ypzxV4Mc1G`1I5=_Rsb4*%3lSQ>dAc;dZyHVo98zD0|qrcH~#J2EqHPendOl zbW@AB@Yq)#x>_zbwG2n6Y_liP;N;Ps0#3g7BpXy=uC|5o);|mI(uKXM3zLoiw(ps- zQ%I{`G&{l0v?JoC1>5XP!rbqLeWg2Onm0MuQtt&XGT`5Muyt1H*aKE{tXu!QeJ{Xt=!RLT`@WEU*)?1iM;>Z(A@Kt=`9|X62oT zax2HJsGiRS>P7X0-U81BZ}#6{(#TEP)rn~L5elV(di?W_D@*81wDx0@VuD;cIsKEJ zNjz`X?dy!!@0By(wBCG)Y)a}vs#-bsXTOE(etA60;1~YKTFe-|2O@OmY|RqU>m5n7 z2I}Kk#teQ;vbxEF=qTNS6N)hN;(tPL;dV4cVS5}W^;{IG@@{cb$Eg+2yL~jhWg^5U z5<6dyr*|WT?D0eyR=X0(4t1hglKi$miM+v`_fWF#{I?{xn^eD+tgGHDTgua&Uz#GF z|9Fb-{DwZl`M;--PM#`~Pw9a^RFM31Hb-(?O!xF4^1{t}wgUfh;MOPXU-cmTg#Ah; zDI~X8Qb+eD{4OF}+nZ>Y5kpydE)lm8*$+L4aam>avdFLIBlLnCafHrx_CfGa4$$*- z20qzj6z4x7o7}}0&)2evws?-u5pGh}+oT+w!FZO|kBDNIEzKcwI0KJdvOv8pN!fvH z5~N-~q$(SJgRqLP_2GHs3a1IqC(Biu4@@*4s5JbqS6D~^&NeRf`2}RGShv>}k_yyz zbzfaslB+1o68e%!>K#RrE7sQ|eTiw24q~bOZvIl=kHp~GJ$(oXChqsQ#R8VsU(dB+ zQl7TJ-tqz-^Iob6AdisBq%MVT2SeoP< zO!$3b<`|;G{19Q9ifkWei{#olg#6N42i@at-P;@UWyUJ^a~y1V5Q$X5;1e9kd%gd? zo3wexP*H;8@Qh(;2~Gf(=%-4gw!fB;LmX}FV@W!@GEOqHm$uDpaj9hXVkw%A%x;uQ zW}U~A&((rpBRg}aUVW^SHt4g7f0jB%-AauukOrF3bZmiI-QSo%?1n$o72!CmOn1;6 zgF8FeT+?+tII-=xJzAmXLL&YN9p=KQ-~R%zLT5w( delta 17111 zcmbt5X+W06)}CQ~;Y9=iQIK7bofiQ&K-?D$K}}2CP*Hp}5tmH+BC%VVyAC++X;!A> zLR4twR@$PKSzRmpN^SAhHMhE^mgaY6=2_X4`}L#8=XvMs%bas&*z>bx&(9Xe`HmG1 zRgS+z()GQ=t9_zQ5c*cnUbJ0IODD(a#WQEoZZWNCXs-Y|J7&A`B|P>^wgMoWhQ=MI z3;T3oiL1bk>~*3a_er9K@hR1|z7;@o5_(a${*`cnZjB12xevL~v;E!SpY(9F553zz zk}k9rz@PYAxaFo(vt~tY?Ei71UJF`UmO__u`DROghT z?e$@zUJoRC-a>@YW#vzlw=Z(CcXejnuR%J=aHh80FqPZR&b0fxHo7Rmqxz2rS^^p4 z%;t9`ab&z)Rlu2SV;?0}k%yh>`OzV?W>ALpfA|kBqsrUcZ#k{bO(bO|tfkKENIGdr zi*sEprMMC$8t2TaGD$yDAr^Wnh~aL`j}A9cT-ogLbubi)U)}8c|gcJws<$@08WATvU;+rkG zD?yKWefZ;~0Dluc=H5kmOwp`a)9=q?bl9!8z2UP(j7 z`_VCDI+9~1g73I+*VMe_9fUA==T|1=@3_#BW0MI!Y{@oq(1qpAhbVBN7svLs{%ItY zSs+huumJRh) zQ;?6vWQbV4P_?#?g~qS#1wORo!DMKGzi8&LB?pw>r<({K0^ zOh4W4L0-17^P@;$SS3O(wah4-IICdBq{3O{_8XjnF6U(_=Ve9C%Zi*A5s@$^{LKF) z<@`yIQsn%i335U|WV9o-Jrqn2M>)1oWKD4sx+%4=?xm2tOLgmoC(n)I7h0Bm*XbPh>shy(+NJVZHR2Lz4>_0 z%*O%A#{oB1HjyL|eC3S1X=LO`0z^V@m6S!XcZwTbbu7$P^=oc@H~V;WCQbqpwv1jr7)fts1+e)`A&N#!45#OMyOIcZ zb}AG?>E=VJB+Z@XeI3m|74(AHq@O!0Spm_cmpko#rzaVPkJI9<>W)|>;3h}M61xgV zk3>(P^S^ZWU+O%eaBAVK!gBjFoQX(x{NF-eiwutmBBAaK(jjuq`_P)@dJuR1q5CV) zja^y=&B-d2;m^qn67LqlVu*wNd3Rb8mq=b!KO?yydND5D`Xt9MDB+S0@yTS9AdyVh z#lLR(2!BLP9Y^-xwWYn!-(+<>0TpIW4Gm-q-$q&#YrgMJHw|k|OScE|-C^VQVZ_I3 zEVEl!dClgk)NC#2`MKeAY@Vm5K`39$<8*%V8zdgr${KEb(`q;avbq{--++pk%?Ub@ zo`PF7qh?v9hO~@I7o_wdt1Yzbcsdy^1yeH02H9~9`OezJ_Gb2?*Igi7=ml_)FeM|!uNQZ6^RdN(aPx=Rf0F+0Md z=-kDFmKDc1*cV&nepM%rT0Kl!cJSZ{y^RC^Iu6xK22Ck{x?JfC`5R4qbVUOx6jM39 z^QcBT(@Z*`4(Xm6X}WyQcMTvddn|{nvd~kHB@;!4x`^iKh|=d?B~Msr!n|lTm1b~5 zXsHx~4^t^m9p@*J4jko`P2fj9^iUG0wL0PP364r&(tkf0L2f$H7V`tZgT~G81-`Uo z{=T-2h8hi77)hs=ncFh@W0}C@wje-l#-=vs6(b$9z#XyX?A}0~pNhRF<^XKos;4}) z)K$DL=^yD%WE-Y4y&Kilj)&m)bjry~rNP#oWTD*k=DZLO) zToR#n{{L=nY99XGT*SQ6rqd6WL~!uSOa8^dvA>}~%QVmkPZMZ_rwO!XnE?HE*%?Xs z0qVR$C@OA6fLbAsHiJC3B0{Z?M|%nt-dQn=Lt{rm-&-l5e_g3TQzLYLI(C&-U1Q(C z4RB!9HV%#L20gf1WBUU$+aIV{5U3c1t)5TQK(fr+hkWiOu@xFo(!wO=<_a!l_0fuK z0prEy@%77?wm#joe)U?Rl*qO3yBHdOYFXFc^geA}L=UB)Pe6n4oFWT)+_0LE(|M6h z{ntmR34OWb<^D_L)f*zzn(-A1Yemf;U$-!>;&}CR{xbG6nE~|m4X1g$F54I#p_D#L zB>l#6qu(YiH(pV=weZ~dKm$31=fu;SB6uFTy(yPWb)z|(TUnG&#Ns6wd3N*82B5Jr zq%)q=Wb8#lUl2V2P1qb%w=V7PWfC(>VsE$Q6SYdX(t=kBq{u=;wnmfjmg?-SgPgf5 zZQMRjjkj2DV+jyTTkOujBr*5pSMQM^Yzcl?-JBlVp;+& zzPGUyeuzWzz6Nzg6L)2p#$ELNT_WHw?cy2QvYTh$F9&4$F&&juW_@GPpR(l?p=G+uR@j8~CeOEJ7jZbYu9m)WI)%9OEDr7!>^q{L! zMAlHRBjIYodQAd1py|+HNTM$9X_|KOm82}}R6fM3F7M>4N>%Y*C!Q2ezIQi;o$Cal z)z|*o>A-T@!FZqHZIlLUsZ-zHLqihFXID5>_`qhCI~e<`3vGA_!%8FJ>zY>qEQF1X zhC$>;8&(w!ku1d#QkZ)TY$kmISY-@+>Y5iI3hqH{t2+eKvmd*8@Gt0FMV+t?@5Aye zkkM47f?Z-Wj3Fj*q`ZaVV~C-OPT^^7om#1u1#nM>GFIk-gVR#^J0BuE9>9kPsR+5o z1v0($d@GKHVqOUXQw!>$217lev?><184@EAUSNrfbgw`LM_VAXku|Ys))}B z#Pzg*69U+^V9+Kq&HB!tcm%2zEMuKQAzPd{K?vJwg)q^^2L|#s zekdfEKJhjlvgD_g?OjQFAn)WMM_F`SeBs@^1P`Hmue616wNZq!En8tQ%+&D|2eRPj zp&MF6GJuGR1F1wLn(_^IM~HK<;GjU&F`aV<4H2G+8LBOg0??6K2i6({;0GK8WRqQ* zxcj7}hjpIbRwVtz^hrp1PUrA{rKFd22Js7L@a;g(AbZOJ`pA>IgMrM$5u(U`!AvqM za)f+W&$fa=50>YTCwtgpr?~MiO`IEurWiswk}xm3GB*f9M0K4$T`Y35E4^8#w!-5( zG4Mw(O_gl$W1r-44qa@e}4Gfa`7Zl`}BP0qCi(ScALHw66i#jz8P!K8u z3AeVj1`@DAS)dH8SzBW{!Z@;a^y&%^t3hABY=s3X;WZA)&pw-asANP{^PC&te@8W3 zO*~aXf$AJ-o^C6SG~p{Dn#Hb&_62_x#y1Kh+9T%X0j1`1rJHTVxf1-TAW=?b{?L$+ z-`etHPu8_Z*t43Db0>+RW6W#%4yaUX53ru(iNW6Viyhz1-vH-tHuR_0sD_qWC)5!w- zDpb+au5==*8UKq;gr-mHLDmcI)Lw*1)(sUYo;lQCrn7HbLK4|0g;N6T^&nbMnO(Pr zdXuBoYp5y|9?v4Gg2Y(_KKaa+?3OC23=%`6mnC8)o>&myuGIpdTyojK{=thv@|Q`h zo3+KdS6xV22MfnhbsB9rk)OS>VxwbV_T&RZ2#IBXXs{19A-lC*^_G#{V;%yDfVx zPZxMixKUs#@irzf9jvoqiBQ=vR>aunjDT=1aOe;zaQ+a8#_50yduB33G+A(~U8gub zQl)4V{4-pkHWiB_g^X>cz!`4zF=Nq4kyE8&22O>j`m&NTy zfTK<<`4G$}v!mH_$03Z}SPaWV*UVNgfy;8)_N5T+$hI7VsbpA;TsC%+Xq_AUsJaJN^(0z!jda$|#zLk@9_6|ig8V7q<&IOMS@YoK?Nz1*AWBF~6b zMb?dw!M6tL+J^9lB>XNTJk34g#SR^W_T+N|jv#jF z1spx_i=w!FPJa<1AVLaz^2?6$p99G)p%NziYV+67dChjnWOuhg1RdMQg}BCxexJ07 z7f1H^Dvs>q;-yO3#|xEo!3U}Y-+1dQVMLQpa*S}Y!6#!B;QV;e-IGTobiNTfl%4z# zVo8|_E}H3rN*FJjX*WdiB6^=wyt%UnCzkaJ3?$p*>jq0Eo3T@o>J3Gz443%pikv5d~e=R708) zxiHzZzEG~m2d-yOg^J_t7l#O8(XT-;Pqpp`k(cErxWx%#Fuz!`)bL;)wh1tGHot|x zDaST-_PG~1GQC$?oFK;aWU*usA6%q`LL|~9fr-m49VJ&vqKQl}=KFBTTqAh~eiGnn zp7~x=urcF*FOb$#Y=$S8icRkXQEZ|&@M6<{A0pF>O}wrpuFv=+st)^$xHm(h5=Fp; zC(8Is)n0|C_Dz)W*E3PX--GzT_`^5usS-xU-((}45`Xg);71c>{4J8ukJg3WSPPnG zqg@L0jzo5N8+0RYN$4F$XeCNcs^B6@9#{->4L4}oC90(%px@HDuIZ(W zDcMP0EMh$m%3uaZcIsW6VYV0sS>VUEzQe<-kBj^qMi1W}3hnvV7)*F2N1-LVIty%& z#=PEz7!r{rlDI@cuVOwQPz%E>$d}N=Idm3=i2xjK1YFYHJ(B%KY{Q%{=+e%VT;Yk8(K0hr)E=Y!g6uIqxd6dVqUxx* zaS`&x-449Y$97&q!EZXTPcH$UO0!=t0Uk>;+hzEu@pEZ*^(ycSJ~bV$z(#2NXqvC> z!RNmz*WeNL+Q95oei4nWxC8DWM%Xppzd;7S;=}TO2Y$zg?fo5YaIhW!fjKJJ8>yx_ z^c$(dD9Rj~Ra{4D3Y=@+x(-{ph-~x??4(eaWCUBx_dT6O&$X-3z7Ns@2C_4#a?{QyMc)~%xqbnQ0h zy(ZJ_1R-Lsc8!qSfI7F~<2gQ&ZP`c%a#QU+-PkEB(av8R=aJXk>>Ed&M|&L}4Ttq? zixbh3(my(ir1Y~B*{D*sH-R!AY%@<6qD>a}DU|Q)Mm;-=km|*#)9kzhp7P>tdbY)# z1l7I5_>Hcp>8|8reRC@Ww^mr$7VI*QgphD`zkR-ohy>SAq7Anfbus3NrzNh&Bn=PKB|WW> zHgA!q1xhY&RTvS&?TcY#s%ukxq%4+cu z>NPB0emf9P4szu`k)T`h9f_+k`Tk7MZ-^T5?gMZpo^y!jiWWNh>F9 z2V(K5q)^>`&ZYC+2aABcsraWz;+`*CnMPtm8ofe{xBJ;QsiZad)?7~`J;*&ufuWrV zzwOJ`btc+%-?pqElZgAi?3Yxclml#T7jlzV12emlQLf6#ayNaYTRIuS5sgVF5Az-V z&2*ye@S`(?M%1bxJ_D1Rf?+hX^&;X7oh`{Ab2tXaOfp}+c}&^ibfW#e8#UsY%1e^q zZsaR2Ps5;*YwocC7CL_u|3H|^};a8 z6x;uao*K0 z;JW+I=NzNl@R#=|A2qO#;gwppZh(~Q&;Ysrcx6kuVzLRp!p{N+>YL6$A)k7_aWY+m z-75phA5A~ra2%mW`KBy2%5k!u&T@T8sG3VY$7OuHerp72^pL19AJ^d_(UN?$4t6GI z^Q9Cw^T~%iSp^Iy$?W<_i7a4Lc+2#v!n@n!FIhCr*#Ug zKXp!zOlZ{6KPuE?C$5Kxo$p4~7dy5dn((70${-jtiD-YwvR+tT4T5L0L=c>vL~^bF E2T=*KYXATM diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt index 9cd1a7c9..24605632 100644 --- a/docs/_sources/index.txt +++ b/docs/_sources/index.txt @@ -4,7 +4,7 @@ ElasticHQ Documentation .. toctree:: - :includehidden: + :hidden: installation rest-api diff --git a/docs/_sources/installation.txt b/docs/_sources/installation.txt index 833b57b5..8c1ccfc2 100644 --- a/docs/_sources/installation.txt +++ b/docs/_sources/installation.txt @@ -3,23 +3,46 @@ Getting Started =============== .. contents:: Table of Contents - :depth: 3 + :depth: 2 :local: - - Quick-Start Guide ----------------- +1. :any:`docker images` +2. :any:`run from source` + +.. _docker images: + +Running with Docker +------------------- + +Docker images are offered on the `ElasticHQ Dockerhub `_. + +Run with: + +.. code-block:: bash + + docker run -p 5000:5000 elastichq/elasticsearch-hq + +Access HQ with: http://localhost:5000 + +When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag. + +ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'`` + +.. note:: The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch. -Installation ------------- +.. _run from source: + +Install from Source +------------------- Requirements ^^^^^^^^^^^^ * Python 3.4+ -* Elasticsearch. Supported versions: 2.x, 5.x, 6.x +* Elasticsearch. Supported versions: 2.x, 5.x, 6.x, 7.x Install ElasticHQ ^^^^^^^^^^^^^^^^^ @@ -31,24 +54,6 @@ Install ElasticHQ .. note:: Alternatively, you can start the server with ``python manage.py runserver`` -.. _docker images: - -Docker Images -^^^^^^^^^^^^^ - -Docker images are offered on the `ElasticHQ Dockerhub `_. - -The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch. - -When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag. - -ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'`` - -To run/install container: - -``docker run -p 5000:5000 elastichq/elasticsearch-hq`` - -Access HQ with: http://localhost:5000 Pre-Releases ^^^^^^^^^^^^ @@ -103,6 +108,15 @@ The ``application.py`` start script takes parameters passed in as arguments from ``--verify_certs`` True Whether HQ should attempt to validate certs. Set to False for self-signed certs. ================== ========================= ================================================================================ +Example: +======== + +.. code-block:: bash + + python -m application + --enable-ssl + --ca-certs /path/to/your/ca.crt + .. _environment variables: Environment Variables @@ -118,6 +132,14 @@ Environment Variables ``HQ_DEBUG`` False If True, enables debug level on logging. =================== ========================= ================================================================================ +Example: +======== + +.. code-block:: bash + + docker run -p 5000:5000 elastichq/elasticsearch-hq + -e HQ_DEFAULT_URL='http://aa.com:1212' + -e HQ_ENABLE_SSL=False Logging ^^^^^^^ diff --git a/docs/developer-guide.html b/docs/developer-guide.html index a05478ea..8b059eec 100644 --- a/docs/developer-guide.html +++ b/docs/developer-guide.html @@ -66,10 +66,8 @@

Navigation

diff --git a/docs/faq.html b/docs/faq.html index 7afee245..ec0962f9 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -62,10 +62,8 @@

Navigation

-
- -

Table Of Contents

@@ -87,7 +85,6 @@

Table Of Contents

-
+
diff --git a/docs/genindex.html b/docs/genindex.html index da4d1d76..dfe602a1 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -59,10 +59,8 @@

Navigation

-
- -

Table Of Contents

@@ -80,7 +78,6 @@

Table Of Contents

-
+
diff --git a/docs/http-routingtable.html b/docs/http-routingtable.html index daa30a48..9fcca6c1 100644 --- a/docs/http-routingtable.html +++ b/docs/http-routingtable.html @@ -65,10 +65,8 @@

Navigation

-
- -

Table Of Contents

@@ -86,7 +84,6 @@

Table Of Contents

-
+
diff --git a/docs/index.html b/docs/index.html index 5ddce2d7..e1d39b42 100644 --- a/docs/index.html +++ b/docs/index.html @@ -62,10 +62,8 @@

Navigation

-
- -

Table Of Contents

@@ -83,7 +81,6 @@

Table Of Contents

-
+
@@ -114,122 +112,6 @@

Table Of Contents

ElasticHQ Documentation

-

Overview

diff --git a/docs/installation.html b/docs/installation.html index 0d793105..f924f6a2 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -66,10 +66,8 @@

Navigation

+
+

Running with Docker

+

Docker images are offered on the ElasticHQ Dockerhub.

+

Run with:

+
docker run -p 5000:5000 elastichq/elasticsearch-hq
+
-
-

Installation

+

Access HQ with: http://localhost:5000

+

When starting with Docker, see Environment Variables for passing startup args. Environment variables are passed to docker using the -e flag.

+

ie. -e HQ_DEFAULT_URL='http://aa.com:1212'

+
+

Note

+

The latest tag deploys the latest stable release. Where develop is the latest unstable working branch.

+
+
+
+

Install from Source

-

Requirements

+

Requirements

  • Python 3.4+
    • -
  • Elasticsearch. Supported versions: 2.x, 5.x, 6.x
    • +
  • Elasticsearch. Supported versions: 2.x, 5.x, 6.x, 7.x
-

Install ElasticHQ

+

Install ElasticHQ

  1. Download or clone the repository https://github.com/ElasticHQ/elasticsearch-HQ
  2. Navigate to the root of the repository: pip install -r requirements.txt
    3. @@ -191,16 +234,6 @@

    Install ElasticHQAlternatively, you can start the server with python manage.py runserver

-
-

Docker Images

-

Docker images are offered on the ElasticHQ Dockerhub.

-

The latest tag deploys the latest stable release. Where develop is the latest unstable working branch.

-

When starting with Docker, see Environment Variables for passing startup args. Environment variables are passed to docker using the -e flag.

-

ie. -e HQ_DEFAULT_URL='http://aa.com:1212'

-

To run/install container:

-

docker run -p 5000:5000 elastichq/elasticsearch-hq

-

Access HQ with: http://localhost:5000

-

Pre-Releases

Pre-release versions are made available as branches in the github repository. We use GitFlow methodology and adhere to semantic versioning.

@@ -231,7 +264,7 @@

Initial Login

Configuration

-

Command line Parameters

+

Command line Parameters

The application.py start script takes parameters passed in as arguments from the command line:

@@ -278,9 +311,17 @@

Configuration

+
+

Example:

+
python -m application
+--enable-ssl
+--ca-certs /path/to/your/ca.crt
+
+
+
-

Environment Variables

+

Environment Variables

@@ -318,6 +359,14 @@

Configuration

+
+

Example:

+
docker run -p 5000:5000 elastichq/elasticsearch-hq
+-e HQ_DEFAULT_URL='http://aa.com:1212'
+-e HQ_ENABLE_SSL=False
+
+
+

Logging

@@ -409,7 +458,7 @@

Upgrading Minor and Patch versions

Running in Production

We advise that under any considerable usage/load, this application should be run with a multithreaded server. The current flask implementation by itself should not be run in production without this, as it is a single-threaded process.

-

We recommend running this WSGI application with gunicorn. The Docker container available on DockerHub is pre-configured to run with gunicorn, and is preferred. See the Docker Images

+

We recommend running this WSGI application with gunicorn. The Docker container available on DockerHub is pre-configured to run with gunicorn, and is preferred. See the Running with Docker

If you wish to run without a container, install gunicorn by either commenting out the line in the requirements.txt file or simply running pip install gunicorn

In console, run gunicorn with:

gunicorn -w 1 -b :5000 --worker-class eventlet application:application

diff --git a/docs/objects.inv b/docs/objects.inv index b4384e39e9b731dfb24d6740033f67f4b299c947..78bafd98aa97e75db537ef8c84087c4613eda479 100644 GIT binary patch delta 880 zcmV-$1CRW|2jT~ie}7GH+#nFW`&S_K(jMq4*W98cZC7fgO}46fi->As+y{(6t_udS{nDvTObd?shR3IeEm8#BnpwJl-AQje&pL10fAG8gdC+uBu zvg(GeK1wAh+nqbZ9U~=tTHU3bF-Vm~&Y%DVZ@{g&kB=Q5?tkH7k2i(B;__`~#<&P| z4x~`|h>{-TbwGi%QW0I^`K%Tvl(a5OB3@(AI;1e-jFKJG8%R?bQA7vzxS;8seYBCL zb?YGo#Q z#-sImTZa~V+J6O;iQ5JLEsfayvrr=cppjyWjNBlxXXIswijs@z6ZBZ8tHx>Kg1h;(~9nljQYpv!?|{9_i!8Pqa}zhj!Ko9)C$JpxLSz#4S`9air5a>R?7X zgJX_cw39XN5G^#wPY-Rzv%#@reC}vwW)5W!JfJKM>cF`1sMw-T6BODVBNg?!Wvry& z?inkp-%Y1v#n`CeZHcl8;U$k$;KOnX&{LBtF6fL;B3+QvA1n;OKu@Jy3uIXsuQs1< zB#+h#;D5CWdTBaG7bY30WX{#G-SHK8^$vSea2-9%k)-yJ-r)^PD_Hkc9g?SW#EGjE zDkuX~5uwqV57|;>=LNZk0^u`6nf5OVVy3ADa$(qn;ZE3P7jEP2Nd`|)@CpRp)ii?! zKI5qYKUiw;(HAbzRlA_WdHM(f(UR<7P@8qe&VTu~X3YG3dZsEzSItra?1>7_N?-~- z5kbj)F$~)Y!uz1>4%DyKnmmv{-4yksOY7n$*#WcnkRD%awSH^!GugX2oQ}tJLCmMv zZ#O2V+R!&rldkT5=s`Z{D=1|OvsFYW$dZz0@93&tal2r{e(5BFSr!!ceufJ2vjvxv#BL;?|M-bb=F%e}Sh8{G$ql*OIW zr(18&5Vdy2t?PFC9bJM@h;fCUxp>qSOI|9HKI%XPJFzeH3B)De$qb{E^Yy@g@sy*I-!OS~c_U8Ss28l*ydt;@?CG`c_%l*VTB<6al+ov~rN!rm1p ztA6O}z0#8M{L&eAoD}e3wMzx(km?3G0|pvifj8zMK6ZF`fPaTQ-W2*$sMncU<0901 zAWZK^l=K*{0}7;7nwS#LXKipoNvonD@+AhXLkc6#D9O1wK$@zEB6_ID1x@elqm4AJ zTMywV&u9uqDi%;27you`Mv$D*KcB{1jTbz}$IyJ5mb`Un!yg5+>kTjPwK^M6efx~^9V@Fyw-FMw^xvE z2zNoZJ*c0pHF+Sv`^lN5OX%t@$$>X7kO5z7ZT!~u&!ls6I6aSBM(jt}FLySz%F@?T zlfLd@=s`Z{GiYu9qugpDHDpO4vNv>DV&D|Eebr|g^cwnpyZwQ#HtR$I zkxA)(2;SHl$8EE}F$a_=#dg|ULQ~6gr(#@j>$=^3Mb{uT;zFZ8LOz=GlIN17k0ww< aF1xCnK&%6BKj0VMSd4XNO8x>uu7YpcyqOmO diff --git a/docs/rest-api.html b/docs/rest-api.html index bf88fff0..b5bfd79d 100644 --- a/docs/rest-api.html +++ b/docs/rest-api.html @@ -66,10 +66,8 @@

Navigation

@@ -182,6 +216,51 @@

REST APIConnection APIs

Connections

+
+
+DELETE /api/clusters/(string: cluster_name)/_connect
+
+ +
+
+DELETE /api/clusters/_connect
+

Deletes a connection from the connection pool and the database, by cluster name.

+ +++ + + + +
Note:This method does NOT delete your Elasticsearch Cluster, just the connection from HQ to it.
+

Example request:

+
DELETE /clusters/_connect/<CLUSTER_NAME> HTTP/1.1
+Accept: application/json
+
+
+ +++ + + + + + + + +
Parameters:
    +
  • cluster_name (string) – Name of cluster connection to remove.
    • +
+
Returns:

List of active clusters.

+
Status Codes: +
+
+
POST /api/clusters/(string: cluster_name)/_connect
@@ -280,51 +359,6 @@

Connections

-
-
-DELETE /api/clusters/(string: cluster_name)/_connect
-
- -
-
-DELETE /api/clusters/_connect
-

Deletes a connection from the connection pool and the database, by cluster name.

- --- - - - -
Note:This method does NOT delete your Elasticsearch Cluster, just the connection from HQ to it.
-

Example request:

-
DELETE /clusters/_connect/<CLUSTER_NAME> HTTP/1.1
-Accept: application/json
-
-
- --- - - - - - - - -
Parameters:
    -
  • cluster_name (string) – Name of cluster connection to remove.
    • -
-
Returns:

List of active clusters.

-
Status Codes: -
-
-
@@ -559,31 +593,6 @@

Nodes StatsIndex APIs

Indices

-
-
-GET /api/indices/(string: cluster_name)/(string: index_name)
-
- -
-
-GET /api/indices/(string: cluster_name)
-

Wrapper around https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html

- --- - - - - - -
Parameters:
    -
  • cluster_name –
    • -
  • index_name –
    • -
-
Return:
-
-
POST /api/indices/(string: cluster_name)/(string: index_name)
@@ -658,6 +667,31 @@

Indices +
+GET /api/indices/(string: cluster_name)/(string: index_name)
+

+ +
+
+GET /api/indices/(string: cluster_name)
+

Wrapper around https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html

+ +++ + + + + + +
Parameters:
    +
  • cluster_name –
    • +
  • index_name –
    • +
+
Return:
+
+

Indices Summary

@@ -783,20 +817,20 @@

Index Shards

Index Alias

-
-
-GET /api/indices/(string: cluster_name)/(string: index_name)/(string: alias_name)/_aliases
+
+
+DELETE /api/indices/(string: cluster_name)/(string: index_name)/(string: alias_name)/_aliases
-
-
-GET /api/indices/(string: cluster_name)/(string: index_name)/_aliases
+
+
+DELETE /api/indices/(string: cluster_name)/(string: index_name)/_aliases
-
-
-GET /api/indices/(string: cluster_name)/_aliases
-

Get all aliases for this index

+
+
+DELETE /api/indices/(string: cluster_name)/_aliases
+

Deletes an alias.

@@ -804,6 +838,7 @@

Index Alias

@@ -844,20 +879,20 @@

Index Alias -
-
-DELETE /api/indices/(string: cluster_name)/(string: index_name)/(string: alias_name)/_aliases
+
+
+GET /api/indices/(string: cluster_name)/(string: index_name)/(string: alias_name)/_aliases
-
-
-DELETE /api/indices/(string: cluster_name)/(string: index_name)/_aliases
+
+
+GET /api/indices/(string: cluster_name)/(string: index_name)/_aliases
-
-
-DELETE /api/indices/(string: cluster_name)/_aliases
-

Deletes an alias.

+
+
+GET /api/indices/(string: cluster_name)/_aliases
+

Get all aliases for this index

Parameters:
  • cluster_name –
  • index_name –
    • +
  • alias_name (string) – Alias to delete
@@ -865,7 +900,6 @@

Index Alias

diff --git a/docs/search.html b/docs/search.html index 31c20164..47e22005 100644 --- a/docs/search.html +++ b/docs/search.html @@ -66,10 +66,8 @@

Navigation

-
- -

Table Of Contents

@@ -87,7 +85,7 @@

Table Of Contents

- +
diff --git a/docs/searchindex.js b/docs/searchindex.js index c8a9abb2..17c51832 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:50,filenames:["developer-guide","faq","index","installation","rest-api"],objects:{"":{"/api/clusters":[4,0,1,"get--api-clusters"],"/api/clusters/(string:cluster_name)/_connect":[4,2,1,"post--api-clusters-(string-cluster_name)-_connect"],"/api/clusters/(string:cluster_name)/_health":[4,0,1,"get--api-clusters-(string-cluster_name)-_health"],"/api/clusters/(string:cluster_name)/_state":[4,0,1,"get--api-clusters-(string-cluster_name)-_state"],"/api/clusters/(string:cluster_name)/_summary":[4,0,1,"get--api-clusters-(string-cluster_name)-_summary"],"/api/clusters/(string:cluster_name)/diagnostics/_summary":[4,0,1,"get--api-clusters-(string-cluster_name)-diagnostics-_summary"],"/api/clusters/_connect":[4,2,1,"post--api-clusters-_connect"],"/api/indices/(string:cluster_name)":[4,2,1,"post--api-indices-(string-cluster_name)"],"/api/indices/(string:cluster_name)/(string:index_name)":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)"],"/api/indices/(string:cluster_name)/(string:index_name)/(string:alias_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)-(string-alias_name)-_aliases"],"/api/indices/(string:cluster_name)/(string:index_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)-_aliases"],"/api/indices/(string:cluster_name)/(string:index_name)/_mapping":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_name)-_mapping"],"/api/indices/(string:cluster_name)/(string:index_name)/_mapping/(string:mapping_name)":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_name)-_mapping-(string-mapping_name)"],"/api/indices/(string:cluster_name)/(string:index_name)/action/(string:action)":[4,3,1,"put--api-indices-(string-cluster_name)-(string-index_name)-action-(string-action)"],"/api/indices/(string:cluster_name)/(string:index_names)/_shards":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_shards"],"/api/indices/(string:cluster_name)/(string:index_names)/_stats":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_stats"],"/api/indices/(string:cluster_name)/(string:index_names)/_summary":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_summary"],"/api/indices/(string:cluster_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-_aliases"],"/api/indices/(string:cluster_name)/_reindex":[4,2,1,"post--api-indices-(string-cluster_name)-_reindex"],"/api/indices/(string:cluster_name)/_shards":[4,0,1,"get--api-indices-(string-cluster_name)-_shards"],"/api/indices/(string:cluster_name)/_stats":[4,0,1,"get--api-indices-(string-cluster_name)-_stats"],"/api/indices/(string:cluster_name)/_summary":[4,0,1,"get--api-indices-(string-cluster_name)-_summary"],"/api/indices/(string:cluster_name)/action/(string:action)":[4,3,1,"put--api-indices-(string-cluster_name)-action-(string-action)"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_info":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_info"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_stats":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_stats"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_summary":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_summary"],"/api/nodes/(string:cluster_name)/_info":[4,0,1,"get--api-nodes-(string-cluster_name)-_info"],"/api/nodes/(string:cluster_name)/_stats":[4,0,1,"get--api-nodes-(string-cluster_name)-_stats"],"/api/nodes/(string:cluster_name)/_summary":[4,0,1,"get--api-nodes-(string-cluster_name)-_summary"],"/api/repositories/(string:cluster_name)":[4,0,1,"get--api-repositories-(string-cluster_name)"],"/api/rest/(string:cluster_name)/(string:command)":[4,0,1,"get--api-rest-(string-cluster_name)-(string-command)"],"/api/routes":[4,0,1,"get--api-routes"],"/api/snapshots/(string:cluster_name)/repository/(string:repository_name)":[4,0,1,"get--api-snapshots-(string-cluster_name)-repository-(string-repository_name)"],"/api/status":[4,0,1,"get--api-status"]}},objnames:{"0":["http","get","HTTP get"],"1":["http","delete","HTTP delete"],"2":["http","post","HTTP post"],"3":["http","put","HTTP put"]},objtypes:{"0":"http:get","1":"http:delete","2":"http:post","3":"http:put"},terms:{"boolean":4,"byte":[],"case":0,"class":3,"default":[0,3],"delete":[0,4],"final":0,"long":3,"new":[0,1,4],"null":4,"return":[0,4],"static":0,"true":[],"while":0,_alias:4,_cach:4,_close:4,_cluster:3,_connect:4,_expunge_delet:4,_flush:4,_force_merg:4,_health:4,_info:4,_map:4,_open:4,_optim:4,_refresh:4,_reindex:4,_shard:4,_sqlalchemy_database_uri:3,_stat:4,_state:4,_summari:4,about:[1,4],accept:[3,4],access:[0,1,2,3],accomplish:0,across:[],action:4,activ:4,active_primary_shard:4,active_shard:4,active_shards_percent_as_numb:4,actual:4,add:4,address:4,adher:3,adjust:3,admin:3,advanc:3,advis:3,again:0,against:[0,3],age:0,agre:3,alias:[2,4],alias_nam:4,all:[0,4],allow:[0,3],along:3,alreadi:4,also:4,alter:3,altern:3,alwai:3,ani:[0,2,3],any:3,apach:[2,3],api:[],appear:0,applic:[0,2,3,4],applicaiton:0,arg:3,argument:3,around:4,asked:1,assum:3,attempt:3,attent:0,auth:3,authent:[1,3],author:3,automat:0,avail:[2,3,4],awsaccesskeyid:[],bad:4,base:3,basepath:3,basic:3,basis:3,been:3,befor:0,below:0,between:3,bin:[],binari:[],blob:[],block:3,body:4,both:4,branch:[0,3],bring:0,broadcast:3,browser:3,bucket:[],built:0,bundl:0,bundleid:[],bundletask:[],bundletaskerror:[],cacert:[],cach:4,call:[3,4],can:[0,1,2,3,4],candid:3,caus:[0,3],ccelastichq:[],cert:[],certif:3,certificate_verify_failed:3,chang:[0,3],check:3,clean:3,click:2,clone:3,close:4,cluster:[],cluster_connect:4,cluster_health:4,cluster_host:4,cluster_ip:4,cluster_nam:4,cluster_name:4,cluster_port:4,cluster_schem:4,cluster_vers:4,code:[0,3,4],collect:4,com:3,come:3,comma:4,command:[],comment:3,commonli:2,commun:[3,4],complet:4,complianc:3,compos:0,condens:4,conditions:3,conf:3,config:3,confirm:3,connect:[],consider:3,consol:3,contain:[],control:[0,3],copi:[3,4],copyright:3,cover:[],coverag:0,creat:[0,4],credenti:[0,3],crt:3,curl:3,current:[3,4],current_stable_vers:4,custom:0,cycl:0,dai:3,data:[3,4],date:0,datetim:[],db_name:3,debug:[],definit:3,delayed_unassigned_shard:4,delet:[3,4],delimit:4,deploi:3,depth:[],destin:4,destination_index:4,destination_index_nam:4,detach:3,detail:4,dev:[],dict:4,did:3,differ:0,direct:2,directli:[1,3,4],directori:[],directory:3,disabl:3,disk:4,displai:3,doc:[0,3,4],dockerhub:[],doe:4,doesn:4,domain:3,down:0,download:3,easi:3,easier:0,edit:[],effect:0,either:[3,4],elast:[3,4],elastichq:[],elasticsearch:[0,2,3,4],enabl:3,end:0,endpoint:[2,4],enough:3,enter:3,entir:0,entri:1,environ:[],error:[],es_v2:4,esv:0,etc:3,even:4,event:[0,3],eventlet:3,everyth:3,evil:3,exampl:4,except:3,exec:3,execut:4,exist:4,expect:3,expir:3,expirat:3,expos:3,express:3,fail:3,failur:3,fals:[3,4],featur:[],feel:1,field:3,file:[0,3],find:3,first:0,fix:0,flag:3,flask:[0,3,4],flush:4,follow:3,foo:[],footer:3,forc:4,form:[0,3],format:[0,3],formerli:4,forum:[1,2],found:[3,4],free:1,freeli:2,frequent:1,from:4,further:3,futur:3,gener:[0,4],get:[],gitflow:3,github:[0,1,3,4],given:4,gmt:0,govern:3,guarante:0,guidelin:0,gunicorn:3,handler:[],happen:3,hasn:3,have:[0,1,3],help:1,here:3,homepag:2,host:[3,4],hq_ca_certs:3,hq_debug:3,hq_default_url:3,hq_enable_ssl:3,hq_verify_certs:3,html:[0,4],htmlcov:0,htmlout11:[],htmlout:0,https:4,imag:3,immedi:0,implemen:[],implement:3,impli:3,includ:[0,2],index:[],index_nam:4,indic:[2,4],individu:0,info:[],inform:[3,4],informat:3,initi:3,initializing_shard:4,input:3,instal:[0,3],installed_vers:4,instanc:3,instanceid:[],instruct:1,integr:[0,3],integrat:[],interfac:4,internal:4,issu:3,itself:3,jan:0,join:3,json:[0,3,4],just:4,kept:3,kill_es_vers:0,kind:3,known:4,languag:3,larg:4,law:3,left:[],length:0,level:3,librari:0,licens:[],license:3,like:3,limit:3,line:[],list:[],load:3,local:0,localhost:[0,1,3,4],locat:3,logfil:3,logger:3,made:3,mai:[3,4],major:[0,3],major_version:0,manag:[0,2,3],mani:[2,4],manual:[],mapping_nam:4,mapping_onli:4,master:[3,4],match:3,max:0,merg:4,messag:4,meta:3,method:[0,4],methodolog:3,metric:3,millisecond:0,modifi:[],monitor:2,most:3,multithread:3,must:3,name:[0,3,4],navig:[0,3],necessari:3,need:0,net:3,network:3,next:3,node:[],node_id:4,normal:0,npm:0,number:3,number_of_data_nod:4,number_of_in_flight_fetch:4,number_of_nod:4,number_of_pending_task:4,number_of_replica:4,number_of_shard:4,obtain:3,offer:3,onc:0,once:0,one:[2,4],onli:4,open:4,option:[3,4],options:0,org:[3,4],organ:3,origin:[0,3],other:[],otherwis:4,our:3,out:[3,4],output:[0,3],over:3,pack:[],param:[],pass:[3,4],password:3,patch:[],path:[0,3],payload:4,pend:[],perform:0,permiss:3,ping:4,pip:[0,3],plain:3,platform:2,pleas:0,pocoo:4,point:3,pool:4,port:[0,3,4],possibl:4,post:[0,4],prefer:[0,3],prefix:[],preserv:[],pretti:3,prioriti:0,process:3,progress:[],project:[],proper:3,prune:0,pull:4,purchas:3,put:[0,4],pytest:0,python3:3,python:[0,3],question:[1,3],reach:3,reachabl:3,read:[0,3],readme:[],realiz:3,reason:[0,3],receiv:0,recommend:3,reconnect:3,recreat:3,refer:[],refresh:[0,4],reindex_opt:4,reload:3,relocating_shard:4,rememb:[],remov:[],repo:0,report:0,repositori:[],repository_nam:4,request:[0,4],requir:[],respect:[],response_tim:4,rest:[],retriev:3,right:[],roadmap:2,roi:3,root:[0,3],royrusso:[],rule:4,run_es_vers:0,run_test:[],runserv:3,russo:3,same:[2,3],save:[2,4],scheme:3,screen:3,script:[0,3],sdsd:[],searchabl:4,section:3,secur:3,sed:3,see:[1,3],segment:4,self:3,semant:3,separ:0,serv:[0,2],server:[0,3,4],set:[],sever:[3,4],shard:[],ship:3,should:[0,3],shutdown:[],sign:3,signer:3,silent:3,simpli:[3,4],sinc:2,singl:3,site:0,slate:3,snippet:4,softwar:[2,3],some:3,sourc:[0,3,4],source_index:4,source_index_nam:4,specif:[0,3],specifi:3,sphinx:0,sqlalchemy_database_uri:3,sqlite:3,sqllite:3,src:3,ssl:[],stabl:3,standard:[0,3],standard_handl:[],start:[],start_clust:[],starttim:[],status_cod:4,still:0,stop:0,storag:[],store:3,string:4,success:4,suggest:1,suit:0,supervisor:3,supervisord:3,support:3,tag:[],take:[0,3],taken:4,task_max_waiting_in_queue_milli:4,templat:0,termin:3,text:3,thank:3,thei:[],them:0,thi:[0,1,3,4],those:3,thread:3,through:0,thru:4,time:[0,2,3,4],timed_out:4,todo:[],took:0,trigger:4,trust:3,txt:[0,3],type:[0,4],typic:0,unassigned_shard:4,under:[0,1,2,3],uninstal:3,unless:3,unstabl:[0,3],until:0,updatetim:[],upgrad:3,uploadpolici:[],uploadpolicysignatur:[],url:[3,4],usag:3,use_ssl:4,user:[],usernam:3,username:3,v5_docker:[],valid:3,validate_cert:3,valu:3,vari:4,veri:0,verif:3,verifi:3,verify_cert:3,version:[],via:[3,4],view:[],virtual:[],volum:3,wait:[],want:3,warn:[],warning:4,warranties:3,websit:3,websocket:3,wed:0,welcom:0,well:3,werkzeug:0,when:[3,4],where:3,whether:[3,4],which:0,window:3,wish:[0,3],within:3,without:3,work:[],worker:3,working:3,wrapper:4,write:[3,4],wsgi:3,www:[3,4],xget:3,yellow:4,yml:[],you:[0,1,3,4],your:[3,4]},titles:["For Developers","FAQ","ElasticHQ Documentation","Getting Started","REST API"],titleterms:{"true":0,across:3,alia:4,api:4,bug:0,build:0,cert:3,cluster:4,command:[3,4],configur:3,connect:[3,4],contain:3,content:[0,1,3,4],contribut:0,dashboard:[],databas:3,debug:0,develop:0,diagnos:3,diagnost:4,directori:[],distribut:0,docker:3,dockerhub:0,document:[0,2],elastichq:[1,2,3],environ:[0,3],error:3,external:3,faq:1,featur:2,from:0,get:3,guid:3,header:0,health:4,how:1,http:0,image:3,index:4,indice:4,info:4,initial:3,install:[0,3],installat:3,integrat:3,issue:0,kei:2,latest:3,licens:3,line:3,list:4,log:3,login:3,main:[],manual:0,map:4,minor:3,node:4,note:0,openshift:3,other:[],overview:2,pack:3,paramet:3,patch:3,pre:[0,3],preserv:3,product:3,project:2,pull:0,quick:3,refer:[],reindex:4,releas:[0,3],remov:[],repositori:4,requir:3,resourc:[],respons:0,rest:4,restart:3,rout:4,run:[0,3],set:0,shard:4,snapshot:4,ssl:3,start:3,startup:[],stat:4,state:4,statu:[0,4],structur:[],summari:4,tabl:[0,1,3,4],tag:0,test:0,troubleshoot:3,upgrade:3,user:[],using:1,variabl:3,version:3,view:3,work:3}}) \ No newline at end of file +Search.setIndex({envversion:50,filenames:["developer-guide","faq","index","installation","rest-api"],objects:{"":{"/api/clusters":[4,0,1,"get--api-clusters"],"/api/clusters/(string:cluster_name)/_connect":[4,2,1,"post--api-clusters-(string-cluster_name)-_connect"],"/api/clusters/(string:cluster_name)/_health":[4,0,1,"get--api-clusters-(string-cluster_name)-_health"],"/api/clusters/(string:cluster_name)/_state":[4,0,1,"get--api-clusters-(string-cluster_name)-_state"],"/api/clusters/(string:cluster_name)/_summary":[4,0,1,"get--api-clusters-(string-cluster_name)-_summary"],"/api/clusters/(string:cluster_name)/diagnostics/_summary":[4,0,1,"get--api-clusters-(string-cluster_name)-diagnostics-_summary"],"/api/clusters/_connect":[4,2,1,"post--api-clusters-_connect"],"/api/indices/(string:cluster_name)":[4,2,1,"post--api-indices-(string-cluster_name)"],"/api/indices/(string:cluster_name)/(string:index_name)":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)"],"/api/indices/(string:cluster_name)/(string:index_name)/(string:alias_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)-(string-alias_name)-_aliases"],"/api/indices/(string:cluster_name)/(string:index_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)-_aliases"],"/api/indices/(string:cluster_name)/(string:index_name)/_mapping":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_name)-_mapping"],"/api/indices/(string:cluster_name)/(string:index_name)/_mapping/(string:mapping_name)":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_name)-_mapping-(string-mapping_name)"],"/api/indices/(string:cluster_name)/(string:index_name)/action/(string:action)":[4,3,1,"put--api-indices-(string-cluster_name)-(string-index_name)-action-(string-action)"],"/api/indices/(string:cluster_name)/(string:index_names)/_shards":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_shards"],"/api/indices/(string:cluster_name)/(string:index_names)/_stats":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_stats"],"/api/indices/(string:cluster_name)/(string:index_names)/_summary":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_summary"],"/api/indices/(string:cluster_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-_aliases"],"/api/indices/(string:cluster_name)/_reindex":[4,2,1,"post--api-indices-(string-cluster_name)-_reindex"],"/api/indices/(string:cluster_name)/_shards":[4,0,1,"get--api-indices-(string-cluster_name)-_shards"],"/api/indices/(string:cluster_name)/_stats":[4,0,1,"get--api-indices-(string-cluster_name)-_stats"],"/api/indices/(string:cluster_name)/_summary":[4,0,1,"get--api-indices-(string-cluster_name)-_summary"],"/api/indices/(string:cluster_name)/action/(string:action)":[4,3,1,"put--api-indices-(string-cluster_name)-action-(string-action)"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_info":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_info"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_stats":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_stats"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_summary":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_summary"],"/api/nodes/(string:cluster_name)/_info":[4,0,1,"get--api-nodes-(string-cluster_name)-_info"],"/api/nodes/(string:cluster_name)/_stats":[4,0,1,"get--api-nodes-(string-cluster_name)-_stats"],"/api/nodes/(string:cluster_name)/_summary":[4,0,1,"get--api-nodes-(string-cluster_name)-_summary"],"/api/repositories/(string:cluster_name)":[4,0,1,"get--api-repositories-(string-cluster_name)"],"/api/rest/(string:cluster_name)/(string:command)":[4,0,1,"get--api-rest-(string-cluster_name)-(string-command)"],"/api/routes":[4,0,1,"get--api-routes"],"/api/snapshots/(string:cluster_name)/repository/(string:repository_name)":[4,0,1,"get--api-snapshots-(string-cluster_name)-repository-(string-repository_name)"],"/api/status":[4,0,1,"get--api-status"]}},objnames:{"0":["http","get","HTTP get"],"1":["http","delete","HTTP delete"],"2":["http","post","HTTP post"],"3":["http","put","HTTP put"]},objtypes:{"0":"http:get","1":"http:delete","2":"http:post","3":"http:put"},terms:{"boolean":4,"byte":[],"case":0,"class":3,"default":[0,3],"delete":[0,4],"final":0,"long":3,"new":[0,1,4],"null":4,"return":[0,4],"static":0,"true":[],"while":0,_alias:4,_cach:4,_close:4,_cluster:3,_connect:4,_expunge_delet:4,_flush:4,_force_merg:4,_health:4,_info:4,_map:4,_open:4,_optim:4,_refresh:4,_reindex:4,_shard:4,_sqlalchemy_database_uri:3,_stat:4,_state:4,_summari:4,about:[1,4],accept:[3,4],access:[0,1,2,3],accomplish:0,across:[],action:4,activ:4,active_primary_shard:4,active_shard:4,active_shards_percent_as_numb:4,actual:4,add:4,address:4,adher:3,adjust:3,admin:3,advanc:3,advis:3,again:0,against:[0,3],age:0,agre:3,alias:[2,4],alias_nam:4,all:[0,4],allow:[0,3],along:3,alreadi:4,also:4,alter:3,altern:3,alwai:3,ani:[0,2,3],any:3,apach:[2,3],api:[],appear:0,applic:[0,2,3,4],applicaiton:0,arg:3,argument:3,around:4,asked:1,assum:3,attempt:3,attent:0,auth:3,authent:[1,3],author:3,automat:0,avail:[2,3,4],awsaccesskeyid:[],bad:4,base:3,basepath:3,basic:3,basis:3,been:3,befor:0,below:0,between:3,bin:[],binari:[],blob:[],block:3,body:4,both:4,branch:[0,3],bring:0,broadcast:3,browser:3,bucket:[],built:0,bundl:0,bundleid:[],bundletask:[],bundletaskerror:[],cacert:[],cach:4,call:[3,4],can:[0,1,2,3,4],candid:3,caus:[0,3],ccelastichq:[],cert:[],certif:3,certificate_verify_failed:3,chang:[0,3],check:3,clean:3,click:2,clone:3,close:4,cluster:[],cluster_connect:4,cluster_health:4,cluster_host:4,cluster_ip:4,cluster_nam:4,cluster_name:4,cluster_port:4,cluster_schem:4,cluster_vers:4,code:[0,3,4],collect:4,com:3,come:3,comma:4,command:[],comment:3,commonli:2,commun:[3,4],complet:4,complianc:3,compos:0,condens:4,conditions:3,conf:3,config:3,confirm:3,connect:[],consider:3,consol:3,contain:[],control:[0,3],copi:[3,4],copyright:3,cover:[],coverag:0,creat:[0,4],credenti:[0,3],crt:3,curl:3,current:[3,4],current_stable_vers:4,custom:0,cycl:0,dai:3,data:[3,4],date:0,datetim:[],db_name:3,debug:[],definit:3,delayed_unassigned_shard:4,delet:[3,4],delimit:4,deploi:3,depth:[],destin:4,destination_index:4,destination_index_nam:4,detach:3,detail:4,dev:[],dict:4,did:3,differ:0,direct:2,directli:[1,3,4],directori:[],directory:3,disabl:3,disk:4,displai:3,doc:[0,3,4],dockerhub:[],doe:4,doesn:4,domain:3,down:0,download:3,easi:3,easier:0,edit:[],effect:0,either:[3,4],elast:[3,4],elastichq:[],elasticsearch:[0,2,3,4],enabl:3,end:0,endpoint:[2,4],enough:3,enter:3,entir:0,entri:1,environ:[],error:[],es_v2:4,esv:0,etc:3,even:4,event:[0,3],eventlet:3,everyth:3,evil:3,exampl:[],except:3,exec:3,execut:4,exist:4,expect:3,expir:3,expirat:3,expos:3,express:3,fail:3,failur:3,fals:[3,4],featur:[],feel:1,field:3,file:[0,3],find:3,first:0,fix:0,flag:3,flask:[0,3,4],flush:4,follow:3,foo:[],footer:3,forc:4,form:[0,3],format:[0,3],formerli:4,forum:[1,2],found:[3,4],free:1,freeli:2,frequent:1,from:[],further:3,futur:3,gener:[0,4],get:[],gitflow:3,github:[0,1,3,4],given:4,gmt:0,govern:3,guarante:0,guidelin:0,gunicorn:3,handler:[],happen:3,hasn:3,have:[0,1,3],help:1,here:3,homepag:2,host:[3,4],hq_ca_certs:3,hq_debug:3,hq_default_url:3,hq_enable_ssl:3,hq_verify_certs:3,html:[0,4],htmlcov:0,htmlout11:[],htmlout:0,https:4,imag:3,immedi:0,implemen:[],implement:3,impli:3,includ:[0,2],index:[],index_nam:4,indic:[2,4],individu:0,info:[],inform:[3,4],informat:3,initi:3,initializing_shard:4,input:3,instal:[0,3],installed_vers:4,instanc:3,instanceid:[],instruct:1,integr:[0,3],integrat:[],interfac:4,internal:4,issu:3,itself:3,jan:0,join:3,json:[0,3,4],just:4,kept:3,kill_es_vers:0,kind:3,known:4,languag:3,larg:4,law:3,left:[],length:0,level:3,librari:0,licens:[],license:3,like:3,limit:3,line:[],list:[],load:3,local:0,localhost:[0,1,3,4],locat:3,logfil:3,logger:3,made:3,mai:[3,4],major:[0,3],major_version:0,manag:[0,2,3],mani:[2,4],manual:[],mapping_nam:4,mapping_onli:4,master:[3,4],match:3,max:0,merg:4,messag:4,meta:3,method:[0,4],methodolog:3,metric:3,millisecond:0,modifi:[],monitor:2,most:3,multithread:3,must:3,name:[0,3,4],navig:[0,3],necessari:3,need:0,net:3,network:3,next:3,node:[],node_id:4,normal:0,npm:0,number:3,number_of_data_nod:4,number_of_in_flight_fetch:4,number_of_nod:4,number_of_pending_task:4,number_of_replica:4,number_of_shard:4,obtain:3,offer:3,onc:0,once:0,one:[2,4],onli:4,open:4,option:[3,4],options:0,org:[3,4],organ:3,origin:[0,3],other:[],otherwis:4,our:3,out:[3,4],output:[0,3],over:3,pack:[],param:[],pass:[3,4],password:3,patch:[],path:[0,3],payload:4,pend:[],perform:0,permiss:3,ping:4,pip:[0,3],plain:3,platform:2,pleas:0,pocoo:4,point:3,pool:4,port:[0,3,4],possibl:4,post:[0,4],prefer:[0,3],prefix:[],preserv:[],pretti:3,prioriti:0,process:3,progress:[],project:[],proper:3,prune:0,pull:[],purchas:3,put:[0,4],pytest:0,python3:3,python:[0,3],question:[1,3],reach:3,reachabl:3,read:[0,3],readme:[],realiz:3,reason:[0,3],receiv:0,recommend:3,reconnect:3,recreat:3,refer:[],refresh:[0,4],reindex_opt:4,reload:3,relocating_shard:4,rememb:[],remov:[],repo:0,report:0,repositori:[],repository_nam:4,request:[0,4],requir:[],respect:[],response_tim:4,rest:[],retriev:3,right:[],roadmap:2,roi:3,root:[0,3],royrusso:[],rule:4,run_es_vers:0,run_test:[],runserv:3,russo:3,same:[2,3],save:[2,4],scheme:3,screen:3,script:[0,3],sdsd:[],searchabl:4,section:3,secur:3,sed:3,see:[1,3],segment:4,self:3,semant:3,separ:0,serv:[0,2],server:[0,3,4],set:[],sever:[3,4],shard:[],ship:3,should:[0,3],shutdown:[],sign:3,signer:3,silent:3,simpli:[3,4],sinc:2,singl:3,site:0,slate:3,snippet:4,softwar:[2,3],some:3,sourc:[],source_index:4,source_index_nam:4,specif:[0,3],specifi:3,sphinx:0,sqlalchemy_database_uri:3,sqlite:3,sqllite:3,src:3,ssl:[],stabl:3,standard:[0,3],standard_handl:[],start:[],start_clust:[],starttim:[],status_cod:4,still:0,stop:0,storag:[],store:3,string:4,success:4,suggest:1,suit:0,supervisor:3,supervisord:3,support:3,tag:[],take:[0,3],taken:4,task_max_waiting_in_queue_milli:4,templat:0,termin:3,text:3,thank:3,thei:[],them:0,thi:[0,1,3,4],those:3,thread:3,through:0,thru:4,time:[0,2,3,4],timed_out:4,todo:[],took:0,trigger:4,trust:3,txt:[0,3],type:[0,4],typic:0,unassigned_shard:4,under:[0,1,2,3],uninstal:3,unless:3,unstabl:[0,3],until:0,updatetim:[],upgrad:3,uploadpolici:[],uploadpolicysignatur:[],url:[3,4],usag:3,use_ssl:4,user:[],usernam:3,username:3,v5_docker:[],valid:3,validate_cert:3,valu:3,vari:4,veri:0,verif:3,verifi:3,verify_cert:3,version:[],via:[3,4],view:[],virtual:[],volum:3,wait:[],want:3,warn:[],warning:4,warranties:3,websit:3,websocket:3,wed:0,welcom:0,well:3,werkzeug:0,when:[3,4],where:3,whether:[3,4],which:0,window:3,wish:[0,3],within:3,without:3,work:[],worker:3,working:3,wrapper:4,write:[3,4],wsgi:3,www:[3,4],xget:3,yellow:4,yml:[],you:[0,1,3,4],your:[3,4]},titles:["For Developers","FAQ","ElasticHQ Documentation","Getting Started","REST API"],titleterms:{"true":0,across:3,alia:4,api:4,bug:0,build:0,cert:3,cluster:4,command:[3,4],configur:3,connect:[3,4],contain:3,content:[0,1,3,4],contribut:0,dashboard:[],databas:3,debug:0,develop:0,diagnos:3,diagnost:4,directori:[],distribut:0,docker:3,dockerhub:0,document:[0,2],elastichq:[1,2,3],environ:[0,3],error:3,exampl:3,external:3,faq:1,featur:2,from:[0,3],get:3,guid:3,header:0,health:4,how:1,http:0,image:[],index:4,indice:4,info:4,initial:3,install:[0,3],installat:[],integrat:3,issue:0,kei:2,latest:3,licens:3,line:3,list:4,log:3,login:3,main:[],manual:0,map:4,minor:3,node:4,note:0,openshift:3,other:[],overview:2,pack:3,paramet:3,patch:3,pre:[0,3],preserv:3,product:3,project:2,pull:0,quick:3,refer:[],reindex:4,releas:[0,3],remov:[],repositori:4,requir:3,resourc:[],respons:0,rest:4,restart:3,rout:4,run:[0,3],set:0,shard:4,snapshot:4,sourc:3,ssl:3,start:3,startup:[],stat:4,state:4,statu:[0,4],structur:[],summari:4,tabl:[0,1,3,4],tag:0,test:0,troubleshoot:3,upgrade:3,user:[],using:1,variabl:3,version:3,view:3,work:3}}) \ No newline at end of file diff --git a/docs/source/_templates/globaltoc.html b/docs/source/_templates/globaltoc.html new file mode 100644 index 00000000..b908e355 --- /dev/null +++ b/docs/source/_templates/globaltoc.html @@ -0,0 +1,14 @@ + +
+
+

{{ _('Table Of Contents') }}

+
+
+ {% set toctree = toctree(maxdepth=3, collapse=True, includehidden=True) %} + {% if toctree %} + {{ toctree }} + {% else %} + {{ toc }} + {% endif %} +
+
diff --git a/docs/source/conf.py b/docs/source/conf.py index bd99b45c..ec1c4757 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,18 +1,19 @@ -import sys import os +import sys # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath(".")) -print(os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0]+os.sep+'') -sys.path.insert(0, os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0]+os.sep+'') -sys.path.insert(0, os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0]+os.sep+'elastichq') +print(os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0] + os.sep + '') +sys.path.insert(0, os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0] + os.sep + '') +sys.path.insert(0, + os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0] + os.sep + 'elastichq') # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -24,11 +25,11 @@ 'sphinxcontrib.httpdomain', 'sphinxcontrib.autohttp.flask', 'sphinxcontrib.autohttp.flaskqref' - #'sphinxcontrib.fulltoc' + # 'sphinxcontrib.fulltoc' ] # http://sphinxcontrib-httpdomain.readthedocs.io/en/stable/#module-sphinxcontrib.httpdomain - + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -36,7 +37,7 @@ source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -44,7 +45,7 @@ # General information about the project. project = 'ElasticHQ' copyright = '2018, ElasticHQ' -author= 'Roy Russo' +author = 'Roy Russo' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -61,9 +62,9 @@ # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -71,7 +72,7 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -88,10 +89,10 @@ pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- Options for HTML output ---------------------------------------------- @@ -100,9 +101,6 @@ # otherwise, readthedocs.org uses their theme by default, so no need to specify it import guzzle_sphinx_theme -# Register the theme as an extension to generate a sitemap.xml -extensions.append("guzzle_sphinx_theme") - # Guzzle theme options (see theme.conf for more information) html_theme_path = guzzle_sphinx_theme.html_theme_path() html_theme = 'guzzle_sphinx_theme' @@ -114,29 +112,29 @@ html_theme_options = { # Set the path to a special layout to include for the homepage - #"index_template": "special_index.html", + # "index_template": "special_index.html", # Set the name of the project to appear in the left sidebar. "project_nav_name": "ElasticHQ", # Set your Disqus short name to enable comments - #"disqus_comments_shortname": "my_disqus_comments_short_name", + # "disqus_comments_shortname": "my_disqus_comments_short_name", # Set you GA account ID to enable tracking "google_analytics_account": "UA-40876494-1", # Path to a touch icon - #"touch_icon": "", + # "touch_icon": "", # Specify a base_url used to generate sitemap.xml links. If not # specified, then no sitemap will be built. "base_url": "", # Allow a separate homepage from the master_doc - #"homepage": "index", + # "homepage": "index", # Allow the project link to be overriden to a custom URL. - #"projectlink": "http://myproject.url", + # "projectlink": "http://myproject.url", } # on_rtd = os.environ.get('READTHEDOCS', None) == 'True' @@ -147,31 +145,31 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -#html_theme = 'sphinx_rtd_theme' +# html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -181,93 +179,95 @@ # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} +html_sidebars = { + '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html'] +} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'elastichq' - # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'elastichq.tex', 'ElasticHQ Documentation', - 'Roy Russo', 'manual'), + ('index', 'elastichq.tex', 'ElasticHQ Documentation', + 'Roy Russo', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- @@ -280,7 +280,7 @@ ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -289,19 +289,19 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'elastichq', 'ElasticHQ Documentation', - 'Roy Russo', 'elastichq', 'Managament and monitoring for Elasticsearch clusters', - 'Miscellaneous'), + ('index', 'elastichq', 'ElasticHQ Documentation', + 'Roy Russo', 'elastichq', 'Managament and monitoring for Elasticsearch clusters', + 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 833b57b5..8c1ccfc2 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -3,23 +3,46 @@ Getting Started =============== .. contents:: Table of Contents - :depth: 3 + :depth: 2 :local: - - Quick-Start Guide ----------------- +1. :any:`docker images` +2. :any:`run from source` + +.. _docker images: + +Running with Docker +------------------- + +Docker images are offered on the `ElasticHQ Dockerhub `_. + +Run with: + +.. code-block:: bash + + docker run -p 5000:5000 elastichq/elasticsearch-hq + +Access HQ with: http://localhost:5000 + +When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag. + +ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'`` + +.. note:: The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch. -Installation ------------- +.. _run from source: + +Install from Source +------------------- Requirements ^^^^^^^^^^^^ * Python 3.4+ -* Elasticsearch. Supported versions: 2.x, 5.x, 6.x +* Elasticsearch. Supported versions: 2.x, 5.x, 6.x, 7.x Install ElasticHQ ^^^^^^^^^^^^^^^^^ @@ -31,24 +54,6 @@ Install ElasticHQ .. note:: Alternatively, you can start the server with ``python manage.py runserver`` -.. _docker images: - -Docker Images -^^^^^^^^^^^^^ - -Docker images are offered on the `ElasticHQ Dockerhub `_. - -The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch. - -When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag. - -ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'`` - -To run/install container: - -``docker run -p 5000:5000 elastichq/elasticsearch-hq`` - -Access HQ with: http://localhost:5000 Pre-Releases ^^^^^^^^^^^^ @@ -103,6 +108,15 @@ The ``application.py`` start script takes parameters passed in as arguments from ``--verify_certs`` True Whether HQ should attempt to validate certs. Set to False for self-signed certs. ================== ========================= ================================================================================ +Example: +======== + +.. code-block:: bash + + python -m application + --enable-ssl + --ca-certs /path/to/your/ca.crt + .. _environment variables: Environment Variables @@ -118,6 +132,14 @@ Environment Variables ``HQ_DEBUG`` False If True, enables debug level on logging. =================== ========================= ================================================================================ +Example: +======== + +.. code-block:: bash + + docker run -p 5000:5000 elastichq/elasticsearch-hq + -e HQ_DEFAULT_URL='http://aa.com:1212' + -e HQ_ENABLE_SSL=False Logging ^^^^^^^ diff --git a/sphinx-requirements.txt b/sphinx-requirements.txt index d669885f..dd55413e 100644 --- a/sphinx-requirements.txt +++ b/sphinx-requirements.txt @@ -1,6 +1,6 @@ # Docs Sphinx>=1.3.0,<1.5.0 -guzzle_sphinx_theme>=0.7.8,<0.8.0 +guzzle_sphinx_theme sphinxcontrib-httpdomain==1.6.0 ### Removed fulltoc - not working with py3.6 From 5d605873c5601ee2c263ef39cee96d737862e111 Mon Sep 17 00:00:00 2001 From: royrusso Date: Thu, 26 Sep 2019 15:01:48 -0400 Subject: [PATCH 2/4] - updates to docs and readme --- docs/.doctrees/environment.pickle | Bin 33624 -> 33624 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle index dab97a47326290f25d4c06761a08b4476e14c503..f0fb7c8b7ba217f30170e49e94d1118f5f42bb06 100644 GIT binary patch delta 623 zcmcc7#&n~NX+syg1#4zrN@~TF9{!ZnvecaXg4812^wP|f)G0m8X^DkXdN_(wi%WD9 z3o@tl@MPu{mn7!oB$j06=S@Du?yuG8?sz@fY3Iw0F&V88=7-*sr9C_;sRgM(WAl;4&}+I9M+Q$bJ(yp)=tT2-OR!{laaA;@;t8DjIEQc zxLa5oGj0Ke4|D6=0EGpk)h2JS(VFb+5ewuk^jOH)xY^nB08qzf7H>8X#qA>sq7;4I z8G#1C)cbNvO}^}B4HQ}EAvIak{}p5FW|06Rppwn*fuQ$mXh>}V! z2T_w!I6>5$R9~=M+AI*&ngLd_HB%eJdzfVnqGWSaL6mbYSgtq^to?QV1dw1&p%^1; zqc=-N>*VQ0_Miasl$iX!NI|J_Le^Fe1_of@W&oMn5zL)1=4QjODM}dBr7(IXQ_XnfZBBdYID^3#at3X6B`&R!r&PC`v6Z z(M>GKoP3DgU#rF4@p`h;diA2$8BGwT4)4Fx9-frcf>faTyyVQ(;wiOLG%{KyTXU$f zH1$u>nB2i(J$V6#EThrneH@OgEwxiJnl`g=&SYe4nLLkcHe=IdEAAH7mW*3K;ltee zHb7y)Xtl{3Y_ujjd&B~H3q2MxwrqCxJOI?OnZ=t8L~;9wf+$5_cSfKAF!jFNQj;(H zSp!8DdPq&y^nbU4q}h Date: Fri, 27 Sep 2019 11:05:23 -0400 Subject: [PATCH 3/4] Fixes #493 --- elastichq/api/nodes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/elastichq/api/nodes.py b/elastichq/api/nodes.py index f2faa160..723f8af1 100644 --- a/elastichq/api/nodes.py +++ b/elastichq/api/nodes.py @@ -17,7 +17,7 @@ def get(self, cluster_name, node_ids=None): both the info and stats APIs. """ - response = NodeService().get_node_summary(cluster_name, node_ids) + response = NodeService().get_node_summary(cluster_name) return APIResponse(response, HTTP_Status.OK, None) From 0ebdc27f922fcafd7435fa1928367e141b4211de Mon Sep 17 00:00:00 2001 From: royrusso Date: Fri, 27 Sep 2019 11:07:42 -0400 Subject: [PATCH 4/4] rev release --- elastichq/config/settings.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/elastichq/config/settings.py b/elastichq/config/settings.py index 1f5c2775..1a4064bf 100644 --- a/elastichq/config/settings.py +++ b/elastichq/config/settings.py @@ -62,7 +62,7 @@ class TestSettings(BaseSettings): # static HQ_SITE_URL = 'http://elastichq.org' HQ_GH_URL = 'https://github.com/ElasticHQ/elasticsearch-HQ' - API_VERSION = 'v3.5.2' + API_VERSION = 'v3.5.3' ES_TEST_INDEX_NAME = 'cars' @@ -105,7 +105,7 @@ class ProdSettings(BaseSettings): # static HQ_SITE_URL = 'http://elastichq.org' HQ_GH_URL = 'https://github.com/ElasticHQ/elasticsearch-HQ' - API_VERSION = '3.5.2' + API_VERSION = '3.5.3' SERVER_NAME = None # cluster settings: specific settings for each cluster and how HQ should handle it.
Parameters:
  • cluster_name –
  • index_name –
    • -
  • alias_name (string) – Alias to delete