Commit Graph

18 Commits

Author SHA1 Message Date
Anthony D'Atri
d3f9c6853d doc/rbd: readability and spelling
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-10-02 00:28:30 -07:00
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00
Kefu Chai
df226da996 doc/rbd: s/guess/xml/ for codeblock lexer
this change silences the warning of

```
doc/rbd/qemu-rbd.rst:174: WARNING: Pygments lexer name 'guess' is not
known
```

see http://pygments.org/docs/lexers/, we should use "xml" for XML .

Signed-off-by: Kefu Chai <kchai@redhat.com>
2019-10-16 12:58:49 +08:00
Patrick Donnelly
e7a7cf429e
doc: filesystem to file system
"Filesystem" is not a word (although fairly common in use).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-10 08:43:28 -07:00
Jason Dillaman
cb897a4e98 doc: clarify QEMU rbd cache settings
http://tracker.ceph.com/issues/17665
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2016-10-21 14:55:05 -04:00
Sage Weil
61c4c1c99b doc: list ext4 last
Signed-off-by: Sage Weil <sage@redhat.com>
2016-04-12 08:48:25 -04:00
Jean-Rémi Deveaux
b10adf6a4f doc: Unify ID format
Fixes: #12071

Signed-off-by: Jean-Rémi Deveaux <jeanremi.deveaux@gmail.com>
2015-06-18 16:26:08 +02:00
John Wilkins
591a179540 doc: Added more robust usage example for uid and conf for QEMU.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-09-08 11:58:09 -07:00
Florian Haas
9292cc215a doc: highlight that "raw" is the only useful RBD format for QEMU
Explain why people should be using the "raw" image format for RBD
volumes created for use by QEMU: using any other format adds only
overhead, but no extra value (since RBDs are also CoW and
thin-provisioned), plus the Qcow2 storage driver is not migration safe
when caching is enabled, whereas the RBD driver is.

Also, fix a minor glitch in the example qemu-img commands ("-f rbd"
and "-O rbd" should really be "-f raw" and "-O raw").

Finally, drop the "-f" option altogether on qemu-img commands where it
makes no sense (info and resize).

Signed-off-by: Florian Haas <florian@hastexo.com>
2014-02-11 00:30:07 +01:00
John Wilkins
1dff92ba88 doc: Moved installation portion to the installation section.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-10-11 15:02:38 -07:00
John Wilkins
81d4f9d9e0 doc: Added introductory section. Updated usage. Index tags.
fixes: #3220

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:56:39 -07:00
John Wilkins
6802f2793b doc: Added libvirt config comments for discard granularity.
fixes: #4395

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-03-13 10:57:23 -07:00
Josh Durgin
1c3e12a2f4 doc: warn about using caching without QEMU knowing
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-12-27 22:03:09 -08:00
John Wilkins
0a2a0c075c doc: config-cluser move to new IA.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-14 14:57:51 -08:00
John Wilkins
4bff87da9a doc: Added qemu caching section.
fixes: #3332

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-03 12:12:11 -07:00
Josh Durgin
f586add47b doc: extend QEMU/RBD docs
Describe running a vm from RBD, cache options, and discard support.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-09-26 17:41:03 -07:00
John Wilkins
2be02918ca doc: Added prerequisite of running Ceph cluster.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-06-19 10:10:51 -07:00
John Wilkins
7515b05e88 doc: added qemu-img documentation for rbd.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-06-14 14:18:53 -07:00