RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2024-12-30 07:23:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
147,603 Commits 210 Branches 394 Tags 1.4 GiB
2d28faaeea
Commit Graph

428 Commits

Author SHA1 Message Date
Ilya Dryomov
2e83b77c9f doc/rbd/rbd-exclusive-locks: mention incompatibility with advisory locks 
This is due to both using the same name for the lock at the RADOS level
("rbd_lock").

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
 2024-07-25 18:15:16 +02:00
N Balachandran
0cd415c53b doc/rbd: fix typos in NVMe-oF docs. 
Signed-off-by: N Balachandran <nibalach@redhat.com>
 2024-06-18 16:09:51 +05:30
N Balachandran
4fd5c13453 docs/rbd: typo in "retrieving image information" 
Replace "for the image" with "of the image".

Signed-off-by: N Balachandran <nibalach@redhat.com>
 2024-03-18 10:04:44 +05:30
N Balachandran
ebf2f60f78 docs/rbd: replace introspect with inspect 
Replace "introspect" with "inspect" in the rbd basic commands
description.

Signed-off-by: N Balachandran <nibalach@redhat.com>
 2024-03-18 09:41:10 +05:30
N Balachandran
f3eb489520 docs/rbd: fix typo in arg name 
Replace "{image-}" with "{image-id}" in the "rbd trash rm"
command description.

Signed-off-by: N Balachandran <nibalach@redhat.com>
 2024-03-18 09:32:39 +05:30
Zac Dover
d34c1879c8 doc/rbd: add clone mapping command 
Add a command that explains how to map a formatted clone when the parent
image and the formatted clone have different encryption types.

Signed-off-by: Zac Dover <zac.dover@proton.me>
 2024-03-15 05:40:27 +10:00
N Balachandran
7a2e324a6e doc/rbd: add map information for clone images to rbd-encryption.rst 
Add information on the arguments required when mapping the
formatted clone of an encrypted parent image.

Co-authored-by: Zac Dover <zac.dover@proton.me>
Signed-off-by: N Balachandran <nibalach@redhat.com>
 2024-03-14 00:15:08 +10:00
Zac Dover
6df12da2cd doc/rbd: repair ordered list 
Fix the numbering in an ordered list. The numbering was thrown off
because a ".. prompt" directive was improperly indented (it wasn't
indented at all).

See https://github.com/ceph/ceph/pull/55540#discussion_r1500051264

Signed-off-by: Zac Dover <zac.dover@proton.me>
 2024-02-24 02:05:42 +10:00
Orit Wasserman
9f86c35a0d doc: Add NVMe-oF gateway documentation 
- Add nvmeof-initiator-esx.rst
- Add nvmeof-initiator-linux.rst
- Add nvmeof-initiators.rst
- Add nvmeof-overview.rst
- Add nvmeof-requirements.rst
- Add nvmeof-target-configure.rst
- Add links to rbd-integrations.rst

Co-authored-by: Ilya Dryomov <idryomov@redhat.com>
Co-authored-by: Zac Dover <zac.dover@proton.me>
Signed-off-by: Orit Wasserman <owasserm@ibm.com>
 2024-02-23 03:40:17 +10:00
Himura Kazuto
886af37744
doc: specify correct fs type for mkfs 
The default value is ext2, which is not supported (anymore?).

Signed-off-by: Vladislav Glagolev <vladislav.glagolev@devexpress.com>
 2024-01-23 13:21:01 +00:00
Daniel Clavijo Coca
ee2ee31d3f docs: Add information about OpenNebula integration 
- Exclude doc build output from git
- Fix missing doc build dependency
- Also includes some involuntary automatically persistent linting by vscode

Co-authored-by: Ilya Dryomov <idryomov@redhat.com>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Co-authored-by: Zac Dover <zac.dover@proton.me>
Signed-off-by: Daniel Clavijo <dclavijo@opennebula.io>
 2023-12-18 08:04:32 +10:00
Ilya Dryomov
aa2c5c09a0
Merge pull request #51964 from idryomov/wip-doc-drop-journal-max-fetch-bytes 
doc: drop mention of rbd_mirror_journal_max_fetch_bytes option

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Mykola Golub <mgolub@suse.com>
 2023-08-29 14:43:00 +02:00
Ilya Dryomov
b239a8b90a doc: drop mention of rbd_mirror_journal_max_fetch_bytes option 
It was removed in commit 1ef12ea0d2 ("rbd-mirror: remove
rbd_mirror_journal_max_fetch_bytes option") in 2019.  Commit
32375cb789 ("doc: misc clarity and capitalization") added a "tip"
mentioning it in 2020 in an attempt to capture advice [1].

[1] https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/IHMGNFLWCD5E5R4W5S2BSSKEB5X3N4S4/

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
 2023-08-29 13:41:47 +02:00
Jayanth Reddy
5bce61ecf3 doc/rbd/rbd-cloudstack.rst: include support for multiple monitors 
Signed-off-by: Jayanth Reddy <45934027+zap51@users.noreply.github.com>
 2023-07-24 23:02:53 +02:00
Ilya Dryomov
2af7252b33 doc/rbd/rbd-exclusive-locks: warn about automatic lock transitions 
A lot of people aren't aware of automatic lock transitions and
wrongfully assume that exclusive lock means that the image remains
locked for as long as the client is running.  Redo the explanation
and add a warning.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
 2023-01-20 11:33:54 +01:00
Ilya Dryomov
c966ea99bc doc/rbd/rbd-exclusive-locks: don't mention "profile rbd" requirement twice 
It's (much better) described in the Blocklisting section.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
 2023-01-20 11:33:24 +01:00
Zac Dover
26b8e9cb93 doc/rbd: format iscsi-initiator-linux.rbd better 
Add prompts and clean up the lists in doc/rbd/iscsi-initiator-linux.rbd.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2023-01-16 05:39:54 +10:00
Zac Dover
62b0012751 doc/rbd: refine rbd-exclusive-locks.rst 
Refine grammar (mostly semantics) in rbd-exclusive-locks.rst.

Co-authored-by: Ilya Dryomov <idryomov@redhat.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-30 01:14:38 +10:00
Zac Dover
39c18021d6 doc/rbd: s/wuold/would/ in rados-rbd-cmds.rst 
s/wuold/would/ in rados-rbd-cmds.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-27 22:28:49 +10:00
Ilya Dryomov
00332ccbfa
Merge pull request #48929 from petrutlucian94/rbd_py_test 
qa: fix test_rbd_wnbd.py

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
 2022-12-21 11:42:57 +01:00
Zac Dover
292c826acd doc/rbd: refine rbd-snapshot.rst 
Refine the text in rbd-snapshot.rst

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-17 00:28:06 +10:00
Lucian Petrut
cceeb8be9f doc: document Windows SAN policy 
The Windows SAN policy determines which disks will be mounted
automatically. We're going to document this as well as some
Windows limitations.

Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
 2022-12-16 12:14:54 +02:00
Zac Dover
8df894b753 doc/rbd: remove typo and ill-formed command 
Ingest Ilya Dryomov's comments here https://github.com/ceph/ceph/pull/49340/files#r1044365857

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-10 13:20:17 +10:00
colemitchell
7c8617423d
Merge pull request #49342 from zdover23/wip-doc-2022-12-09-rbd-rados-rbd-cmds-removing-a-block-device-semantics 
doc/rbd: refine "Removing a Block Device Image"

Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
 2022-12-09 01:45:28 -05:00
Zac Dover
3a6284a49b doc/rbd: refine "Removing a Block Device Image" 
Refine and add unselectable prompts to "Removing a Block Device Image"
in doc/rbd/rados-rbd-cmds.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-09 16:38:46 +10:00
colemitchell
9ccf87c165
Merge pull request #49341 from zdover23/wip-doc-2022-12-09-rbd-rados-rbd-cmds-resizing-a-block-device-image-semantics 
doc/rbd: refine "Resizing a Block Device Image"

Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
 2022-12-09 01:17:17 -05:00
Zac Dover
8fb4edb92d doc/rbd: refine "Restoring a Block Device Image" 
Refine and add unselectable prompts to "Restoring a Block Device Image"
in doc/rbd/rados-rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-09 16:07:19 +10:00
Zac Dover
078bec94d0 doc/rbd: refine "Resizing a Block Device Image" 
Refine and add unselectable prompts to "Resizing a Block Device Image"
in doc/rbd/rados/rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-09 15:19:54 +10:00
colemitchell
19426975b2
Merge pull request #49338 from zdover23/wip-doc-2022-12-09-rbd-rados-rbd-cmds-creating-a-block-device-image-semantics 
doc/rbd: refine "Creating a Block Device Image"

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
 2022-12-08 23:50:23 -05:00
colemitchell
7c1191da75
Merge pull request #49340 from zdover23/wip-doc-2022-12-09-rbd-rados-rbd-cmds-retrieving-image-information-semantics 
doc/rbd: refine "Retrieving Image Information"

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
 2022-12-08 23:50:07 -05:00
Zac Dover
d418037b38 doc/rbd: refine "Retrieving Image Information" 
Refine the text and prompts in "Retrieving Image Information" in
doc/rbd/rados-rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-09 10:45:19 +10:00
Zac Dover
ad3c93535f doc/rbd: refine "Listing Block Device Images" 
Refine the text and prompts in "Listing Block Device Images" in
doc/rbd/rados-rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-09 10:21:47 +10:00
Zac Dover
20b14437d6 doc/rbd: refine "Creating a Block Device Image" 
Refine the English and prompts in "Creating a Block Device Image" in
doc/rbd/rados-rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-09 09:53:14 +10:00
Zac Dover
b6cc04e0bc doc/rbd: refine "Create a Block Device User" 
Refine "Create a Block Device User", after suggestions made by Ilya
Dryomov in https://github.com/ceph/ceph/pull/49301#pullrequestreview-1208285685

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-08 10:38:52 +10:00
Zac Dover
987d3163a1 doc/rbd: refine "Create a Block Device Pool" 
Refine the "Create a Block Device Pool" section of
doc/rbd/rados-rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-07 23:14:02 +10:00
Zac Dover
51bc43845f doc/rbd: refine "Create a Block Device User" 
Refine "Create a Block Device User" in doc/rbd/rados-rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-12-07 13:58:20 +10:00
Ilya Dryomov
51d8c526f0 doc/rbd: add clone encryption details and examples 
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
 2022-12-04 18:24:06 +01:00
Ilya Dryomov
a27ee2bdf8 rbd, rbd-nbd: make --encryption-format optional 
If no --encryption-format specified at all, default to "luks" for each
specified --encryption-passphrase-file.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
 2022-12-04 18:19:19 +01:00
Ilya Dryomov
d642f7804b rbd, rbd-nbd: don't strip trailing newline in passphrase files 
One of the stated goals is compatibility with standard LUKS tools,
in particular being able to load encryption on images formatted with
cryptsetup.  cryptsetup doesn't do this and this really interferes
with randomly generated (binary) passphrases.

While at it, open passphrase files as binary -- it communicates the
intent if nothing else on POSIX.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
 2022-12-04 18:19:19 +01:00
Zac Dover
8108c4b0ac doc/rbd: add prompts to iscsi-monitoring.rst 
Add unselectable prompts to doc/rbd/iscsi-monitoring.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-11-28 10:11:04 +10:00
Zac Dover
fdb1685f86 doc/rbd: update iSCSI gateway info 
Update iSCSI gateway info in the RBD documentation.

https://tracker.ceph.com/issues/58080

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-11-27 06:41:35 +10:00
Ilya Dryomov
fb9491e0ec
Merge pull request #48949 from ktdreyer/doc-windows-drive-letter 
doc: display Windows RBD drive letter

Reviewed-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
 2022-11-20 11:24:25 +01:00
Zac Dover
3fc21e539d doc/rbd: improve grammar in "immutable object..." 
Improve the grammar in the "Immutable Object Cache Daemon" section.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2022-11-20 17:13:20 +10:00
Ken Dreyer
02c2ef8c3b doc: display Windows RBD drive letter 
Give the Powershell command that identifies the Windows drive letter
when partitioning a new RBD image.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
 2022-11-18 16:28:01 -05:00
Ilya Dryomov
9805983bcd doc: note architecture availability for PMEM mode of PWL cache 
Fixes: https://tracker.ceph.com/issues/49947
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
 2022-10-30 18:10:29 +01:00
Ilya Dryomov
0f93f745c6
Merge pull request #40363 from orozery/rbd-clone-encryption 
librbd: add encryption format support for clones (part 1/2)

Reviewed-by: Mykola Golub <mgolub@suse.com>
Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
 2022-10-25 18:16:33 +02:00
Or Ozeri
1d3de19c40 tools/rbd: add encryption format support for cloned image 
This commit adds the encryption format support for cloned images via the RBD cli,
making the child image be encrypted with a key different from it parent,
while keeping the child thinly-provisioned.
Additionally, other APIs are extended to support flattening of such images.

Signed-off-by: Or Ozeri <oro@il.ibm.com>
 2022-08-25 18:41:47 +03:00
Malte Janduda
ad86ffb35d doc: virtio discard is supported since kernel 5.0 
Signed-off-by: Malte Janduda <mail@janduda.net>
 2022-08-22 11:35:38 +02:00
Or Ozeri
9892ead7fc librbd/crypto: allow loading luks format without specifying version 
This commits extends rbd API's to allow the user to load encryption
using either LUKS1 or LUKS2 formats, without explicitly specifying which.
Prior, the user had to specify explicitly LUKS1 or LUKS2.

Signed-off-by: Or Ozeri <oro@il.ibm.com>
 2022-08-04 10:36:07 +03:00
Josh Soref
8abce157f1 doc: Fix many spelling errors 
* administrators
* allocated
* allowed
* approximate
* authenticate
* availability
* average
* behavior
* binaries
* bootstrap
* bootstrapping
* capacity
* cephadm
* clients
* combining
* command
* committed
* comparison
* compiled
* consequences
* continues
* convenience
* cookie
* crypto
* dashboard
* deduplication
* defaults
* delivered
* deployment
* describe
* directory
* documentation
* dynamic
* elimination
* entries
* expectancy
* explicit
* explicitly
* exporter
* github
* hard
* healthcheck
* heartbeat
* heavily
* http
* indices
* infrastructure
* inherit
* layout
* lexically
* likelihood
* logarithmic
* manually
* metadata
* minimization
* minimize
* object
* of
* operation
* opportunities
* overwrite
* prioritized
* recipe
* records
* requirements
* restructured
* running
* scalability
* second
* select
* significant
* specify
* subscription
* supported
* synonym
* throttle
* unpinning
* upgraded
* value
* version
* which
* with

Plus some line wrapping and additional edits...

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
 2022-07-02 23:38:18 -04:00