Commit Graph

357 Commits

Author SHA1 Message Date
Kefu Chai
48c044b618
Merge pull request #43304 from inspur-wyq/wip-doc-3
doc/rbd/rbd-windows.rst: fix typos

Reviewed-by: Deepika Upadhyay <dupadhya@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-09-26 21:55:57 +08:00
Madhu Rajanna
4f48612c2c doc/rbd/rbd-kubernetes: add ceph.conf configmap
Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2021-09-24 16:44:46 +02:00
wangyunqing
3ab2cddd77 doc/rbd/rbd-windows.rst: fix typos
Signed-off-by: wangyunqing <wangyunqing@inspur.com>
2021-09-22 11:17:48 +08:00
Ilya Dryomov
be23d3cfbf
Merge pull request #43225 from guits/fix-iscsi-doc
doc/iscsi: fix some typos

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2021-09-21 14:35:59 +02:00
Guillaume Abrioux
a715b3f15c doc/iscsi: fix some typos
This fixes some typos in the iscsi documentation.

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
2021-09-20 16:02:33 +02:00
Lucian Petrut
0c823a54a6 doc/rbd: describe Hyper-V disk addressing limitations
Hyper-V identifies passthrough VM disks by number instead of SCSI ID, although
the disk number can change across host reboots. This means that the VMs can end
up using incorrect disks after rebooting the host, which is an important
security concern. This issue also affects iSCSI and Fibre Channel disks.

We're going to document this Hyper-V limitation along with possible
workarounds.

Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2021-09-08 06:27:25 +00:00
Ilya Dryomov
b367672082 doc: adjust client.rbd-mirror-peer mon cap
On top of "profile rbd" permissions, "profile rbd-mirror-peer" also
allows getting rbd/mirror and setting rbd/mirror/peer/* config keys.
This is what "rbd mirror pool peer bootstrap create" does.

Fixes: https://tracker.ceph.com/issues/50970
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-09-03 18:17:47 +02:00
Ilya Dryomov
1fe44830b6 doc: add some details about rbd-mirror site names
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-09-03 18:17:47 +02:00
Ilya Dryomov
7b3fe154e5 doc/rbd/rbd-nomad: fix indentation in config snippets
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-08-27 14:12:35 +02:00
Zac Dover
977e6cffb3 doc: clean rbd-nomad.rst
This PR improves the rbd-nomad.rst file.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-08-27 14:12:35 +02:00
Ilya Dryomov
8a3448f6a9
Merge pull request #42806 from zdover23/wip-doc-2021-08-17-rbd-nomad-3-of-x
doc: rewrite configure ceph-csi to "conf. nomad"

Reviewed-by: Etienne Menguy <etienne.menguy@croit.io>
Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2021-08-24 17:41:57 +02:00
Zac Dover
795877cd49 doc: rewrite configure ceph-csi to "conf. nomad"
This PR rewrites the sections
     - Configure Ceph-CSI
     - Configure Nomad

in the rbd-nomad.rst Chapter of the RBD
Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-08-24 16:55:30 +02:00
Ilya Dryomov
b8921a0c9a
Merge pull request #42805 from zdover23/wip-doc-2021-08-17-rbd-nomad-2-of-x
doc: improve "Create a Pool" in rbd-nomad.rst

Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2021-08-24 16:32:42 +02:00
Zac Dover
1715989e06 doc: improve "Create a Pool" in rbd-nomad.rst
This PR improves the English in the "Create
a Pool" section of the "RBD & Nomad Integration"
chapter of the RBD Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-08-24 16:16:24 +02:00
Zac Dover
66ebe00fb3 doc: improve RBD "Block Devices and Nomad"
This PR improves the English syntax and
spelling in the "Block Devices and Nomad"
section of the rbd-nomad.rst page.

This PR rewrites the top-level matter.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-08-17 14:34:49 +10:00
Etienne Menguy
c20a37698d
Improving syntax
Signed-off-by: Etienne Menguy <etienne.menguy@croit.io>
2021-07-07 10:26:21 +02:00
Etienne Menguy
a335ee96ab
Adding missing sudo
Signed-off-by: Etienne Menguy <etienne.menguy@croit.io>
2021-07-07 10:14:12 +02:00
Etienne Menguy
0a2a461a0c
Fixing typo
Signed-off-by: Etienne Menguy <etienne.menguy@croit.io>
2021-07-07 10:13:22 +02:00
Etienne Menguy
4f4110b980 Adding rbd-nomad to the index
Signed-off-by: Etienne Menguy <etienne.menguy@croit.io>
2021-07-03 22:58:39 +02:00
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