Commit Graph

22 Commits

Author SHA1 Message Date
Josh Durgin
e1548ef36a doc/rbd/rbd-config-ref: add more detail on QoS settings
Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2022-01-13 11:37:46 -05:00
Josh Durgin
52995842a9 doc/rbd/rbd-config-ref: group QoS options by throttle type
This makes it clearer that there are distinct throttles with the
same groups of settings.

Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2022-01-11 21:46:37 -05:00
Mara Sophie Grosch
5d872f3a28 doc: add docs for rbd_default_order
Adds documentation how to change default rbd object size. With the
previous option `--order` it was easy to guess the config name for the
default value, with the current option name `--object-size` thats hard
to guess.

Also extends the documentation for rbd_default_order to include
* how object-size is derived from the configured value
* allowed range of the value

In the first version of this commit I also added min and max for this
parameter (12/25, matching the object size range in `man 8
rbd`/Striping/object-size), but this made some tests fail, since some
seem to set values outside this range (and probably are fine since
included for some time already). To have this a doc-change only, I
removed the range.

Signed-off-by: Mara Sophie Grosch <littlefox@lf-net.org>
2021-12-27 19:58:56 +01:00
Kefu Chai
50c15dd7f0 doc/rbd/rbd-config-ref: use confval directive to define options
less repeating this way.

also fix a typo of "rbd_qos_writ_bps_limit", it should be
"rbd_qos_write_bps_limit".

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 10:14:46 +08: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
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
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
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
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
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
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
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
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
34ff1ddca1 doc: re-ordered rbd table of contents
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-08-08 12:40:50 -04: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
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
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
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