Commit Graph

69 Commits

Author SHA1 Message Date
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
Florian Haas
441a5de8fe doc: RBD exclusive locks
A discussion on the ceph-users list uncovered a bit of uncertainty
about how exclusive locking works:

https://www.mail-archive.com/ceph-users@lists.ceph.com/msg56910.html

Add a bit of background information about exclusive locks, and
cross-reference the documentatation on OpenStack, and on CephX.

Signed-off-by: Florian Haas <florian@citynetwork.eu>
2019-12-04 16:03:08 +01:00
Jason Dillaman
5137cd80db doc/rbd: add new 'profile rbd' mgr caps to examples
Fixes: https://tracker.ceph.com/issues/42265
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-10-29 08:35:03 -04:00
Sage Weil
7b988e9fe1 doc: remove all pg_num arguments to 'osd pool create'
Also, update the dicussion about pg_num and pool creation, with a reference
to the autoscaler.

Signed-off-by: Sage Weil <sage@redhat.com>
2019-09-22 16:58:33 -05: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
e081abe8e7 doc/rbd: initial kubernetes / ceph-csi integration documentation
Fixes: https://tracker.ceph.com/issues/40834
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-08-01 09:51:21 -04:00
James McClune
e9b13fadbd doc: updated OpenStack rbd documentation
Removed references to older OpenStack releases. Updated
documentation in regards to using QCOW2 as a virtual machine
disk type.

Fixes: https://tracker.ceph.com/issues/18197
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2019-07-11 17:58:14 -04:00
Jason Dillaman
f692fd3581 doc/rbd: corrected OpenStack Cinder permissions for Glance pool
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2018-06-06 14:50:24 -04:00
Luo Kexue
6a61aa9fec doc: move glance_api_version option to the right place
Signed-off-by: Luo Kexue <luo.kexue@zte.com.cn>
2017-08-29 17:09:41 +08:00
John Wilkins
112e9936b1 doc/rbd: Removed contractions for ESL speakers.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-07-27 09:52:56 -07:00
Jason Dillaman
7f1b1dc38a doc: include details for new RBD cap profiles
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-07-21 14:30:18 -04:00
Jason Dillaman
73789cf9d9 rbd: add new 'pool init' action for initializing a RBD pool
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-07-19 13:13:01 -04:00
Kefu Chai
bd36f13163 doc: fix the links to http://ceph.com/docs
they should point to http://docs.ceph.com/docs/master/.. instead

Fixes: http://tracker.ceph.com/issues/19090
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-03-15 16:40:07 +08:00
Sage Weil
321f8e66e5 Merge pull request #13400 from shinobu-x/wip-18840
doc: Modify Configuring Cinder section

Reviewed-by: Sage Weil <sage@redhat.com>
2017-02-13 18:40:34 -06:00
Michael Eischer
877245e69e doc: Fixes parameter name in rbd configuration on openstack havana/icehouse
The documentation for using rbd together with openstack havana/icehouse
states that the parameter libvirt_disk_cachemodes should be added to
the nova.conf file. However, this is the only parameter that has no
legacy name with a 'libvirt_' prefix. (See
https://github.com/openstack/nova/blob/icehouse-eol/nova/virt/libvirt/driver.py#L252
for the configuration option)
Thus the configured disk_cachemodes were not applied, defaulting to
no caching.

Fixes: #17978
Signed-off-by: Michael Eischer <michael.eischer@fau.de>
2017-02-13 21:10:56 +01:00
Shinobu Kinjo
fb419b63e1 Doc: Modify Configuring Cinder section
doc/rbd/rbd-openstack.rst: Add ``volume_backend_name`` in description of
cinder.conf

Fixes: http://tracker.ceph.com/issues/18840
Signed-off-by: Shinobu Kinjo <shinobu@redhat.com>
2017-02-14 03:40:35 +09:00
Marc Koderer
6229edfec4 DOC: Mention corresponding section in nova.conf
rbd_user and rbd_secret_uuid are part of the libvirt configuration.

Signed-off-by: Marc Koderer <marc@koderer.com>
2016-12-20 14:52:34 +01:00
Sébastien Han
9af76d2626 doc: update cinder key permissions for mitaka
OpenStack Mitaka introduced the support of RBD snapshots while taking a
snapshot of a Nova instance. For this to work we need to grant write
access to the Glance pool to the Cinder key.

Signed-off-by: Sébastien Han <seb@redhat.com>
2016-12-08 15:21:21 +01:00
Sébastien Han
def903a7ef doc: openstack glance mitaka uses show_multiple_locations
As of the Mitaka release show_image_direct_url is not needed, but
instead show_multiple_locations should be used.
Adding the necessary guidance for Mitaka release.

Signed-off-by: Sébastien Han <seb@redhat.com>
2016-11-17 10:57:36 +01:00
Uday Mullangi
7c7395c1cc doc: Fixing the broken hyperlinks by pointing to correct documentation.
Signed-off-by: umullangi@walmartlabs.com
2016-11-03 14:55:12 +05:30
Jason Dillaman
593558f27b doc: update rbd glance configuration notes
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2016-08-10 09:48:46 -04:00
John Wilkins
45219e0e2a Fixed ceph-common install.
Fixes: #15438

Signed-off-by: John Wilkins <jowilkin@redhat.com>
2016-04-11 09:54:02 -07:00
RustShen
5fe3ff3f09 Modifications to rbd-openstack.rst
Original configuration is not working

'enabled_backends' should be changed accordingly

Signed-off-by: RustShen <rustinpeace@163.com>

Update rbd-openstack.rst
2016-03-10 14:31:34 +08: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
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
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
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
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
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
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
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
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
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
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
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
John Wilkins
fd423fce43 doc: Added index tags.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:57:48 -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