Commit Graph

851 Commits

Author SHA1 Message Date
Zac Dover
02177f6368 doc/man: edit ceph-monstore-tool.rst
Clean up the English in doc/man/8/ceph-monstore-tool.rst. Put all
commands in the imperative mood; make sentences more direct.

Follows https://github.com/ceph/ceph/pull/52860.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-14 13:27:10 +10:00
J. Eric Ivancich
815481c637
Merge pull request #51071 from ivancich/wip-versioned-reindex
rgw: reindex of objects in versioned buckets

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2023-09-07 12:43:59 -04:00
Rishabh Dave
849fbd1d5b
Merge pull request #41779 from rishabh-d-dave/fs-auth-subcmd
mon,osd,mds: allow fs authorize to update caps

Reviewed-by: Radosław Zarzyński <rzarzyns@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
2023-09-07 18:39:58 +05:30
Rishabh Dave
f203542c3e doc/cephfs: add doc for fs authorize since it can now also update caps
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2023-09-07 11:37:17 +05:30
Zac Dover
fb808732e8 doc/man: radosgw-admin.rst typo
Edit the text in the "bucket radoslist" entry.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-07 00:23:06 +10:00
Zac Dover
fa40b7ef56 doc/man: remove docs about support for unix domain sockets
doc/man: support for unix domain sockets is not implemented, hence we
removed documentation about it.

(Note: the changes in this commit were the work of Rok Jaklič in
https://github.com/ceph/ceph/pull/48537. This pull request has been
raised because that pull request was for some mysterious reason causing
merge conflicts that were never resolved.)

Co-authored-by: Rok Jaklič rjaklic@gmail.com
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-06 16:33:43 +10:00
Anthony D'Atri
d986537f9b doc/man/8: improve radosgw-admin.rst
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2023-09-03 09:56:44 -04:00
J. Eric Ivancich
522785e053 rgw: allow multisite specification used w/ rgw-restore-bucket-index script
When the metadata for a bucket is requested only the default
realm/zonegroup/zone is currently supported. This adds three new
command-line options to rgw-restore-bucket-index:

    -r <realm-name>
    -g <zonegroup-name>
    -z <zone-name>

The multisite specification will then be used in invocations of
`radosgw-admin`, such as to query the zone, get metadata, and invoke
the "object reindex" subcommand.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
2023-08-30 14:41:15 -04:00
J. Eric Ivancich
c02906ae64 rgw: enhances rgw-restore-bucket-index script
This enhances the script to both process versioned buckets correctly
and to handle object names that begin with underscore.

If the bucket is versioned it submits each version chronologically
(based on mtime) to be reindexed in order to "replay" the modification
of objects. However mtime is not a perfect indicator. So additionally
it looks at the OLH object to determine the most recent version and
the script makes sure that it is replayed last. The order of previous
versions is likely correct, but not guaranteed to be so.

Additional logic is added to handle objects with names that begin with
underscore ('_') since that's used as a delimiter and needs to be
escaped and rados object locators are also used.

A man page for the script is added.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
2023-08-30 14:41:15 -04:00
J. Eric Ivancich
f731570bb1 rgw: enhance functionality of radosgw-admin object reindex ...
Adds ability to handle versioned buckets to reindexing. Also, it
completes the addition of the index entries without the subsequent
need to list the bucket.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
2023-08-09 10:08:03 -04:00
Matan Breizman
ccfe7e50b6 doc/man/8/ceph-monstore-tool: add documentation
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2023-08-07 13:55:26 +00:00
Ville Ojamo
ee328e1677
doc/man/radosgw: more underscores in config var names
Missed one section of `ceph.conf` example where spaces were used instead of underscores.

Change spaces in config var names to underscores.
2023-07-07 17:28:08 +07:00
Ville Ojamo
0961c7d18c
doc/man/radosgw: use underscores in configuration
Most of the documentation already uses underscores instead of spaces in configuration variable names.

Update radosgw(8) man page to follow, changing spaces into underscores.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-07-07 16:49:21 +07:00
Laura Flores
4fcab2e7fc doc/man/8: add documentation about read balancer
Signed-off-by: Laura Flores <lflores@redhat.com>
Co-authored-by: Josh Salomon <josh.salomon@gmail.com>
2023-06-22 09:54:48 -05:00
Ilya Dryomov
1caadd7f2a
Merge pull request #50341 from yangdongsheng/ubbd
rbd: add support for new device type of ubbd

Reviewed-by: Mykola Golub <mykola.golub@clyso.com>
Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2023-06-05 23:12:28 +02:00
Yuri Weinstein
b2ec2aff80
Merge pull request #50651 from rosinL/cleanup
Cleanup the LevelDB residue


Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2023-06-05 11:32:51 -04:00
Adam King
b5eb2e79b4
Merge pull request #51172 from adk3798/require-image-for-inspect
cephadm: require --image is passed to inspect-image

Reviewed-by: John Mulligan <jmulligan@redhat.com>
2023-05-21 15:42:36 -04:00
Dongsheng Yang
54853a5ae7 tools/rbd: add support of new device type for ubbd
ubbd (Userspace Backend Block Device) is a method to build block device
and handle IO by process started in userspace. That means we can provide
a generic block device to user and handle IO requests by librbd
in linux.

This way, we can allow user to use rbd image as a linux block device
supporting full image features, especial the journaling feature, which
is not supported by krbd.

For more information: https://github.com/DataTravelGuide/ubbd

Signed-off-by: Dongsheng Yang <dongsheng.yang.linux@gmail.com>
2023-05-18 12:35:39 +00:00
Mitsumasa KONDO
a2224a1b93 doc: fix under bar to hyphen in stripe-unit and stripe-count
Signed-off-by: Mitsumasa KONDO <kondo.mitsumasa@gmail.com>
2023-05-18 16:34:23 +09:00
luo rixin
6da360833a doc: remove leveldb support from doc
Signed-off-by: luo rixin <luorixin@huawei.com>
2023-05-04 10:43:08 +08:00
luo rixin
e4c1a5fe2f tools: remove leveldb support from tools
ceph-kvstore-tool: remove leveldb from usage info
kvstore_tool: correct the comment

Signed-off-by: luo rixin <luorixin@huawei.com>
2023-05-04 10:43:08 +08:00
Adam King
110fcb04ad cephadm: require --image is passed to inspect-image
The selection of an image by default was likely unused and
has always been a bit of a flaky thing, especially if multiple
clusters are making use of the host where this is run. It seems
preferable to just require this argument. Additionally, the
command without the image specified is currently untested
and prone to being broken. All uses of inspect-image done
through the cephadm mgr module specify the image.

Signed-off-by: Adam King <adking@redhat.com>
2023-05-02 17:16:06 -04:00
Ilya Dryomov
d3558c49bf doc/man/rbd: resurrect filestore alloc_size note
Mistakenly removed in commit d79f2a81541c ("docs: warning and remove
few docs section for Filestore Update docs after filestore removal.").
The kernel client, however new, will continue to be able to talk to
FileStore OSDs for as long as they exist.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2023-04-20 12:08:40 +02:00
Nitzan Mordechai
d79f2a8154 docs: warning and remove few docs section for Filestore
Update docs after filestore removal.

Signed-off-by: Nitzan Mordechai <nmordech@redhat.com>
2023-04-20 05:01:53 +00:00
Rishabh Dave
84bf2dc603 doc/man/ceph: add missing "ceph fs" commands
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2023-04-03 23:19:58 +05:30
Radoslaw Zarzynski
6668814a17
Merge pull request #49528 from NitzanMordhai/wip-nitzan-filestore-removal
Reef: filestore removal

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2023-02-23 12:20:49 +01:00
Venky Shankar
ae6f1b18be Merge PR #50175 into main
* refs/pull/50175/head:
	cephfs: upgrade cephfs-shell's path wherever necessary

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
2023-02-22 19:47:43 +05:30
Rishabh Dave
48ef044477 cephfs: upgrade cephfs-shell's path wherever necessary
Commit dc69033763cc116c6ccdf1f97149a74248691042 moves cephfs-shell from
"<CEPH-REPO-ROOT>/src/tools/cephfs/" to
"<CEPH-REPO-ROOT>/src/tools/cephfs/shell" but cephfs-shell's location in
src/vstart.sh and qa/tasks/cephfs/test_cephfs_shell.py is left
un-updated. This produces a broken vstart_environment.sh and broken
export command in test_cephfs_shell.py.

Introduced-by: dc69033763cc116c6ccdf1f97149a74248691042
Fixes: https://tracker.ceph.com/issues/58795
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2023-02-21 19:16:27 +05:30
Jos Collin
247f81e5b4
doc: updates --dump and --dumpfs
Fixes: https://tracker.ceph.com/issues/57014
Signed-off-by: Jos Collin <jcollin@redhat.com>
2023-02-16 15:13:19 +05:30
NitzanMordhai
839a0dcf7d ObjectStore: FileStore has been deprecated
ObjectStore will no longer create new FileStore object store and OSD
will terminate

dencoder: remove filestore
  remove filestore headers and change some location for other
  non related filestore headers

tools: ceph-objectstore-tool remove filestore functions
  Removing un-needed options after depreciting filestore

tools: Change DBObjectMap location
  change header path after depreciting filestore

FileStore: Delete folders, files and CMake entries from os
  depreciting filestore files and CMake entries

Signed-off-by: Nitzan Mordechai <nmordec@redhat.com>
2023-02-12 06:11:29 +00:00
Ilya Dryomov
8ca3bd5042 doc/man/ceph-rbdnamer: remove obsolete udev rule
Fixes: https://tracker.ceph.com/issues/58398
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2023-01-10 13:43:03 +01:00
Jos Collin
86f8fa19e5
doc: document the relevance of mds_namespace mount option
Fixes: https://tracker.ceph.com/issues/57673
Signed-off-by: Jos Collin <jcollin@redhat.com>
2023-01-10 14:48:20 +05:30
Zac Dover
10fa01d075 doc/man: define --num-rep, --min-rep and --max-rep
Explain the "--num-rep", "--min-rep", and "--max-rep" options, which are
required when running "crushtool" commands with the "--show-mappings"
flag. Originally reported by Brad Fitzpatrick.

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

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-07 02:12:26 +10:00
Marcus Watts
28864311d3 rgw: added rgw-policy-check
rgw-policy-check - a program to do syntax checking on bucket policy.
This program just reads the policy into memory, so it is not
checking anything except syntax.

Signed-off-by: Marcus Watts <mwatts@redhat.com>

rgw: Fix return value of `rgw-policy-check`

Signed-off-by: Adam C. Emerson <aemerson@redhat.com>

rgw: Use ceph initialization in `rgw-policy-check`

Specifically so we can pull in the options from `ceph.conf` and similar.

Signed-off-by: Adam C. Emerson <aemerson@redhat.com>
2022-12-13 16:41:52 -05:00
Cory Snyder
9052ca420f rgw: add 'inline_data' zone placement info option
Adds a new RGW zone placement info option to control whether
an object's first data chunk is placed in the head object.
This allows admins to make a tradeoff between optimizing for
PUT/GET performance vs. DELETE performance for some cluster
configurations.

Fixes: https://tracker.ceph.com/issues/57965
Signed-off-by: Cory Snyder <csnyder@iland.com>
2022-12-12 03:24:35 -05:00
Ilya Dryomov
e62e3b6613 rbd, rbd-nbd: accept "luks", "luks1" and "luks2" formats
Since RBD_ENCRYPTION_FORMAT_LUKS1, RBD_ENCRYPTION_FORMAT_LUKS2
and RBD_ENCRYPTION_FORMAT_LUKS aren't treated the same when loading
encryption anymore, "luks1" and "luks2" formats need to be accepted
in addition to "luks" format.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2022-12-04 18:19:19 +01:00
Ilya Dryomov
2279ae08f1 librbd: remap resize target size if encryption is loaded
When encryption is loaded, rbd_get_size() and Image::size() return
"effective" size, but rbd_resize() and Image::resize() continue to take
raw size.  The user has to constantly keep these domains in mind.

Saying that resize must be done without encryption loaded is not an
answer because shrinking a clone that has snapshots involves copying up
objects in the affected range (identical to flattening).  In addition,
even if a clone doesn't have snapshots, shrinking it to a size that
isn't an object boundary is going to involve a copyup for the victim
object as well.

To avoid subtle data corruption on shrink, treat resize operation the
same as flatten operation (including on the CLI).

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2022-12-04 18:19:19 +01:00
Ilya Dryomov
af6ed506f2
Merge pull request #48680 from pkalever/snap-id
rbd: add --snap-id option to "rbd device map" to allow mapping arbitrary snapshots

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2022-11-27 14:10:31 +01:00
Zac Dover
3402c34034 doc/man: disambiguate "user" in a command
Explain that "user" means "RADOS client name" and "RADOS user", per a
complaint solicited through the "Report Documentation Bugs" system.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-19 02:09:44 +10:00
Prasanna Kumar Kalever
614c91c005 rbd: add --snap-id option to "rbd device map|unmap|attach|detach"
Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
2022-11-10 19:28:30 +05:30
Prasanna Kumar Kalever
75226f1be2 rbd-nbd: provide a way to map snapshots by id
Currently we don't have a way to map arbitrary snapshots,
this commit provides --snap-id option to all such snapshots

$ rbd --cluster=site-a snap ls pool1/test_image --all --format=json --pretty-format
[
    {
        "id": 4,
        "name": ".mirror.primary.c6fe94fd-3f9b-4ce0-aecc-e9d07472fd46.528a3f48-1b5c-4abb-9089-5a454328aeb3",
        "size": 1073741824,
        "protected": "false",
        "timestamp": "Thu Oct 27 22:09:12 2022",
        "namespace": {
            "type": "mirror",
            "state": "primary",
            "mirror_peer_uuids": [
                "3e99dc15-78ca-46bd-8934-93d8063c0081"
            ],
            "complete": true
        }
    }
]

$ rbd-nbd --cluster=site-a map --snap-id=4 pool1/test_image
/dev/nbd0

$ rbd-nbd list-mapped
id      pool   namespace  image       snap  device     cookie
511989  pool1             test_image  @4    /dev/nbd0  68de2ef3-1d22-43b9-8318-03f3d31ec8b5
513439  pool1             test_image  @5    /dev/nbd1  f3222c04-4048-4c61-a0b1-28536c4a29a7

Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
2022-11-10 19:28:24 +05:30
Zac Dover
95154ed492 doc/glossary: define "OSD"
Define "OSD" as "Object Storage Device", distinct from
"object storage daemon".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-07 04:04:04 +10: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
Anthony D'Atri
e87b47d855
Merge pull request #45552 from wxypro/man-cephfs-mirror
doc/man/cephfs-mirror.rst: Update missing options for cephfs-mirror
2022-08-22 11:43:16 -07:00
Salar Nosrati-Ershad
7840573a92 doc/man/8: Remove slash behind bucket name in radosgw-admin.rst
Signed-off-by: Salar Nosrati-Ershad <snosratiershad@gmail.com>
2022-08-22 20:22:12 +04:30
Ilya Dryomov
0d4786e0af
Merge pull request #44436 from nh2/patch-2
doc/man/rbd: Mention changed `bluestore_min_alloc_size`

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2022-08-12 17:57:59 +02:00
Niklas Hambüchen
254025343b doc/man/rbd: Mention changed bluestore_min_alloc_size
This change was done in: https://github.com/ceph/ceph/pull/34588

Signed-off-by: Niklas Hambüchen <mail@nh2.me>
2022-08-12 17:00:23 +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
wangxinyu
58474bd82e doc/man/cephfs-top.rst: add missing options: --delay, --conffile
add missing options: --delay, --conffile

Signed-off-by: wangxinyu <wangxinyu@inspur.com>
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2022-07-19 08:55:08 +05:30