From b9c59caaabff27b904b8efead95969d27562dc14 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Mon, 1 Oct 2018 14:56:47 -0500 Subject: [PATCH] Update docs landing page to follow guideline During the rocky cycle, there was a docs-spec approved [0] with the goal of having a recommended consistent documentation landing page for all projects. This updates our docs landing page to follow the structure described in that recommendation. [0] http://specs.openstack.org/openstack/docs-specs/specs/rocky/front-page-template.html Change-Id: I0f31c59e6b39ab8d9c0009f72967c793dadbed64 --- doc/source/images/cinder.png | Bin 0 -> 5784 bytes doc/source/index.rst | 166 ++++++++++++++++++++++------------- 2 files changed, 106 insertions(+), 60 deletions(-) create mode 100644 doc/source/images/cinder.png diff --git a/doc/source/images/cinder.png b/doc/source/images/cinder.png new file mode 100644 index 0000000000000000000000000000000000000000..ccf18ae832938722664e9421325d495fe7a35a09 GIT binary patch literal 5784 zcma)gRa6uX(ESn;OLup(^a4stN`urQB7$_UEJ#XsFGvZjAV`OlEWNChxUe7~DJ=b? zmk#Um|9|+NzlWK7=FEMXd+wY$lVWcAhziIK1ONb32KqV{{}A>soXAN2t<4J!@OSg{aRmTG;X&DJAZ;hsQ4RNs6i?tbde~sotNn2r zhwHbR4+@qXexEi=Opbi2VV~Mp#5+^z??*nvvq0bz!pZ@ z^zREH?|mGe$UzNa;q{lU06F*TR|%5qzhQp8LRvYnv8+Khz?qm_ZcIj-xGZMv`6<@o zpMax zb;7x(9YMtp`Pf5B#2%6#3HTZ8-ccDsM)yw;UT1v^696Dg2mpwV0|0LS{=+>0AV>xP z*mnc~lnVg>7XO^*!+HP!W37RXrd7z&QE6zlYq0gG#_n~`bzfwkDb^()6DXHkl%1`k zPZn-2mP=UMDnUD_#VAVqcor?*pk+1GDsj)yNb)7oJx!}@Nhf$LTGW7-mQux~$R%en zyu12(-oNYXN${`D;I)H!wI4I!n8lO5?z!Kq2jOdd11D;`*J``LlU?uY-UPf%7E3B4 zZhJ$Iu`rY|5*w5ll=$#}EdM|Kf63AWDU(}+!TxIj=yAOrNP;wS*8vlj)>}3 ziV$un2VNd$mtd!V$YM`=!Ocs_J8Z&BP;QLl#Y^J8qW%)D_0=extF}Fq*4bi-VIk6X z;JZ#Ggwu)ZB~xAKCjQa?*h=gMhS+t9oM$TwowE~#^E+iJoXHVX1$n%sxL?@+t|WfXh~JFiL} zHuh9{_WaUJlLL!^(*^Kx|s%S{BJ8|Vh%s9R0{&4@i7sW~$ zRNA~}b}&6ggZ4(P*~+5XR)A6mU8Qam9fIZAk7eoLrc#)w;j!RESDE}8k3UF`MoT`K-$dq+Yc~HP>(r^ zljx5L?zR?k*RWn&EWUyib9*`=!^rmjMY2V+gvO*w zTa21?*Ly>iV8MjN#zIHA;;yq0HRrk?quUC6^9&OWkQ(=KsIGZ}71Q$Oz*V8uq+;1_ zcv&AXBAsyT=_l*Z-yKAU|J@gqlCf+KT&#r4M4R%R8Xo6)Ka%hdIpdwrviV3zGwJqg zeqGU&X^$vv)ulSQ?v{5v|fCmB-UcVVl)QT#j+l?G~Y`l$MxttEm0O)Nq7E~oL6 zsGpL!+Z0Pg*N1WJQG?Ty0BPmmsAWmtzKWWMIUsG>-u?Z^S6T53x7Y4mSrQ=|8~deHEJeaB>VPgLOC+)Mie2jEU35L}2?!3pV_nL1sV&iti zcyclZ2q)*Yrd0KH9-6LluiL&s!xg2Mtv_GOxJo8tLDv^xMaM;RvFHoFElA12riep* z1DT(FnA;VEDUlKB8=e=*fpI4td&~64UwPA;fjq6&UGdbo6RnC|%E$?G4WED>T&V-9 zmd0bMPVSP6(31q8=RPwFK-XN*oo;elWF8)6T3!G=)G#gCcalsf9=9y3XZ#= zLTlWIB1jWkN>`+|@i%9?pN;t6T_wxc_vvDl+UadHO!ZXhn^%ysJFRbr>(6i{6oS=I zvlovMU1IOOs0bsj9Me*+a+Hp5Dkilz-mD}M*kg#m)ReZ>d2>-xN-`8@cq^P&GxW2E zu@7OgwLmgiut{Y^$n#u`Sc`&H-5f*3X8mmvP`d>>p&u`9EQA>5^l?(BkN&fRd zNly(U1BU*GmV{o*=H=>lI*ZTGkE>WpkVbVBo$#23m2?*G&IZFta0ESmr8Kk zdaESH)I^Go^2u|R`|}b^pe=_YlRO@b%5f1UyR3W$7{!OzK!uCz`E`5uPIL&+Eqe>! z;6cv5@N**-f zN)KdPx}{t%P|*p<MnWN_Fa=mm^B`HNBG@s<* zwv}kK6pX=whjD@|C;!f(fXGXSju`)z4DOTu= z`Wej%!h2;x|n(!|IM79VBHC3ZHVZe`?VSybn@FVb5CxTl0zR{t*7 z$}a8qOHE(2_d zEY;^+$d0p@j6-Ch2=L2`DbG>zpxc4YnCpf%XG`cP zsQd61bSCKB%iD(4KQt$^$hwqFEb_pIg}+eENYkGfaZuv?^@_`Ct%V0EHI6uBf!92&YQ#yP_}T z0snRy53Snl)>aJ2fbl7lu-i-`Wq5jbkH{zFq}CP(|ba z8^H;T2eehkN5@v@u>HRIy{N|AzIF4Bla{;u5;LlROPPe5$JEJ;!%q{|U3FKzE(=N*x`ub^B1_ylm< zj0)m@?KYsW(yBxln^o}B)l$Mj5PFODJ;~^5{$!sQ;;~&``EdQGy-tAMGlm$Edht9% zCT~f?_S{#1)}*R>@rgUa5mv_I`H!h*x^Xh^#KE3`R*dq3igcf zY+qUnBjWEwmX*Y9kM!b-GGs@xw+Gu_X-be_wx8JEk`YBbI$hM}ACyo8KeO9AIqmr{ z=FH{a<)<2SqSY^T>)CUBI$|^t!QWObZjd9vVJkLUA8f6om7+wrNr*(}Wn0G*G8Y=W zNy!(Hqvdc~)0&)qU+Dh9mab|E5$HL$dDFdzV99=k@RTVgd$2p!O1ZmI7w6nCsP{5S zZPiZa88s+m&fM?eyrA?%!FN=DH%&dWE+1BF|Mu>b(%Z#)uED(@md^OV#%rhctApm) zw|IGzd3AExi%Xh7)Gtq5BYi}tGXPvmpCVQ7$Xo{hyxRRal~9%Nu#xp<(s(>@`Cax9 z<1p)59r=@>wc?2s$Zdauv5N2o@}ZHbP}?6u*$#K*smOukY2iis(T}@uo5Bq;6ouC)wlGjttBUrsoSp1G#`wozWyB z{zI-m8@^MO)$E*~mPgNH+nn*jhmj6aPnqTS;vf&w5<1FcwUJD=MsTwJ;$RGk=K79; zS5?5hgIB$KvP~dkaC*#4!3j~6z{r$sq5Dfe5@+A}6)7_b+i6O@g8ac=8n)2S6$LFv zoe@uvp#V23zojF}lzz3^4#`Ee_QB8m0(&Gbim8$nnf(Tx|D z$_i2_OPHH-!u+4GQJ0o48Xf5A7Dc9YL5B=%x56VedfILyX!>@D6 znLxg{ySXsh5>F+|3|g$~_Jurt8ED1=*N`2FSY}OAe$>;V@9c!QTaidRhsm=X$b-!| zbyZz0^PUg*ML!L`Nbqu9XoOm0C7;|w+VtJJ?_p=qhVDw7W->@%MBp%YWr*@{8-VEUKC(H}JEujYG##7ub)WZU}Bm-fa( zgKK}n_(ItxRlpn3;nCq?#-|X*K3!tJMLQ=^U27ycA1&IJU&GDAqkph)6uSRT(XJMgCRMM~{d9K~nKomdIpyh8 zjdzO~uycaElZ19Aj>?zJAZ+K8`$$^OT(wOP@0w~lH6JSRYu>#{WW zijud#FZ^)#<`J2s$+FtdNU|GO>tSzz`o$W^*w1##LBhslGHeq)Dm66v=y!JdsUgm- z8Bq>@{O`oJ%g|-~=bmgKu{0PsSr)>A9g3(yN`eTn)|VGll(G-xwb~xjbZK`)TID4a ziRrk|A~RtN31=2S_90*_6nZ8d~#GC`NxTk?Fya(1^$jQegToQwHmo%zv$^XDB& zO8=Gk_pHvI3hWXX;~?XJ4=!!)Uw$*1GYLw2S@+T~Ai~z}*+BfA%K%crTThtxA;hyF zDXi(n)f-23zDFlk6Ya8zU3&)1J8oJ<;e+OV!O1NmI*DP|-rskXzIidLd)^F%cb;|4 z2o<_JP0Bk_03^I~7L@t}D;~NHo5;`ZdGF4+%>9-Ed<~3jS+p20(-bo^|HEVcGVY_& UyZ=J|Jvaddx~4i!T8^>*0}9{+i2wiq literal 0 HcmV?d00001 diff --git a/doc/source/index.rst b/doc/source/index.rst index 28f602979aa..5dc8d510a0a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,11 +15,20 @@ License for the specific language governing permissions and limitations under the License. -=========================================== -Cinder, the OpenStack Block Storage Service -=========================================== +============================================== +OpenStack Block Storage (Cinder) documentation +============================================== -Cinder is an OpenStack project to provide "block storage as a service". +.. figure:: images/cinder.png + :alt: Cinder logo + :align: center + +What is Cinder? +--------------- + +Cinder is the OpenStack Block Storage service for providing volumes to Nova +virtual machines, Ironic bare metal hosts, containers and more. Some of the +goals of Cinder are to be/have: * **Component based architecture**: Quickly add new behaviors * **Highly available**: Scale to very serious workloads @@ -27,89 +36,126 @@ Cinder is an OpenStack project to provide "block storage as a service". * **Recoverable**: Failures should be easy to diagnose, debug, and rectify * **Open Standards**: Be a reference implementation for a community-driven api -This documentation is generated by the Sphinx toolkit and lives in the source -tree. Additional draft and project documentation on Cinder and other components -of OpenStack can be found on the `OpenStack wiki`_. Cloud administrators, refer -to `docs.openstack.org`_. +For end users +------------- -.. _`OpenStack wiki`: https://wiki.openstack.org/wiki/Main_Page -.. _`docs.openstack.org`: https://docs.openstack.org +As an end user of Cinder, you'll use Cinder to create and manage volumes using +the Horizon user interface, command line tools such as the +`python-cinderclient `_, +or by directly using the +`REST API `_. +Tools for using Cinder +~~~~~~~~~~~~~~~~~~~~~~ -Installation Guide -~~~~~~~~~~~~~~~~~~ +* `Horizon `_: + The official web UI for the OpenStack Project. +* `OpenStack Client `_: + The official CLI for OpenStack Projects. You should use this as your CLI for + most things, it includes not just nova commands but also commands for most of + the projects in OpenStack. +* `Cinder Client `_: + The **openstack** CLI is recommended, but there are some advanced features + and administrative commands that are not yet available there. For CLI access + to these commands, the **cinder** CLI can be used instead. + +Using the Cinder API +~~~~~~~~~~~~~~~~~~~~ + +All features of Cinder are exposed via a REST API that can be used to build +more complicated logic or automation with Cinder. This can be consumed directly +or via various SDKs. The following resources can help you get started consuming +the API directly. + +* `Cinder API `_ +* :doc:`Cinder microversion history ` + +For operators +------------- + +This section has details for deploying and maintaining Cinder services. + +Installing Cinder +~~~~~~~~~~~~~~~~~ + +Cinder can be configured standalone using the configuration setting +``auth_strategy = noauth``, but in most cases you will want to at least have +the `Keystone `_ Identity +service and other +`OpenStack services `_ installed. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 Installation Guide Upgrade Process -Administration Guide -~~~~~~~~~~~~~~~~~~~~ +Administrating Cinder +~~~~~~~~~~~~~~~~~~~~~ + +Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 admin/index -Configuration Reference -~~~~~~~~~~~~~~~~~~~~~~~ +Reference +~~~~~~~~~ + +Contents: .. toctree:: - :maxdepth: 2 - - configuration/index - reference/support-matrix - drivers - -CLI Reference -~~~~~~~~~~~~~ - -Information on the commands available through Cinder's Command Line -Interface (CLI) can be found in this section of documentation. - -Full documentation on the python-cinderclient is in the -`python-cinderclient documentation`_. - -.. _`python-cinderclient documentation`: https://docs.openstack.org/python-cinderclient/latest - -.. toctree:: - :maxdepth: 2 + :maxdepth: 1 + configuration/index + reference/support-matrix + drivers cli/index -Contributor/Developer Docs -~~~~~~~~~~~~~~~~~~~~~~~~~~ +Additional resources +~~~~~~~~~~~~~~~~~~~~ + +* `Cinder release notes `_ + +For contributors +---------------- + +Contributions to Cinder are welcome. There can be a lot of background +information needed to get started. This section should help get you started. +Please feel free to also ask any questions in the **#openstack-cinder** IRC +channel. + +Getting started +~~~~~~~~~~~~~~~ + +* `OpenStack Contributor Guide `_ + +Contributing to Cinder +~~~~~~~~~~~~~~~~~~~~~~ + +Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 contributor/index + API Microversions +Additional reference +~~~~~~~~~~~~~~~~~~~~ -API Extensions -~~~~~~~~~~~~~~ - -Go to https://developer.openstack.org/api-ref/block-storage/ for information -about Cinder API extensions. - -:doc:`Block Storage v3 API Microversion History `: -The block storage v3 API evolves over time through -:doc:`API Microversions `. This -provides the history of all those changes. Consider it a "what's new" in the -block storage v3 API. - -Indices and tables -~~~~~~~~~~~~~~~~~~ - -* :ref:`genindex` -* :ref:`search` - -Glossary -~~~~~~~~ +Contents: .. toctree:: :maxdepth: 1 common/glossary.rst + +Indices and tables +~~~~~~~~~~~~~~~~~~ + +Contents: + +* :ref:`genindex` +* :ref:`search`