Commit Graph

191 Commits

Author SHA1 Message Date
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
Yunchuan Wen
2c7cc532a8 add rbd-nbd man page reference
Signed-off-by: Yunchuan Wen <yunchuan.wen@kylin-cloud.com>
2015-12-02 11:29:30 +08:00
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
Josh Durgin
3203efd1fc Merge pull request #4848 from leseb/doc-openstack-kilo
doc: update openstack and rgw keystone

Reviewed-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2015-06-19 07:14:05 -07:00
Loic Dachary
67343f614f Merge pull request #5011 from robin974/master
doc: Fixes a missing dot

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-06-18 17:14:41 +02:00
robin974
f105fdc255 doc: Fixes a missing dot
Fixes: #12072

Signed-off-by: Robin Tang <robintang974@gmail.com>
2015-06-18 16:43:45 +02: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
Sébastien Han
d38cd63d26 doc: update openstack and rgw keystone
Update the OpenStack doc with more options, recommendations and best
practices.
Update the Keystone configuration for the Kilo release with Rados
Gateway.

Signed-off-by: Sébastien Han <seb@redhat.com>
2015-06-16 11:22:14 +02:00
Josh Durgin
db7ab8ba36 doc: add rbd cache settings to nova.conf
To actually get the benefit of writeback caching, qemu must be
aware of it so it pases flushes to rbd.  Since hammer rbd caching
is enabled by default, so add the nova option to make qemu aware
of it.

Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2015-05-15 17:39:04 -07:00
Lee Revell
39d0d53ef6 doc: Clarify the requirement that the cinder user's key must be present on the compute nodes
Signed-off-by: Lee Revell <rlrevell@gmail.com>
2015-03-23 15:37:29 -04:00
Boris Ranto
46b45e3fc2 doc: fix python-ceph refs in docs
Signed-off-by: Boris Ranto <branto@redhat.com>
2015-02-24 18:30:18 -08:00
Frank Yu
b9be97f715 Doc: Fix the typo in doc/rbd/rados-rbd-cmds.rst
Fix the typo in doc/rbd/rados-rbd-cmds.rst, also add explanation/example
when creating an image without specifying pool.

Signed-off-by: Frank Yu <flyxiaoyu@gmail.com>
2015-01-21 16:47:41 +08:00
Josh Durgin
ac93c28522 Merge pull request #3396 from leseb/doc-openstack-fix-glance
doc: Fix OpenStack Glance configuration

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2015-01-19 08:38:37 -08: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
Sébastien Han
d29aef5eb9 doc: Fix OpenStack Glance configuration
Glance has not completely moved to 'store' yet so we need to configure
the store in the DEFAULT section as well.

Fixes: #10478

Signed-off-by: Sébastien Han <sebastien.han@enovance.com>
2015-01-18 22:55:57 +01:00
Frank Yu
7c664fadff Doc: Fix the indentation in doc/rbd/rbd-snapshot.rst 2015-01-13 18:27:08 +08:00
John Wilkins
56dae09b9c doc: Reformatting on rbd replay doc.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-12-02 11:23:55 -08:00
John Wilkins
b8f6b5f77c doc: Added rbd-replay-many and restructured index.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-12-02 11:23:29 -08:00
Adam Crume
70e1a5dcbb doc: Document RBD Replay
Signed-off-by: Adam Crume <adamcrume@gmail.com>
2014-12-01 20:45:58 -08:00
Sébastien Han
35ae591404 doc: update the OpenStack glance configuration
Juno is now using a section for configuring the stores, so let's use it.
Put spaces between flag and value for clarity and readibility.

Signed-off-by: Sébastien Han <sebastien.han@enovance.com>
2014-11-14 09:21:09 +01:00
Josh Durgin
7695a61e89 Merge pull request #2892 from leseb/doc-juno-client-socket
doc: enable RBD cache and socket on OpenStack deployments

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2014-11-12 21:57:06 +01:00
Ken Dreyer
731ea68bfb doc: correct spelling of "fqdn"
The "fqdn" (fully-qualified domain name) was misspelled in a couple
places as fgdn". Use the correct spelling.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2014-11-12 09:53:43 -07:00
Sébastien Han
40994c918a doc: enable RBD cache and socket on OpenStack deployments
Enabling the RBD cache improves sequential IOs and the socket helps a
lot while troubleshooting. These 2 items are considered as best
practice for OpenStack deployments with Ceph.

Signed-off-by: Sébastien Han <sebastien.han@enovance.com>
2014-11-12 10:19:44 +01:00
John Wilkins
72fc262a09 doc: Update for OpenStack Juno.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-11-03 14:04:33 -08:00
Sébastien Han
c96fe592f2 doc: update RBD for Juno
This commit introduces some updates for the OpenStack Juno release. New
flags have been added, many trailing spaces were removed and a new
recommendation for Glance cache management has been added too.

Signed-off-by: Sébastien Han <sebastien.han@enovance.com>
2014-10-30 11:59:14 +01:00
Josh Durgin
a9f302da08 Merge remote-tracking branch 'origin/wip-rbd-readahead'
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>

Conflicts:
	src/client/Fh.h
2014-10-16 14:33:42 -07:00
Wido den Hollander
3184a20733 doc: A couple of fixes to the CloudStack documentation 2014-10-01 17:02:29 +02:00
Adam Crume
ad45d8c454 librbd: Add read-ahead
Signed-off-by: Adam Crume <adamcrume@gmail.com>
2014-09-17 12:02:03 -07:00
Adam Crume
4809418752 doc: Change listed RBD cache defaults to actual defaults
Signed-off-by: Adam Crume <adamcrume@gmail.com>
2014-09-17 12:00:28 -07: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
John Wilkins
d5777c4215 doc: Fixed broken links and clarified terms for new authentication docs.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-09-08 14:04:33 -07:00
John Wilkins
e2de11a844 doc: Minor cleanup.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-09-08 13:24:52 -07: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
John Wilkins
335c1f745e doc: Added rbd-replay-prep and rbd-replay manpages to block device TOC.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-08-28 18:07:51 -07:00
John Wilkins
bd6ba10042 doc: Clean up formatting, usage and removed duplicate section.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-07-09 17:18:03 -07:00
John Wilkins
7e3ad1a6fc Merge pull request #1905 from leseb/doc-rbd-icehouse
doc: rbd icehouse updated. Need to remove duplicate section.

Reviewed-by: John Wilkins <john.wilkins@inktank.com>
2014-07-09 16:27:52 -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
Sébastien Han
2eab1c1540 Update RBD doc for OpenStack
Some updates from Icehouse, best practice configurations and
explanations.

Signed-off-by: Sébastien Han <sebastien.han@enovance.com>

Conflicts:
	doc/rbd/rbd-openstack.rst
2014-06-12 15:32:25 +02:00
Ilya Dryomov
22bc886ac5 doc: fix 'rbd map' example
Looks like 'foo' is a leftover, see commit ea9fc87d89 ("doc: Removed
foo.  Apparently myimage was added and foo not removed.").

Signed-off-by: Ilya Dryomov <ilya.dryomov@inktank.com>
2014-06-03 14:32:21 +04:00
Josh Durgin
d71839a6cf doc: clarify openstack cow sentence
Missing subject, and now applies to disks in general.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2014-05-19 15:25:37 -07:00
Josh Durgin
0f7f1e842b doc: note cinder multi-backend restriction
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2014-05-19 15:24:53 -07:00
Josh Durgin
e92f2d9fe0 doc: link to ephemeral rbd patches
These are necessary for using ephemeral rbd with Havana and Icehouse.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2014-05-19 15:14:29 -07:00
John Wilkins
03e3ccdd05 doc: Restored glance_api_version=2 setting.
Fixes: #8347

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-05-19 11:18:44 -07:00
John Wilkins
48337e0c7b doc: Omitted glance_api_version=2 to fix creating images from volumes.
Fixes: #8347
2014-05-13 23:20:36 -07:00
John Wilkins
17930a1e86 doc: Changed example to use virtio and put key usage into one line.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-05-13 23:18:50 -07:00
Ilya Dryomov
0c2b0fb8da doc: 'rbd showmapped' doesn't need privileges
No need to run 'rbd showmapped' with sudo.

Signed-off-by: Ilya Dryomov <ilya.dryomov@inktank.com>
2014-04-23 13:33:43 +04:00
Ilya Dryomov
4238ffdc49 doc: do not mention modprobe in rbd docs
rbd binary will load rbd.ko itself, with appropriate options.  Loading
it by hand with default options is undesirable.

Signed-off-by: Ilya Dryomov <ilya.dryomov@inktank.com>
2014-04-23 13:33:43 +04:00
Wido den Hollander
99d74eef82 doc: Add additional information over CloudStack and RBD 2014-04-11 13:59:31 +02:00
Wido den Hollander
a7057e1069 doc: Improve CloudStack RBD documentation 2014-03-04 22:24:36 +01: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
Wido den Hollander
03da035f76 docs: Typo in CloudStack user creation 2014-01-29 12:16:05 +01:00
Wido den Hollander
f0f4b8df81 docs: Improve CloudStack documentation.
Add a section about creating a CephX user for CloudStack.
2014-01-29 11:08:08 +01:00
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
Sébastien Han
8b0b32bd1b doc: Add OpenStack Havana documentation
New features appeared during the Havana cycle.
This patch offers a general update of the doc.

Signed-off-by: Sébastien Han <sebastien.han@enovance.com>
2013-12-26 09:55:03 -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
John Wilkins
a2090baf36 doc: Removed the Folsom reference.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-10-30 17:53:37 -07:00
John Wilkins
c9aa708ac5 doc: Restored show_image_direct and added a link to older versions.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-10-30 17:44:24 -07:00
John Wilkins
8193bad873 doc: Removed nova-volume, early Ceph references and Folsom references.
fixes: 5006

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-10-30 17:21:14 -07:00
Andrew Woodward
533626c7e0 Add Redhat init script option
Resolves: 6127
Signed-off-by: Andrew Woodward <awoodward@mirantis.com>
2013-10-17 17:23:04 -07:00
John Wilkins
cdd851b984 doc: Moved installation portion to the installation section.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-10-11 15:03:34 -07: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
Loic Dachary
768fb0a2a2 doc: fix openstack rbd installation command
This cannot work because client.volumes.key is not a command

   ssh {your-compute-host} client.volumes.key

replace with a tee to allow for copy/paste as well as using the

   cat client.volumes.key

in the following lines.

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-10-08 12:07:00 +02: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
0d3517b2ed doc: Added index tags.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:58:29 -07: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
fd423fce43 doc: Added index tags.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:57:48 -07:00
John Wilkins
8a5b276022 doc: Added index tag.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:57:31 -07:00
John Wilkins
d5dbc2f22b doc: Updated usage and index tags.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:57:15 -07:00
John Wilkins
ceba9537a2 doc: Updated usage and index tags.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:56:58 -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
0b604fb441 doc: Index tags.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:54:52 -07:00
John Wilkins
eb35d739ae doc: Updated title to reflect glossary usage.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-30 20:26:03 -07:00
Josh Durgin
e9c32b97aa doc: note openstack changes for Grizzly
These are just for the cinder configuration, nothing else changed.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-05-30 14:17:35 -07:00
Wido den Hollander
b3f37ea46b docs: Update CloudStack RBD documentation 2013-05-01 11:09:11 +02:00
Sage Weil
7d4c0dcfe4 Merge branch 'next' 2013-04-29 20:58:15 -07:00
John Wilkins
041b0cf950 doc: Added rbd-fuse to TOC.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-04-28 15:01:12 -07:00
Sage Weil
593507ea70 Merge branch 'next'
Conflicts:
	doc/rbd/rbd-cloudstack.rst
2013-04-17 11:05:00 -07:00
John Wilkins
82aab8dcf3 doc: Cherry-picked from master to next. Rewrite of CloudStack document.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-04-16 13:26:32 -07:00
John Wilkins
97532875ce doc: Cherry-picked from master to next. Updates config to use virtio.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-04-16 13:24:47 -07:00
John Wilkins
b4fc83ccde doc: Overhauled Wido's CloudStack document.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-04-15 07:39:32 -07:00
John Wilkins
74cdbc3c90 doc: Changed libvirt example to use virtio.
fixes: #4469
2013-04-11 12:28:14 -07:00
Josh Durgin
1597b3e3a1 librbd: optionally wait for a flush before enabling writeback
Older guests may not send flushes properly (i.e. never), so if this is
enabled, rbd_cache=true is safe for them transparently.

Disable by default, since it will unnecessarily slow down newer guest
boot, and prevent writeback caching for things that don't need to send
flushes, like the command line tool.

Refs: #3817
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
Reviewed-by: Sage Weil <sage@inktank.com>
2013-03-19 11:42:27 -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
John Wilkins
7f66ebe9a5 doc: Addressed confusion with version numbering.
fixes: #4411

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-03-12 14:25:44 -07:00
Dan Mick
58f4cd53b9 doc: rbd-cloudstack: fix bullet list, missing words, change ! to . 2013-02-27 18:43:46 -08:00
John Wilkins
977ba79b21 doc: clarified ceph id vs. ceph name, and fixed a typo.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-02-12 17:53:02 -08:00
John Wilkins
0e9852798b doc: Added some of the troubleshooting steps into the libvirt procedure and removed path for virsh edit.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-02-12 17:12:41 -08:00
John Wilkins
522a81e9d3 doc: Added link to <disk> reference. Added minor clarifications.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-02-12 09:53:17 -08:00
John Wilkins
29222872c4 doc: Added procedures for using libvirt VMs with Ceph.
fixes: #3432


Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-02-11 19:44:55 -08:00
Josh Durgin
3a08942099 doc: fix rbd create syntax
--dest-pool does not apply to create. Also remove extraneous
whitespace.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-01-28 10:13:59 -08:00
Gary Lowell
5dd6b19918 Merge branch 'next' 2012-12-31 21:31:17 -08:00
Josh Durgin
8bbb4a364d doc: fix rbd permissions for unprotect
Unprotect examines all pools, so use blanket x before 0.54. After
that, use class-read restricted by object_prefix to rbd_children.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-12-30 00:06:11 -08: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
ea9fc87d89 doc: Removed foo. Apparently myimage was added and foo not removed.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-12-20 11:39:41 -08: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
3ccaaa0923 doc: Added librbd to the RBD toc.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-16 14:57:15 -08:00
John Wilkins
9ea2609ea0 doc: Added libcephfs to the CephFS section and moved librbd to RBD section.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-16 14:56:46 -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
Josh Durgin
efdb209b0b doc: reorder some openstack/rbd instructions
Move client creation to the section on setting up client auth, so you
don't skip it if you already have pools created.

Move CEPH_ARGS setting to the section on configuring OpenStack, since
it's a change for the OpenStack services, not purely ceph client
configuration.

A couple people were confused by the placement of these parts, and
they make more sense in these sections.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-11-13 08:14:18 -08:00