Commit Graph

29 Commits

Author SHA1 Message Date
Daniel Clavijo Coca
ee2ee31d3f docs: Add information about OpenNebula integration
- Exclude doc build output from git
- Fix missing doc build dependency
- Also includes some involuntary automatically persistent linting by vscode

Co-authored-by: Ilya Dryomov <idryomov@redhat.com>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Co-authored-by: Zac Dover <zac.dover@proton.me>
Signed-off-by: Daniel Clavijo <dclavijo@opennebula.io>
2023-12-18 08:04:32 +10:00
Zac Dover
292c826acd doc/rbd: refine rbd-snapshot.rst
Refine the text in rbd-snapshot.rst

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-17 00:28:06 +10:00
Greg Farnum
1903ce28a9 doc: fix up rbd snapshot docs around crash consistency
Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2021-11-01 23:36:47 +00:00
Anthony D'Atri
32375cb789 doc: misc clarity and capitalization
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-10-12 13:41:46 -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
Peter Gervai
cb20e2bc89 doc/rbd: s/use use/use/
just a typo, really.

Signed-off-by: Peter Gervai <grin@grin.hu>
2020-03-18 15:44:16 +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
James McClune
7ff2f215a3 doc: updated Ceph documentation links
Fixes include:

- Updating Doxygen link for reference (http://docs.ceph.com/docs/master/dev/documenting/)
- Adding :ref: label for User Management page (http://docs.ceph.com/docs/master/rados/operations/user-management/)
- Update User Management link for reference (http://docs.ceph.com/docs/master/rbd/rbd-snapshot/)

Fixes: https://tracker.ceph.com/issues/37793
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2019-01-04 16:32:21 -05:00
Greg Farnum
505025c641 doc: Clean up the snapshot consistency note
The old note made it sound like we weren't crash-consistent, and had a
confusing section about needing to clone before mounting.
You *do* need to clone the snapshot before mounting it, but that has
nothing to do fs freezing or consistency.

Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2018-12-20 10:33:38 -08:00
Chen Zhenghua
f2d1f94322 doc: fix spelling errors in rbd doc
Signed-off-by: Chen Zhenghua <chen.zhenghua@zte.com.cn>
2018-08-28 14:56:16 +08:00
Tyler Zeqing Qi
d83a7a98c3
doc: Fix a grammar error in rbd-snapshot.rst
Signed-off-by: Zeqing Tyler Qi <aqize@126.com>
2018-04-17 20:10:42 +08:00
Ashish Singh
fec61eb5cc doc: Fixes rbd snapshot flatten example
Snapshot flatten example has incorrect image name, fixing the same.

Fixes: #17723

Signed-off-by: Ashish Singh <assingh@redhat.com>
2017-09-04 16:51:57 +05:30
Nilamdyuti Goswami
c36d73eedb doc: Modified a note section in rbd-snapshot doc.
Elaborates the note section a bit more as to why stopping I/O before
taking a snapshot is recommended and how to do it.

Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-12-13 01:23:30 +05:30
Ilya Dryomov
3fbcf5e265 doc: krbd supports clones since 3.10
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-07-31 19:50:58 +03:00
Ilya Dryomov
76989cc4ae doc: use spec syntax in rbd docs
Use spec syntax instead of --pool, --image and --snap to hopefully push
people towards the former.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-07-27 12:22:04 +03:00
Frank Yu
4bd0894cc7 Doc: rbd-snapshot: Fix the typo
Signed-off-by: Frank Yu <flyxiaoyu@gmail.com>
2015-01-19 20:19:25 +08:00
Frank Yu
7c664fadff Doc: Fix the indentation in doc/rbd/rbd-snapshot.rst 2015-01-13 18:27:08 +08:00
John Wilkins
7dbf750fc5 doc: Updated authentication notes. Fixed syntax error.
Signed-off-by: John Wilkins <jowilki@redhat.com>
2014-09-11 10:50:22 -07:00
Abhishek Lekshmanan
e23ed9b7dc doc: fix a few typos in rbd docs
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-07-09 10:58:59 +05:30
John Wilkins
efb4cf6480 doc: Removed extraneous comment from snapshot text.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-01-09 10:26:28 -08:00
rallred
0de0efa936 RBD Documentation and Example fixes for --image-format
- RBD Documentation, --image-format wrongly specified as --format in examples
 - RBD Documentation, better describe image format, to differentiate from --format

Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
2013-11-18 18:12:38 -08:00
Travis Rhoden
6ebb486304 doc: Update syntax for rbd children
The docs were incorrectly usins 'rbd snap children' when the actual
command is 'rbd children'.

Signed-off-by: Travis Rhoden <trhoden@gmail.com>
2013-07-19 15:49:49 -04:00
John Wilkins
fb07f9df3d doc: Added index tags.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:58:04 -07:00
John Wilkins
f2c7a60c90 doc: Fixed many hyperlinks, a few typos, and some minor clarifications.
fixes: #3564

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-12-03 12:22:37 -08:00
John Wilkins
a01b112d71 doc: changed --user to --id, and fixed a typo.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-01 12:55:18 -07:00
John Wilkins
968b315a09 doc: Added layering to the snapshot section.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-01 10:41:38 -07:00
John Wilkins
9829039eb9 :doc: Made notice to stop i/o a warning. Initial format clean up.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-09-18 13:01:50 -07:00
John Wilkins
6bb19e74c0 doc: Cleaned up rbd snapshots.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-07-03 08:46:14 -07:00
John Wilkins
992faa42e1 doc: Added a snapshot page with outline. Needs additional info.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-06-19 10:15:35 -07:00