Commit Graph

830 Commits

Author SHA1 Message Date
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
Ilya Dryomov
d3558c49bf doc/man/rbd: resurrect filestore alloc_size note
Mistakenly removed in commit d79f2a8154 ("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 dc69033763 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: dc69033763
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
Rishabh Dave
9f95f96dc0
Merge pull request #45998 from dparmar18/implement_ln_cephfs_shell
cephfs-shell: ln command implementation

Reviewed-by: Nikhilkumar Shelke <nshelke@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Rishabh Dave <ridave@redhat.com>
2022-07-08 19:26:34 +05:30
dparmar18
da779e1e93 doc/man/cephfs-shell.rst: documentation of ln command
Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
2022-07-06 16:31:28 +05:30
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
Redouane Kachach
443f93e95d
doc/cephadm: document the new per-fsid cephadm conf location
Fixes: https://tracker.ceph.com/issues/55357

Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-06-22 08:25:23 +02:00
Anthony D'Atri
3e24921adc doc/man/8: Tweak formatting and wording in ceph.rst
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-06-11 14:21:50 -07:00
Anthony D'Atri
784f5bb9bf
Merge pull request #46200 from elacunza/doc-man-ceph-add-enable_stretch_mode
doc/man/8: Add enable_stretch_mode docs
2022-06-11 14:02:32 -07:00
Yuri Weinstein
bc02a55d3a
Merge pull request #45409 from NUABO/tancz
mon: add proxy to cache tier options

Reviewed-by: Neha Ojha <nojha@redhat.com>
2022-05-24 07:59:36 -07:00
dparmar18
db8ff8b809 doc/man/cephfs-shell.rst: get cmd must accept both path mandatorily
Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
2022-05-11 17:16:28 +05:30
dparmar18
70e21a92df doc/man/cephfs-shell.rst: put cmd must accept both path mandatorily
Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
2022-05-11 17:10:36 +05:30
Eneko Lacunza
b15af334da doc/man/8: Additional enable_stretch_mode explanation and rework layout
Add additional explanation about stretch mode as suggested by Anthony,
rework a bit the layout of argument details.

Signed-off-by: Eneko Lacunza <elacunza@binovo.es>
2022-05-09 18:56:39 +02:00
Eneko Lacunza
da0051f9a2 doc/man/8: Add enable_stretch_mode docs
Explanation taken from ceph mon -h, plus additional sentence for explaining
new_crush_rule arg.

Signed-off-by: Eneko Lacunza <elacunza@binovo.es>
2022-05-09 10:22:23 +02:00
tancz1
77ad5a810c mon: add proxy to cache tier options
When we set the proxy mode to remove a writeback cache according to
the ceph official documentation an error occurred:

[root@controller-1 root]# ceph osd tier cache-mode cachepool proxy
Invalid command: proxy not in writeback|readproxy|readonly|none
osd tier cache-mode writeback|readproxy|readonly|none [--yes-i-really-mean-it]:
specify the caching mode for cache tier

According to the description of the official website document: since
a writeback cache may have modified data, you must take steps to ensure
that you do not lose any recent changes to objects in the cache before
you disable and remove it. Change the cache mode to proxy so that new and
modified objects will flush to the backing storage pool.

Fixes: https://tracker.ceph.com/issues/54576
Signed-off-by: tan changzhi <544463199@qq.com>
2022-04-29 10:40:40 +08:00
dparmar18
eefa3f6742 doc/man/cephfs-shell.rst: add use of exclamation mark with cmds
Description: `!` -  Exclamation mark can be used to interact with local
             file system apart from Ceph File System too. This PR intends
             to document it.

Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
2022-04-27 00:39:23 +05:30
Laura Flores
e23b53833f doc/man/8: update the description of --format
The `ceph --format` option includes yaml, which
is only valid for orch commands.

Signed-off-by: Laura Flores <lflores@redhat.com>
2022-04-06 11:57:07 -05:00
wangxinyu
fb361d1dbd doc/man/cephfs-mirror.rst: Update missing options for cephfs-mirror
Update missing options for cephfs-mirror

Signed-off-by: wangxinyu <wangxinyu@inspur.com>
2022-03-22 17:20:40 +08:00
Venky Shankar
84835e6b71
Merge pull request #41397 from vshankar/wip-48619
cephfs-top: display average read/write/metadata latency

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2022-03-07 10:34:15 +05:30
Venky Shankar
2de993b969
Merge pull request #44971 from joscollin/wip-doc-fix-name-id
doc: mention MDS name and ID format in ceph-mds.rst

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2022-02-14 12:19:43 +05:30
Anthony D'Atri
e5b9173836
Merge pull request #44898 from taggelos/patch-1
doc/man/8: Fix spelling in user rename example
2022-02-12 02:52:16 -08:00
Jos Collin
3404d4c8ed
doc: mention MDS name and ID format in ceph-mds.rst
Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-02-11 10:20:47 +05:30
Venky Shankar
aa04f3faed doc: include read, write, metadata average latencies in doc/man.
Also, the sample cephfs-top image in the doc is outdated. Update that!

Fixes: http://tracker.ceph.com/issues/48619
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2022-02-09 02:51:25 -05:00
Aggelos Toumasis
11909d0d84 doc/man/8: Fix spelling in user rename example
Signed-off-by: Aggelos Toumasis toumasis.aggelos@gmail.com
2022-02-08 12:35:27 +01:00