Commit Graph

338 Commits

Author SHA1 Message Date
Etienne Menguy
849e2bb782 Initial commit to add rbd and nomad integration documentation
Signed-off-by: Etienne Menguy <etienne.menguy@croit.io>
2021-07-03 22:58:09 +02:00
Sandro Bonazzola
a5c361b648 doc/rbd/iscsi-initiator-linux: set "product" in multipath.conf
Adding missing parameter in multipath configuration.  See
https://bugzilla.redhat.com/show_bug.cgi?id=1769135.

Signed-off-by: Sandro Bonazzola <sbonazzo@redhat.com>
2021-06-30 23:46:11 +02:00
Grzegorz Wieczorek
f5577f1e9a doc/rbd: add missing snapshot in command line examples
Signed-off-by: Grzegorz Wieczorek <grzegorz.wieczorek@onito.pl>
2021-05-23 23:06:48 +02:00
Ilya Dryomov
e78e41c7f4
Merge pull request #41256 from tchaikov/wip-doc-rbd-confval
doc/rbd/rbd-config-ref: use confval directive to define options

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2021-05-11 22:28:46 +02: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
Ilya Dryomov
797709ebb1 doc/rbd/rbd-persistent-write-back-cache: clarify some config settings
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-05-06 11:20:23 +02:00
Ilya Dryomov
a227abfb36 doc/rbd/rbd-persistent-write-back-cache: update "Cache Status" section
Amend the example output and drop the word "transient" -- currently it
is the exact opposite, as the status is updated only when the cache is
opened and closed.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-05-06 11:20:23 +02:00
Ilya Dryomov
d12e7f458b rbd: --source-spec-file should be --source-spec-path
It was renamed during development, get rid of the leftovers.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-29 18:10:54 +02:00
Ilya Dryomov
6f77102706 doc/rbd/rbd-kubernetes: expose volume expansion functionality
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-19 11:52:23 +02:00
Ilya Dryomov
d0d4100040 doc/rbd/rbd-kubernetes: imageFeatures is required
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-19 11:52:23 +02:00
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