Commit Graph

293 Commits

Author SHA1 Message Date
Changcheng Liu
f90b4997b8 doc/rbd: explicit remind the directory access right
It needs to create admin socket to use perf counter for
debug purpose. Remind the access right to directory.

Signed-off-by: Changcheng Liu <changcheng.liu@aliyun.com>
2020-05-01 22:51:18 +08: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
Jason Dillaman
eff1380b15 librbd: new RBD_FEATURE_NON_PRIMARY to prevent R/W IO
When a snapshot-based image is non-primary, we will need to use
this implicit feature to ensure that writes and maintenance
operations cannot be performed against the image.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2020-03-10 19:23:02 -04:00
songweibin
ffdc13e406 doc/rbd: fix small typos
Signed-off-by: songweibin <song.weibin@zte.com.cn>
2020-03-03 19:30:27 +08:00
Jason Dillaman
1e7e13036b
Merge pull request #33493 from zhengchengyao/read
librbd: improved support for balanced and localized reads

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2020-02-27 16:18:20 -05:00
Jason Dillaman
6c9c8d6a92 doc/rbd: document the new snapshot-based mirroring feature
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2020-02-26 15:48:30 -05:00
zhengyin
d92be8b585 librbd: Improved support for balanced and localized reads
Fixes: https://tracker.ceph.com/issues/43793
Signed-off-by: Zheng Yin <zhengyin@cmss.chinamobile.com>
2020-02-26 09:43:41 +08:00
Jason Dillaman
d611a9860a doc/rbd: documented 'rbd compression hint' config option
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2020-01-17 08:38:14 -05:00
Changcheng Liu
e16ac01742 doc/rbd: remind Selinux/AppArmor effect on libvirtd
If libvird is under Selinux/Apparmor enforced mode, libvirtd
may not be enable to do some operatoins on the rbd image. It
need remind this in document.

Signed-off-by: Changcheng Liu <changcheng.liu@aliyun.com>
2019-12-16 19:49:18 +08:00
Changcheng Liu
767161a347 doc/rbd: correct software stack of VM with Ceph
Signed-off-by: Changcheng Liu <changcheng.liu@aliyun.com>
2019-12-16 19:49:09 +08:00
Changcheng Liu
360b9e97ec doc/rbd: align with other part in the context
Signed-off-by: Changcheng Liu <changcheng.liu@aliyun.com>
2019-12-13 10:00:58 +08:00
Changcheng Liu
396e7a00a9 doc/rbd: correct targe dev name and existence check
Signed-off-by: Changcheng Liu <changcheng.liu@aliyun.com>
2019-12-13 09:13:13 +08:00
Ilya Dryomov
abd20b5ca9 doc: clarify support for rbd fancy striping
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2019-12-11 12:41:09 +01: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
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
Michael Prokop
d98b3e36a9 doc: fix typos
s/amount of times/number of times/
s/assosciated/associated/
s/availabe/available/
s/Commiting/Committing/
s/Containter/Container/
s/dependant/dependent/
s/developement/development/
s/filesytem/filesystem/
s/guarenteed/guaranteed/
s/hiearchy/hierarchy/
s/intance/instance/
s/Interger/Integer/
s/mutiple/multiple/
s/nubmer/number/
s/occured/occurred/
s/overriden/overridden/
s/reseted/reset/
s/sytem/system/
s/unkown/unknown/

Signed-off-by: Michael Prokop <mika@grml.org>
2019-09-26 09:17:07 +02:00
Sage Weil
ab594b9b31 Merge PR #30475 into master
* refs/pull/30475/head:
	qa/standalone/ceph-helpers: default pg autoscale mode off for standalone
	os/bluestore: fix objectstore_blackhole read-after-write
	test,misc: do not specify pg_num per pool
	mgr/volumes: do not specify pg_num
	pybind/ceph_volume_client: do not specify pg_num for new pools
	doc: remove all pg_num arguments to 'osd pool create'
	mon: do not require pg_num to 'osd pool create'
	common: default pg_autoscale_mode=on for new pools

Reviewed-by: xie xingguo <xie.xingguo@zte.com.cn>
2019-09-23 09:12:42 -05: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
Jason Dillaman
b1b934d24f doc/rbd: document new rbd mirror bootstrap commands
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-09-18 14:06:49 -04:00
Jason Dillaman
18e1d29fa3 doc/rbd: clarify cluster naming by using site-a/b
The local vs remote cluster naming has been confusing for multiple
users.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-09-18 14:06:49 -04: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
Ilya Dryomov
0a6e01ab6c
Merge pull request #29083 from dillaman/wip-40802
doc/rbd: update krbd version support for RBD features

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2019-07-24 01:33:36 +02:00
Jason Dillaman
984868038d doc/rbd: update krbd version support for RBD features
Fixes: http://tracker.ceph.com/issues/40802
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-07-23 08:12:51 -04:00
Ricardo Marques
b434c2910a doc: Update 'ceph-iscsi' min version
Signed-off-by: Ricardo Marques <rimarques@suse.com>
2019-07-23 10:38:24 +01:00
Jason Dillaman
20c80dfd3f doc/rbd: initial live-migration documentation
Fixes: http://tracker.ceph.com/issues/40486
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-07-22 08:20:23 -04:00
Jason Dillaman
996c0197ca doc/rbd: tweak config reference
Clean up the caching sections to match the current implementation and
clarify which sections apply only to librbd.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-07-19 10:24:36 -04:00
Jason Dillaman
0277e2f639 doc/rbd: restructure into operations and integrations
This avoids the long table of contents list of intermingled subjects.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-07-19 09:47:52 -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
Yuan Zhou
c9dc97c4d0 doc: fix example command on creating ceph user
Signed-off-by: Yuan Zhou <yuan.zhou@intel.com>
2019-06-24 17:36:54 -04:00
Yuan Zhou
38b94ef2f5 doc: better format for rbd persistent cache
Signed-off-by: Yuan Zhou <yuan.zhou@intel.com>
2019-06-24 17:36:54 -04:00
Yuan Zhou
5a2e98ce8d doc: updating doc for rbd shared parent cache
Signed-off-by: Yuan Zhou <yuan.zhou@intel.com>
2019-06-24 17:35:40 -04:00
Yuan Zhou
69055a85da doc: adding docs for rbd shared read-only parent image cache
Signed-off-by: Yuan Zhou <yuan.zhou@intel.com>
2019-06-24 17:35:40 -04:00
Mike Christie
37c9a96955 doc: Add rbd-target-api ceph iscsi ansible vars
Signed-off-by: Mike Christie <mchristi@redhat.com>
2019-06-24 14:27:53 -04:00
Mike Christie
92bf169c3a doc: Update rbd-target-gw behavior info
The lio setup and teardown functionality was moved from rbd-target-gw to
rbd-target-api in ceph-iscsi.

Signed-off-by: Mike Christie <mchristi@redhat.com>
2019-06-24 14:27:53 -04:00
Mike Christie
d964fb5962 doc: Update ceph-ansible iscsigws settings
The ceph-ansible ceph-iscsi support does not allow setting up iscsi
objects. It must be done through gwcli like is done in the container
case. This drops the iscsi object related settings and admin info for
it.

Signed-off-by: Mike Christie <mchristi@redhat.com>
2019-06-24 14:27:53 -04:00
Mike Christie
683b50189b doc: Fix ceph-ansible iscsigws command
Use the more standard --limit iscsigws argument instead of running the
playbook command on the iscsigws.yml file directly.

Signed-off-by: Mike Christie <mchristi@redhat.com>
2019-06-24 14:27:53 -04:00
Mike Christie
d6fbe68322 doc: Fix igw ceph ansible host group name
The ceph-ansible iscsi group name is iscsigws and not
ceph-iscsi-gws.

Signed-off-by: Mike Christie <mchristi@redhat.com>
2019-06-24 14:27:53 -04:00
Ricardo Marques
247af2831b doc: Update 'python-rtslib' and 'tcmu-runner' min versions
Signed-off-by: Ricardo Marques <rimarques@suse.com>
2019-06-11 16:59:37 +01:00
Kefu Chai
779eccd1fc doc/rbd/rbd-cloudstack: update disk offering URL to new docs
point hyperlinks to latest

Signed-off-by: Kefu Chai <kchai@redhat.com>
2019-04-23 13:26:47 +08:00
Lenz Grimmer
71e46887d4 doc: Updated dashboard iSCSI configuration, added labels
Added note about the requirement for the latest ceph-iscsi version
3 to the dashboard documentation. Added some doc references
and replaced some URLs in the iSCSI docs with reST labels instead.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2019-03-31 13:32:15 -05:00
Ricardo Marques
dacde1548d
Merge pull request #26788 from ricardoasmarques/iscsi-docs-password
doc/rbd/iscsi-target-cli: Update auth command

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2019-03-13 09:20:09 +00:00
Ricardo Marques
ab57c4bc47 doc/rbd/iscsi-target-cli: Update disk separator
Disk separator is now a '/' instead of a '.'

Signed-off-by: Ricardo Marques <rimarques@suse.com>
2019-03-06 13:04:29 +00:00
Ricardo Marques
0a259bf2a7 doc/rbd/iscsi-target-cli: Update auth command
Signed-off-by: Ricardo Marques <rimarques@suse.com>
2019-03-06 12:59:30 +00:00
ykcowrebbaj
50f0d8739b doc/rbd: fix options of iscsiadm command
Signed-off-by: ZhuJieWen <154667715@qq.com>
2019-02-21 21:25:36 +08: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
Jason Dillaman
c84cc4a542
Merge pull request #25655 from gregsfortytwo/wip-rbd-snap-doc
doc: Clean up the snapshot consistency note

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2018-12-20 18:07:36 -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