Commit Graph

428 Commits

Author SHA1 Message Date
Ilya Dryomov
2656448617 doc/rbd/rbd-kubernetes: mention KMS config map
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-19 11:52:23 +02:00
Kefu Chai
73eb992c18 doc/rbd: tweak the format of command line blocks
to use the "prompt" directive for better rendering.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-02 00:46:00 +08:00
Daniel Pivonka
6a7e884fc4 doc/rbd: missed blacklist -> blocklist
Signed-off-by: Daniel Pivonka <dpivonka@redhat.com>
2021-03-26 12:36:47 -04:00
Kefu Chai
1dbc932195 doc: use :ref: instead relative path for links
path is fragile when we move the file around, but link is more stable.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-22 01:41:53 +08:00
Rachanaben Patel
f000ecb64e doc/RBD:fixes for ceph-immutable-object-cache daemon enable command
Document for rbd-persistent-read-only-cache show how to manage
ceph-immutable-object-cache daemon using systemd.
command example needs fixing.It should be

systemctl enable ceph-immutable-object-cache@ceph-immutable-object-cache.{unique id}

Fixes: https://tracker.ceph.com/issues/49849
Signed-off-by: Rachanaben Patel <racpatel@redhat.com>
2021-03-16 15:37:46 -07:00
Lucian Petrut
76a38a6b10 doc: reorganize Windows docs
Most of the Windows documentation is currently included in the
README.windows.rst file.

To make it more accessible, we're moving most of it to the
"doc/" folder, adding the following pages:

* Installing Ceph on Windows
* RBD on Windows
* Windows troubleshooting

We'll keep the build and manual install instructions in
README.windows.rst. Note that ceph-dokan already has a separate
doc page.

Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2021-03-15 15:15:32 +00:00
Jason Dillaman
68fda590cf doc/rbd: clarify QCOW2 migration support
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2021-03-02 17:29:41 -05:00
Or Ozeri
e45cd83af1 doc/rbd: rbd encryption
This commit adds documentation of the new rbd encryption feature

Signed-off-by: Or Ozeri <oro@il.ibm.com>
2021-02-21 07:31:24 +02:00
Jason Dillaman
eb8aea93b0
Merge pull request #39013 from MahatiC/wip-ssd-doc
doc: update rwl doc to include ssd config

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2021-01-22 15:45:56 -05:00
Mahati Chamarthy
23327ce374 doc: update rwl doc to include ssd config
... options.

Signed-off-by: Mahati Chamarthy <mahati.chamarthy@intel.com>
2021-01-22 10:59:18 +05:30
Jason Dillaman
bd8db295ea librbd/migration: basic QCOW2 format handler
The initial implementation does not support backing files, compression,
snapshots, (deprecated) encryption, external data files, nor L2 subcluster
allocation. The former three features will be added in a future commit.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2021-01-14 09:35:35 -05:00
Jason Dillaman
83aa1a9e73 librbd/migration: basic QCOW v1 format handler
The initial implementation does not support backing files, compression, nor
(deprecated) encryption. The former two features will be added in a future commit.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2021-01-14 09:35:34 -05:00
Yin Congmin
2093c88229 tools: update immutable object cache water mark
Signed-off-by: Yin Congmin <congmin.yin@intel.com>
2021-01-06 09:18:48 +08:00
Yin Congmin
b4b7161a12 doc/rbd: add the configuration description of immutable object cache throttle
Signed-off-by: Yin Congmin <congmin.yin@intel.com>
2021-01-06 08:45:45 +08:00
Jason Dillaman
6b40dddb27
Merge pull request #38520 from lixiaoy1/wip-doc-pwl
doc: add RBD persistent write-back cache

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2021-01-05 09:12:20 -05:00
lixiaoy1
948e1e82e2 doc: add RBD persistent write-back cache
Signed-off-by: Li, Xiaoyan <xiaoyan.li@intel.com>
2021-01-05 09:37:30 -05:00
Jason Dillaman
c2bf642ecf doc/rbd: incorporate external data source support for live-migration
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2021-01-02 09:26:54 -05:00
lixiaoy1
89b8e30bc4 doc: rename RBD persistent cache
Rename peristent cache to persistent read-only cache.

Signed-off-by: Li, Xiaoyan <xiaoyan.li@intel.com>
2020-12-16 04:52:21 -05:00
Anthony D'Atri
21d68cf137 doc: standardize config option names to use interstitial underscores
Ceph config option names may use spaces, underscores, or by one reference hyphens
as interstitial separators. Most usage within the doc tree uses underscores,
though example conf files and especially structured lists of options mostly
use spaces. Mostly. Underscores help differentiate the config names from
surrounding text, and moreover facilitate scripting, grep, awk, etc and match
their form in src/common/options.cc.

This PR conforms these occurrences of option names to use interstitial underscores instead of spaces.

Fixes: https://tracker.ceph.com/issues/48301
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-12-15 13:55:38 -08:00
Taeuk Kim
5b11688da1 doc/rbd: fix doc typos
fix typos in Ceph iSCSI manual

Signed-off-by: Taeuk Kim <taeuk_kim@tmax.co.kr>
2020-12-02 15:07:34 +09:00
haoyixing
0e7e036aa7 doc/dev: use http://docs.ceph.com/en/latest/ instead of /docs/master/ for docs
Several links under http://docs.ceph.com/docs/master/ were unable to access.
Change them to http://docs.ceph.com/en/lastest so we can access them directly.

Signed-off-by: haoyixing <haoyixing@kuaishou.com>
2020-11-24 12:49:47 +08: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
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
Ponnuvel Palaniyappan
d99d520493 doc: Fixed a number of typos in documentation
Signed-off-by: Ponnuvel Palaniyappan <pponnuvel@gmail.com>
2020-09-18 18:17:15 +01:00
Robert Sander
85d5510d0d changes the link to internal
Signed-off-by: Robert Sander <gurubert@gurubert.de>
2020-09-03 10:29:06 +02:00
Sage Weil
dfd01d7653 blacklist -> blocklist
Signed-off-by: Sage Weil <sage@newdream.net>
Signed-off-by: Neha Ojha <nojha@redhat.com>
2020-08-24 19:53:08 +00:00
Jason Dillaman
f5f24a44d2
Merge pull request #36253 from changchengx/exclusive
doc: specify RBD_LOCK_MODE_EXCLUSIVE for exclusive-lock

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2020-07-28 13:33:17 -04:00
Changcheng Liu
b43b501b81 doc: specify RBD_LOCK_MODE_EXCLUSIVE for exclusive-lock
The exclusive-lock could be transited transparently between clients
after finishing write operation. To disable "transparent" transition,
it needs to acquire the lock with RBD_LOCK_MODE_EXCLUSIVE.

Signed-off-by: Changcheng Liu <changcheng.liu@aliyun.com>
2020-07-28 22:27:48 +08:00
Mykola Golub
8c1a077e56
Merge pull request #36158 from dillaman/wip-45169
immutable-object-cache: fixed crashes on start up

Reviewed-by: Mykola Golub <mgolub@suse.com>
2020-07-23 09:05:23 +03:00
Jason Dillaman
d44cb50670 doc/rbd: add note for the immutable-object-cache domain socket
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2020-07-20 12:59:05 -04:00
Zac Dover
4b126d30e5 doc/rbd: add rbd-target-gw enable and start
This commit adds the following commands to  the "Configuring the iSCSI Target Using the Command Line" page: "systemctl enable rbd-target-gw" and "systemctl start rbd-target-gw"

Fixes: https://tracker.ceph.com/issues/45987
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-07-16 18:06:01 +10:00
Jason Dillaman
7236845b0e
Merge pull request #35138 from maydaycc/wip-45313
librbd: support duration controllable continuous burst

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2020-05-29 16:32:05 -04:00
Wencong Wan
86b082bd94 librbd: support duration controllable continuous burst
Modify the design of token bucket to save more tokens than burst value,
so as to support continuous burst. The desired burst duration can be
controlled by rbd_qos_XYZ_burst_seconds.

Fixes: https://tracker.ceph.com/issues/45313
Signed-off-by: wencong wan <wanwc@chinatelecom.cn>
2020-05-29 15:44:33 -04:00
Hans Bogert
6cb0fe6d61 doc: rbd-mirroring: Explain snapshot mirroring
* Rectify that snapshot based mirroring is point-in-time consistent
* Reword slightly s.t. there is less repetition.

Based on the discussion in https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/G6ZW5OP4IXGUBAJTKZDPABK7HCKYISQH/

Signed-off-by: Hans van den Bogert <hansbogert@gmail.com>
2020-05-29 00:11:54 +02:00
Jason Dillaman
9ec1e4ec50 librbd: moved parent image cache to its own plugin
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2020-05-21 14:50:33 -04:00
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
Michel
b911670816
doc: Fixed syntax in iscsi initiator windows docu
Added a empty line which as its need for the correct syntax.

Signed-off-by: Michel Raabe <raabe@b1-systems.de>
2018-12-10 12:24:44 +01:00
Valentin Lorentz
cffa33b80a doc/rbd: Document new RBD feature flags and librbd/krbd version support
Sources:

layering:

* f87c441f68
* krbd: 770eba6e29

striping:

* 2e403ef2c9
* krbd: 770eba6e29

exclusive-lock:

* fa96bb4db4
* krbd: ed95b21a4b

object-map:

* 7e751ce912

fast-diff:

* 16ad44cebc

deep-flatten:

* b556d3173a

journaling:

* 750771c6ff
* not a default: https://github.com/ceph/ceph/blob/1a14963/src/test/cli/rbd/help.t#L229

data-pool:

* c5f2290047
* description: https://tracker.ceph.com/issues/17409
* krbd: 7e97332ea9

operations:

* 209f6fc5a4
* description: e573427a44
* krbd: e573427a44

migrating:

* 2f7c4ae3fc

Signed-off-by: Valentin Lorentz <progval+git@progval.net>
2018-12-03 22:33:40 +01:00
Mykola Golub
d04114c4a8 doc: describe RBD QoS settings
Signed-off-by: Mykola Golub <mgolub@suse.com>
2018-11-21 15:25:17 +02:00
Jason Dillaman
232baf83e3 doc: tweak RBD iSCSI docs to point to merged tooling repo
Also remove all references to the ceph-client test kernel since v4.16 has been
released.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2018-11-06 18:06:36 -05:00
Jason Dillaman
8931f8cd14
Merge pull request #23190 from maxcuttins/master
doc: rewrote the iscsi-target-cli installation

Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2018-11-03 08:48:30 -04:00
Massimiliano Cuttini
6df20fafa8 doc: rewrote the iscsi-target-cli installation
Rewrote the documentation in a step-by-step style, reformatted using RST's
titles instead of bolds, added installation of GIT if needed, added
installation of compilers needed for tcmu-runner

Signed-off-by: Massimiliano Cuttini <massimiliano.cuttini@phoenixweb.it>
2018-11-02 17:52:01 -04:00
Jason Dillaman
f2db4bc881
Merge pull request #24720 from gauravsitlani/master
doc: added rbd default features

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2018-10-25 16:56:05 -04:00
Gaurav Sitlani
5ea5263d13
doc: added rbd default features
Fixes: https://tracker.ceph.com/issues/15000
Added RBD default features description

Signed-off-by: Gaurav Sitlani <gauravsitlani@riseup.net>
2018-10-26 01:12:31 +05:30
Jason Dillaman
c6651ff309 doc/rbd: explicitly state that mirroring requires connectivity to cluster
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2018-10-04 12:21:35 -04:00
Jason Dillaman
24beceef64 doc: ceph-iscsi-api ports should not be public facing
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2018-09-24 10:32:25 -04:00
Jason Dillaman
900e30d1bb doc/rbd: update mirroring to include new peer secret config-key actions
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2018-09-13 09:58:34 -04: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
Jos Collin
0f3442a35e
doc: fix the broken urls
Fixed the broken urls.

Fixes: http://tracker.ceph.com/issues/25185
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-07-31 09:06:51 +05:30
Jos Collin
152f4fba1e
doc: s/Ceph FS/CephFS
Fixes: https://github.com/ceph/ceph/pull/22784#discussion_r200755460
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-07-28 19:59:33 +05:30
James McClune
575a5af0e0
doc: fixed grammar in restore rbd image section
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-07-08 22:53:59 -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
Kefu Chai
d96e20321f
Merge pull request #21864 from LenzGr/documentation-fixes
doc: fixed restful mgr module SSL configuration commands

Reveiwed-by: John Spray <john.spray@redhat.com>
2018-06-01 16:12:19 +08:00
Mao Zhongyi
5d38acbab7 doc: update the discarded option '--delay' in command 'rbd trash mv'
I got the following error message when I used the command '#rbd trash
mv foo --delay' as a document:

rbd: unrecognised option '--delay'

so replace the discarded option '--delay' with '--expires-at' avoid
others getting into the same doubt. In addition, some spelling mistakes
were fixed.

Signed-off-by: Mao Zhongyi <maozy.fnst@cn.fujitsu.com>
2018-05-31 20:35:03 +08:00
Jason Dillaman
7c01362afc
Merge pull request #22203 from hydro-b/rbd-docu-fixes
doc: remove duplicate python packages

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2018-05-29 09:41:47 -04:00
Stefan Kooman
3752a8e8a5 doc: remove duplicate python packages, explicitly ensure python script installation in path /usr/bin.
Signed-off-by: Stefan Kooman <stefan@kooman.org>

    Signed-off-by: Stefan Kooman <stefan@kooman.org>
2018-05-29 14:24:22 +02:00
James McClune
03b607854b doc: updated reference link for creating new disk offerings in cloudstack
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-05-25 11:30:33 -04:00
Lenz Grimmer
22b30e3c84 doc: Fixed note rendering in iSCSI target config chapter
Fixed typo in a reStructuredText note entity

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-05-14 18:17:06 +02:00
Venky Shankar
3b2d739e4c doc: fix iscsi target name when configuring target
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2018-05-09 20:43:59 +05:30
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
John Wilkins
ca016f376c doc: Edits
Made a few minor edits.

Signed-off-by: John Wilkins <jowilkin@redhat.com>
2018-03-29 15:17:34 -04:00
falcon78921
ffb68cc916 doc: Updated add primary storage documentation for latest CloudStack release (4.11)
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-03-29 15:17:13 -04:00
Mike Christie
8ec0ab5958 doc: update iSCSI upstream kernel to 4.16
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-03-02 16:05:54 -06:00
Mykola Golub
6a57358add rbd: unified way to map images using different drivers
Instead of "rbd map|unmap|showmapped", "rbd ndb map|unmap|list",
"rbd ggate map|unmap|list" commands, provide:

 rbd device -t krbd|nbd|ggate|... map|unmap|list

which gives interface consistent between drivers.

Signed-off-by: Mykola Golub <mgolub@suse.com>
2018-01-29 09:34:11 +02:00
Jason Dillaman
ccd16d2215
Merge pull request #20020 from mikechristie/wip-doc-mnc-update-iscsi-client
doc: update ceph iscsi kernel and package info

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2018-01-23 09:11:32 -05:00
Mike Christie
3ab71020a5 doc: fix ceph-iscsi-config version number
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-22 17:10:04 -06:00
Mike Christie
5c30318660 doc: add ceph iscsi test kernel info
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-20 16:06:42 -06:00
Yuan Zhou
dcf70f5f64 doc: fix librbdpy example
need to connect cluster before opening ioctx

Signed-off-by: Yuan Zhou <yuan.zhou@intel.com>
2018-01-19 10:41:03 +08:00
songweibin
a68d08f88a doc/rbd: fix typo s/morror/mirror
Signed-off-by: songweibin <song.weibin@zte.com.cn>
2018-01-18 11:36:32 +08:00
Mike Christie
b56d994f3a doc: add rbd pool requirement for gwcli
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-16 12:48:55 -06:00
Mike Christie
4ca0d508bb doc: add daemon-reload for rbd-target-api setup
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-16 12:48:51 -06:00
Mike Christie
f45aafed1c doc: add gwcli manual install instructions
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-16 12:48:41 -06:00
Mike Christie
f80f083d0a doc: separate gwcli install from post install setup steps
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-15 13:02:24 -06:00
Mike Christie
3cc367dc6e doc: add note to clarify trusted_ip_list use
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-15 13:02:20 -06:00
Mike Christie
3806f9750d doc: update esx instructions
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-15 13:02:13 -06:00
Mike Christie
62661a2e23 doc: add warning about SCSI PGRs/reservations
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-11 19:57:54 -06:00
Mike Christie
480f6a82a2 doc: fix gwcli examples
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-11 19:57:54 -06:00
Mike Christie
f436e993d3 doc: Update ceph iscsi kernel/distro requirements.
Signed-off-by: Mike Christie <mchristi@redhat.com>
2018-01-11 19:57:54 -06:00
Sage Weil
e47e5fa65e
Merge pull request #19692 from hikycool/master
doc: Add introduction about different way to run rbd-mirror
2017-12-29 10:28:12 -06:00
songweibin
a6b371bea3 doc: correct the path of librbd python APIs
* update the API Documentation page for librbdpy with the
  correct path.
* fix a typo.

Signed-off-by: songweibin <song.weibin@zte.com.cn>
2017-12-27 09:08:12 +08:00
Yu Shengzuo
f7c6af5a33 [DOC]Add introduction about different way to run rbd-mirror
Add a way to run rbd-mirror process in foregroup.
This way is useful to run rbd-mirror in a container when you don't
want to build a specified rbd-mirror image

Signed-off-by: Yu Shengzuo <yu.shengzuo@99cloud.net>
2017-12-26 22:16:12 +08:00
Jason Dillaman
fb5e341546
Merge pull request #18789 from jcsp/wip-doc-config-set
doc: replace injectargs usage with "config set"

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2017-11-07 08:18:12 -05:00
John Spray
6fc92dc981 doc: replace injectargs usage with "config set"
Cleaner and easier.  Also implicitly documents
the config set command, which hadn't been explicitly
called out in the docs before.

Signed-off-by: John Spray <john.spray@redhat.com>
2017-11-07 11:32:26 +00:00
Jason Dillaman
997bb80ba2 doc/rbd: tweaks to the Windows iSCSI initiator directions
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-11-03 11:05:02 -04:00
Jason Dillaman
61ad73526c doc/rbd: specify additional ESX prerequisites
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-10-24 15:49:42 -04:00
Ashish Singh
2a5755e076 doc: Added CHAP cofiguration instructions for iSCSI
Added details to specify the CHAP username and password while
discovering/login the iSCSI target.

Signed-off-by: Ashish Singh <assingh@redhat.com>
2017-10-20 23:52:14 +05:30
Jason Dillaman
4f227e108d doc/rbd: tweaks for the LIO iSCSI gateway
Fixes: http://tracker.ceph.com/issues/21763
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-10-19 09:40:22 -04:00
Adam Wolfe Gordon
57745b9439 doc: Update rbd-mirror docs to reflect data pool selection changes
Signed-off-by: Adam Wolfe Gordon <awg@digitalocean.com>
2017-09-29 15:32:38 +00: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
Jason Dillaman
b0abab17e3 doc: tweaks for the RBD iSCSI configuration documentation
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-08-30 10:16:26 -04:00
Aron Gunn
f109031cb5 doc/rbd: Replaced numbered steps with a # for dynamic numbering
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:53:00 -04:00
Aron Gunn
2a59c82b3d doc/rbd: Updated the content based on engineering feedback
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:52:57 -04:00
Aron Gunn
1d4f5b458d doc/rbd: Updated the content based on engineering feedback
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:52:54 -04:00
Aron Gunn
441820d958 doc/rbd: Updated the content based on engineering feedback
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:52:50 -04:00
Aron Gunn
c57266bf82 doc/rbd: Updated the requirements based on engineering feedback
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:52:47 -04:00
Aron Gunn
9335742140 doc/rbd: Added the iSCSI gateway requirements content
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:52:41 -04:00
Aron Gunn
d022034bb3 doc/rbd: Added the iSCSI gateway overview content
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:52:09 -04:00
Aron Gunn
7e8233429b doc/rbd: Added the iSCSI gateway 'gwtop' monitoring content
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:52:03 -04:00
Aron Gunn
cbf654c702 doc/rbd: Added the iSCSI targets, Ansible and CLI docs
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:51:57 -04:00
Aron Gunn
f0e177fa3d doc/rbd: Added the iSCSI initiators, RHEL, Windows, and ESX docs
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:51:50 -04:00
Aron Gunn
4ef8426bff doc/rbd: Updated the "toctree" adding the iSCSI gateway overview doc
Fixes: http://tracker.ceph.com/issues/20437

Signed-off-by: Aron Gunn <agunn@redhat.com>
2017-08-30 09:51:44 -04:00