From fa0fa7210edd2ee0e6496ea3ee159763f19f2fff Mon Sep 17 00:00:00 2001 From: Giorgos Verigakis Date: Tue, 29 Nov 2011 17:19:59 +0200 Subject: [PATCH] Add documentation material from old wiki --- docs/images/kamaki-logo.png | Bin 0 -> 8063 bytes docs/index.rst | 7 +++++- docs/overview.rst | 51 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 docs/images/kamaki-logo.png create mode 100644 docs/overview.rst diff --git a/docs/images/kamaki-logo.png b/docs/images/kamaki-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..90c1bc01da4772accc0dad6122ffcdbbee310bee GIT binary patch literal 8063 zcmb_>hd-5n*gq0d_D*Fa2^o<+k7Fi;IQGiQu}8MDXOirdm1OTtILL?ySxJP--Xr6= z&i8r#g5T?hm)q;O&wcLu`drt0eIhi}6iJA$664_DkSHr5HF0ooU%}r`hzQ{K`+lou za3C;$poqjd$9}(UDTv3xVG>kE%4&P2uVr{?XzNaOXF1rsl|_2sKSE9l-BWl|qwUc@C=d%jE0EQK+I0;M3$rBO75oQ#>ABTp{{H=2Za*#5ob?37M)@=A z{N(nQ`@e$?Yw8TM&d^7=*&5v8eSIo<1qA}NcMa>mpz-rMV~jSxG(UAc9qx3%QN%NM zW+_e+cC4i!!`a-~35trkOm;H|O3;sCy%-!J<#+5PK}j5fs6cb8U_VSlQ*&ggQHc%V z<|g=mCwArFvq?)cJ*|NUTL0ekb(024N6!#N`HE54fzSASE{IIz#wB zFT6Ssv9x6MCL!TxR}|g*k`nm`4=!tS(xC0_SrSx!E-eu_Iy#Doil*cRB&dXJZ@Xw~ zYrp;Qfw;`1E!2=F48oA5;Pc=j;$0I7tbv(hn1J}Ar%xlzJ1dz`u4r)S!~5% zWPE(QvAd2Eml`iG@8RKLb;In;Otjs%QkL7d3G?&wi`zDI3=Ivx6zTF}Fqn@&ewZxt zw?=6eV)jFVkRhlZMee2)8jI5$kzf=}r4=g%A*93M~r9X!(1 z45Z^VwmH=o78b@QB)rMZeT9O8;*}EHTI&*&(R2IPB?|*25+995SFdOBLJgeG&-~1r zpjND`tZv@#Dx?jLP2stZ@9~F?DeCCZ`kx(HoBw+&8x(DYr%|X~@3KhDW856B7<=Q- zUUXt2?WZUA;OCmC3%}=TrsSia(aTysgtE*^y0s`}qJY}(f2(AQ`Czh5h z0s>Uf?_w>qIL58M5tr$B<~l+yZ|?7R2VbK4()7$R9LbuIWyyU*(mNR5{%dj3_HOWo z*5k(^QFOfX^IcKDzhqw^AiEJwCVld1%pqW7R&sT=C9T5#d!u`x`kN2KHm_1sBd6;e zsW$Y=O4i)dVzhuiP9Qn0AkdwQh zmLV1b4;RfSOlr{`J^c5;&LLgQJ@ThgB|I=e<5!MB>+JKV4K)i0J;4huJP%&)9 zue9JkZ)uU7Us$NopQ_rLYrg;}mfPGs^LDvfQBRMd_594|3Zu{!0jq&IzpOkMp&tR~ zl2B*cYU`(hSJOpZ37|b;1sU=*?`+Kiu$uj7^@}DnAdzQ}|C#34+CJ0ZNE>DsT*UvSh>zf8;hJS{Cv)(_iaj6!I>2G8o8VH>CQ z8Bz31J%ziwd-`rK^5H`gA%__o?JdtFLb4mC3*9l%&ek}eK7IO_De0ridZPsJ4*jF` zy7f@zeLbd+j1|ZG(~i!6MsCGN_B6doN?I^EKc<6G7Wp$Y+U&hY47YH*mFe2`>lL0` z=2gb-DT|*>+WcdD4%TZLcy>3(hI1A5gh#q#7z=h3rkXx2y0EdcSMIk57Zq_eH#g7C z&u@?4%GKb|FfoY*+JFyebGNQwiSI2p>m(>PZkc+b#tv+N2ZVuz!xg{T*;yx7*Pz_o zn__Oip93yJW92k9UbVEeT=Ulh_Mlc)Rz_8rcb%`E!m1PBR?kE~OQ(#$2XG0is}mM; z|BD}i41{?c9UIGTZZ_ny2vW#xZ}t0U3NZQlOHclTq*s}lrSarblauY!(~JOfPEJnG zYijO~KE01cXc!g%(Gqq#mxgP-y}il8jyH}EHXJ|2wsYORdsj(WndNN2yn-HPPw=1i z1FJjC=$~ArZS~cQgBjw*CVVU`EXjOkfwM!7HZ~vMJxtp?+*YJJvSE+rH;%}?ZZ~pAmFA*~|G8%3R2mqkY0UR#2BA)x~ zvoPD@<9OYf4XQFSGGc0PZ(qCIKzdy)7}|<_`nGEF^H;CPp<}NOXvz%SJs9gx;*Cp9 zRXNcR6BoDm*%7klkE0CjaB{d1yA}y7)cx_r1%7}$_;kBdUs$4#A7!xcHdSr=skgVi zH~x0S{%0sW`gl# zQ^GzWQeK{7L)3LCdeGWvHa{mP(4FRDGeuQd+nN5#Sb8n=)ci_W8+OzfrtO|St)4QV z!~=wZQAWmxAX#O7eVgSox`oAY`EMUQR#PMO|Flev>cx59qo*?A81k)6}I;M{Ue)?d@YGCQuoOJJ5Nk zX3vUtomCy^yQQJ5SeO^STA*&jX3s}u)^!g1Lc+pS8xhgbNCYBKc3nmYL|lbwJ6<%C zbY?|H?7=H3Cgc7F9gGob@7}r@Vj9k=yhPIBRJjC3kPY z2M!8ZmQ&Ny3k$K*?6u2FOMmxffKX4){%v6P;cVZd#UuqPIZDquA2M%`{7Yh z0!PFzc?T3^lzwtmpt#>}KKAesvJ){IegB9c_Mk6;3p1kwpapo8C_5w^{OOaD+6bDD z-)T-JUP@X_EOl?R96Az(N>=W{syA~+gOgJ~SZ$Dl>gX&9ugcziiK))5lNtm8KE7$+n>z#towa6S zW*zuyWSjihK{vKC?3U2z2?mjCm&qaC1qu0aVz{z4!88P&iQrWse}DJ%d@j_v7^-!9v@Fd%WI5w zl4z)`e4YIIdvC8Yd8U`Owe=NxzUN=1fV#rf_$)fKUGr#oUgH2uP{oV>eI2&?cdQ6g zyS31Bc|JX`aK9>AR$2KH%ncGvMnYnFUlK)Z#lj52z8;t>ZNv28gY&un_Z5 zwE`6_A4SVxnUAE@#Gw~LC!3m=yqmdf+A%$y7XR6}c0xkec3j!wORWeBl%tA@3jH*A z3;eAVyxHR5dd}#)%b=UEoG!*}1m>lW+e|IFOI?ZB$waNgP38PgV*Z$^v9`fGCx1dAToj=Z9x#jj6s3V$Ay=*Y3h^Vil`rO;4@ zKA|0_DOEcFjY2V9uYVfX{dSEwSnv{V{b`zQ(3gGkd-v{v*-}MkN%=J@XFNy9ZQ^y% zwn8cC$Zj47Jbn5Ubi9gTpSQQS`E0Y7LfY_SU0td+wqR|FavGiI2gHAqmLC2E$}V#UcUTE~l+g>(Mc_uZSFVw_; zhl{Hdat*IP(}v{5&%yZ5wE8uDc9;6DD}B04)z{yzw{hq0-7e6R4_VpJRbKW(I8HIO zgUrOjbq4Wll_e86bKgt?EFUg7{2|f-2r7c~$GAhc?R1~f#l@w%Q5Xz$ zfqItEG5rMouf_f(g^eK%02k+lxDGN84-X90$m7S4uf-~ePYm3ACj(+)c`!p?_v^`@ zf-Ka~IO<*?4LM6g*$rv`XmHdkyQ$I9SH_Wc#~(d3G?I|shAbHVM=}z+?TSZc_H)O6 z5Kzc-UvCdq$wz2vzBau$@rFoKW}-va&=GZCNC>-b$!u}I$cJqNCu;2(?P`RL%&G)l ztG(a3l=eBLgDLOek-dG%Tq`~e@x{KrK9Lo5_IQeTwyB8;@}W5}kQV)kcLPaor4h># ze}d6ruvi8-N}qo0I8!fsg^YyZ9{#0EmyidMi0qHC(r53r619b3(!+Hgq^Ppjli1b1 zA)`Js70-fj1oKmAN|8O@S)b|@3|sVR&6N9OpGHzbLWR}4awPs8=Dfw5OzT`DR-Pah z`CXS(AvLK=JS{FPY)`yv5WT&~LmBZUSCOn+Cb_IxZw6bhzEm zJ1x=<4!lcWKpfj5Y8m(H&q3}}#S6?fxE2_t@#`jcgedTn0>=?ux@3mdDjNGVF!0M0 zIbhi0osewz66@`zM)%31y0B8v?yLb;o-_a{H(i&I>@1(8|;d@+w)jAjrB-3$7ruNwNKZp=nd>EXlshy4j9#_s<9 zQg+Tf*YFOc#TSX=(H%AmkNPxbe-w6vk%OzM2Hz>p?#>mgLvN;Ejiy>_g?8>?(o_-?in z7AMYDR|`UiuAKVHiMaiKWjaKqamEA==TWW##q`ehw&%3gzte*s&Z`sr#>Wnp5a{UB zR1p&qeJs|i3SR?f3j>kXB~}&9$sE}z)*Zlk_p2UJuiqXIcvDohP2BkXmwvv!<)9OF ztaTt&YObm^0tF$kMli7!W#QY?w$xN=P%<{6y)}L1MsGv#; z8X9auLorR_ZngL4Ygo;^iJ2M8*}os>EOZimZbg)+pp}@w6v+!S^M;o-qptW6#56M6Qs6)xw=k- z_etdW@L2O^bT`axBzM3_K*X3e;lKO)QO5Rqb5ucrb(5vwWn$uThwozXpIHF|qCg8~aQC}1I5#2tso)l$gPi>Qkgd!@t%42+a5+vNsVat%UMI(r@Qx1DTV1^eGCfnl zcqF95YMBxd8?FCdinMR-?RC{VFGPDM*0j&+e6<*_JY=~6uv8J!nwD}zO z0!oKy{LlKKm?8yxdwV-1d3sHcg&}<{HExN7;H9Idhp@$a58>p*2N7q4ReWmd zRfu$FT72ldyu8*1Kjv%RN#r#dysA%iPcDqKtIB%FX@6C(d%x+~#yrFu$@~@sJvRk- znlFdn3M-o}7)y~?p)=Cgj|6-GxcPf6iYBTnS-_eU@)l^_W>EKgEyMFj;cwAkl22st?bb^5MmfMQt$0*}s(r)Y8}m@oDvV4}&EIshv-PmWw?umQXz7uRKDW8-4Npb*jx zmg1ZoRzV@5+J+mHln7NLhe6-nVa4K~?`CFZ>X;P#uz`q9iGKdhKuLc7MUV@gCx`rz zk&%#US!h3g{DiwH|gV+5-YdjkcoKM-=aJ414@xc&dy1H1Tq%s9=B2g&%*5kii zZhuBX;?L@3pcIppmYCl12JtFS8uA+b&-AU8wY9bNn`2E%Y_B~s^kA=yz-wa-0ucye zi;bFSFA!YeOL-L>7G|+FRYNc3Td$m{{xb3Tu1-$n@}Xt3`7qeUq*O3)7!0x{L$3tJ z()8@)=y1JhgU@*$IUb}o#Y!7Ras7G>BqZD>t=HDq*9oNKSq<4JFDbmd7U9@-N?TD; z5gr{a*cY4!sEG}`T91|(VY7tZEU)91hzPxa^&nfVuC_L_sOaQsx*lr`g{%4~71~dT zl(gJ3*}eecof~SY5Nr~VUb87Sv+aWLjzKtcZFN;uKP<1b^yMCYT}w;La94Fs4j#;p z=jI%4ri52u60b?+(hVqFXj7ATqsLk#?C!u83?4qR=xgV|m`h`&@D$CA(QC}w0hi{L@#;n@f!LMIazJX}}XlFUvCuL)#Q0una`V0ez z0wOXp#Uvi1>U&Yp&E`hrbaZqjuA?4!iG5R0;%vk-Qh z0_d~xtxnO_vh;bw!*LWuZ^b5Uv-7&l2tGy9wA`QH=q{)VXjta(K&L4E}#QZUsCaf6(zD Tv}hJ~)Nz#M)sUqK)4=}$vr%(? literal 0 HcmV?d00001 diff --git a/docs/index.rst b/docs/index.rst index 5373599..c083d5d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,12 +6,16 @@ Kamaki project documentation ============================ -Kamaki is a simple, yet intuitive, command-line tool for managing clouds. Run +.. image:: /images/kamaki-logo.png + +./kamaki is a simple, yet intuitive, command-line tool for managing clouds. Run it without arguments to see a list of available commands. It is an initial implementation of the OpenStack Compute API, v1.1, with custom extensions specific to the Synnefo IaaS cloud management software. +./kamaki is open source and released under a 2-clause BSD Licence. + **Warning:** Kamaki is still a work in progress and can not yet authenticate with *Nova*. @@ -21,6 +25,7 @@ Contents: .. toctree:: :maxdepth: 2 + overview client diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..1ecc4bc --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,51 @@ +Overview +======== + +History +------- + +Here, at the `Greek Research and Technology Network `_, we have been developing an IaaS +cloud management software called **synnefo** (or **+nefo**) that is accessed and managed +via the OpenStack Compute API v1.1. We have also recently deployed synnefo in one of our +datacenters to provide the `~okeanos `_ IaaS service to the Greek Research and Academic +Community (currenty in alpha testing phase). + +From the early start, we needed a simple command-line tool to test the OpenStack API. +That's why we developed ./kamaki, which proved to be powerful and intuitive enough, +to be used not only for testing purposes but also as a complete Openstack Compute API v1.1 +client, able to manage our cloud from the command line. + +Once it proved so useful to us, we decided to open the source, so the community can benefit +from it, and ./kamaki can benefit from the community too. + + +Who uses ./kamaki? +------------------ + +./kamaki is currently used internally in GRNET by the development team to test the synnefo +software, by the deployment team who operates the ~okeanos service and by all the alpha +testers using the ~okeanos service and want to access the service from the command line. + + +Contributing and helping out +---------------------------- + +For the ./kamaki to improve and be useful to others too, your help is very important. +Any contributions and bug reports will be highly appreciated. Using ./kamaki and sending +us feedback is also a good start. + + +Community & Support +------------------- + +For any problems you may bump into while using ./kamaki or for help from the development +team please refer to the following links: + +* Feedback: kamaki-feedback@lists.grnet.gr +* Bug-reports: kamaki-bugs@lists.grnet.gr +* Support: kamaki-support@lists.grnet.gr +* Appear on the ./kamaki users section: kamaki-users@lists.grnet.gr + +Please be sure to have read the Documentation and check the known `issues `_ before +contacting the team. + -- 1.7.10.4