Commit Graph

694 Commits

Author SHA1 Message Date
Patrick Donnelly
812090390f
doc/cephfs: correct names for fs/meta
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-11-22 12:08:06 -05:00
Zac Dover
75de28e9b2 doc/glossary: add "mds" term
Improve "MDS" glossary term. Link to MDS information.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-14 14:24:19 +10:00
Jos Collin
fafe3d4d12
Revert "doc: update cephfs-top.png"
This reverts commit 2233b68fe0efa3666f90296fd5df249a3f56bbe5.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-11-08 20:06:12 +05:30
Jos Collin
2233b68fe0
doc: update cephfs-top.png
Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-11-05 06:18:57 +05:30
Neeraj Pratap Singh
bc360a4503 doc: addition of sort and limit features in doc
Fixes: https://tracker.ceph.com/issues/55121
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-11-03 17:36:49 +05:30
Jos Collin
1e794901b6
Merge pull request #48090 from joscollin/wip-F55197-cephfs-top-scroll
cephfs-top: make cephfs-top display scrollable

Reviewed-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-10-29 07:39:55 +05:30
Venky Shankar
82f46b1fdc Merge PR #43284 into main
* refs/pull/43284/head:
	doc: describe bal_rank_mask configuration
	qa/cephfs: add bal_rank_mask test cases
	mds: add bal_rank_mask option for ceph fs set

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-10-26 11:28:25 +05:30
Jos Collin
19ef3f3c55
doc: Update cephfs-top.png
Fixes: https://tracker.ceph.com/issues/55197
Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-10-26 09:56:21 +05:30
Yongseok Oh
a1a14edd50 doc: describe bal_rank_mask configuration
Signed-off-by: Yongseok Oh <yongseok.oh@linecorp.com>
2022-10-13 05:40:22 +00:00
Venky Shankar
296ba0641a
Merge pull request #48196 from neesingh-rh/wip-human-readable-volume-info
mgr/volumes: Add human-readable flag to volume info command

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
2022-10-11 16:48:19 +05:30
Venky Shankar
ae1f163816
Merge pull request #48319 from gregsfortytwo/wip-57737-cephfs-doc
doc: discuss the standard multi-tenant CephFS security model

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Ken Dreyer <kdreyer@redhat.com>
2022-10-06 10:40:30 +05:30
Greg Farnum
91e7c7de6a doc: discuss the standard multi-tenant CephFS security model
Fixes: https://tracker.ceph.com/issues/57737

Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2022-10-05 15:16:37 +00:00
Venky Shankar
b0021de5fa
Merge pull request #48292 from kotreshhr/doc-symlink-fix
doc: Fix disaster recovery doc

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
2022-10-03 11:14:33 +05:30
Kotresh HR
b6898efcb7 doc: Fix disaster recovery doc
Fixes: https://tracker.ceph.com/issues/57734
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2022-09-30 12:07:26 +05:30
Neeraj Pratap Singh
2c8add629d doc: documenting the --human_readable flag for volume info cmd
Fixes: https://tracker.ceph.com/issues/57620
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-09-29 12:01:02 +05:30
Patrick Donnelly
da19a128ee
doc: update alternate meta pool recovery
Streamline, clarify, and use modern commands (notably: --recover).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-09-20 17:53:50 -04:00
Milind Changire
56178917a6 doc/cephfs: add note about cephfs-mirroring paths
Signed-off-by: Milind Changire <mchangir@redhat.com>
2022-09-20 13:47:09 +05:30
Venky Shankar
5128cf8e18
Merge pull request #46072 from neesingh-rh/fix_54978
cephfs-top: adding filesystem menu option

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
2022-08-24 13:37:46 +05:30
Venky Shankar
d8ba839bcd
Merge pull request #46068 from neesingh-rh/change_perf_stats_o/p_structure
mgr/stats: change in structure of perf_stats o/p

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
2022-08-24 11:13:07 +05:30
Venky Shankar
d1ca282f60
Merge pull request #45949 from neesingh-rh/feature-51434
mgr/volumes: Add volume info command

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
Reviewed-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-08-23 21:33:09 +05:30
Venky Shankar
b3b6a829e5
Merge pull request #44501 from SMIL-Infra/fix-mds-evicted
mon/MDSMonitor: fix standby-replay mds being removed from MDSMap unexpectedly

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2022-08-23 21:30:18 +05:30
Neeraj Pratap Singh
d3552e8107 doc: drop perf stats o/p string.
Dropping the output of this command entirely, as it is
difficult to maintain it in the docs.A minor change in
the command output invalidates the docs.

Fixes: https://tracker.ceph.com/issues/56162
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-08-18 14:31:38 +05:30
Venky Shankar
cd38fe3c85
Merge pull request #47477 from mchangir/doc-clarify-start-time-in-snap-schedule
doc/cephfs: note regarding start time time zone

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
2022-08-17 12:36:10 +05:30
Milind Changire
5d281e9b88 doc/cephfs: note regarding start time time zone
Fixes: https://tracker.ceph.com/issues/56730
Signed-off-by: Milind Changire <mchangir@redhat.com>
2022-08-16 17:51:37 +05:30
Venky Shankar
c4d6729fb8
Merge pull request #44710 from joscollin/wip-F40633-dump-recent-extraordinary-events
mds: dump recent log events for extraordinary events

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Milind Changire <mchangir@redhat.com>
Reviewed-by: Xiubo Li <xiubli@redhat.com>
Reviewed-by: Greg Farnum <gfarnum@redhat.com>
2022-08-12 15:00:49 +05:30
胡玮文
969061e8d5 doc: complete MDS state diagram
Add missing rejoin -> stopped.
MDS can transit from replay-standy to damaged Since 20509bb6c8.

Signed-off-by: 胡玮文 <huww98@outlook.com>
2022-08-12 09:30:37 +08:00
胡玮文
b4cc22a57f mds: remove reference to mds-state-diagram.svg
We no longer generate that file since c783ae10aa

Signed-off-by: 胡玮文 <huww98@outlook.com>
2022-08-12 09:30:36 +08:00
Neeraj Pratap Singh
65a18142fb doc: documenting volume info command.
Fixes: https://tracker.ceph.com/issues/51434
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-08-05 12:46:15 +05:30
Nikhilkumar Shelke
c0c386b197 docs: minor doc fixes of showing in progress clones for a snapshot
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-08-04 19:16:39 +05:30
Neeraj Pratap Singh
1c5fe5188a doc: Add command to check the presence of any subvolumegroup/subvolume
Fixes: https://tracker.ceph.com/issues/55821
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-07-26 16:33:14 +05:30
Neeraj Pratap Singh
e9d43d7838 doc/cephfs-top: adding doc for menu options
Fixes: https://tracker.ceph.com/issues/54978
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-07-19 14:09:01 +05:30
Venky Shankar
8323b6fef5
Merge pull request #46950 from dparmar18/fix_dirfrags_doc
doc/cephfs/dirfrags: clarify the unit of threshold limits

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Rishabh Dave <ridave@redhat.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Milind Changire <mchangir@redhat.com>
2022-07-12 12:26:45 +05:30
Venky Shankar
e9b7e9b4ec
Merge pull request #46951 from dparmar18/fix_caps_doc
doc/cephfs/capabilities: Fixed some typos

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by:  Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Xiubo Li <xiubli@redhat.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
2022-07-08 10:29:40 +05:30
dparmar18
0d094f8f52 doc/cephfs/dirfrags: clarify the unit of threshold limits
Rationale: There are many threshold limits for split and
           merge in this doc that just says like:
           "A directory fragment is eligible for splitting
           when its size exceeds `mds_bal_split_size`
           (default 10000)". Need to clarify what 10000 actually
           means. This applies to all other such entries in this
           doc.

Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
2022-07-07 13:10:57 +05:30
Anthony D'Atri
f6a70c0e8e
Merge pull request #46868 from vshankar/wip-cephfs-mirror-ha-doc
doc: document deploying multiple cephfs-mirror daemons
2022-07-06 07:46:26 -07:00
dparmar18
9f5aba9d87 doc/cephfs/capabilities: Fixed some typos
Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
2022-07-04 16:34:01 +05:30
Nikhilkumar Shelke
a8b819da71 docs: display in-progress clones for a snapshot
If any clone is in pending or in-progress state then
show these clones in 'fs subvolume snapshot info'
command output. This field only exists if clones are
in pending or in progress state.

Fixes: https://tracker.ceph.com/issues/55041
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-07-04 13:31:40 +05:30
Venky Shankar
dfcfe579f3 doc: document deploying multiple cephfs-mirror daemons
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2022-07-04 07:35:25 +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
Jos Collin
b2d82f338a
doc: update troubleshooting and mds-config-ref docs for In-memory Log Dump
* Added 'mds_extraordinary_events_dump_interval' to  mds-config-ref.rst.
* Updated troubleshooting.rst with 'In-memory Log Dump' section.

Fixes: https://tracker.ceph.com/issues/40633
Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-06-22 15:56:49 +05:30
Venky Shankar
df19b8dbc7
Merge pull request #44900 from nmshelke/fix-54111
mon: verify data pool is already not in use by any file system

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by:  Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
Reviewed-by: Neeraj Pratap Singh <neesingh@redhat.com>
Reviewed-by: Milind Changire <mchangir@redhat.com>
Reviewed-by: Xiubo Li <xiubli@redhat.com>
2022-06-20 10:02:41 +05:30
Venky Shankar
c88a5c832e
Merge pull request #46635 from nmshelke/fix-55822
mgr/volumes: remove incorrect 'size' from output of 'snapshot info'

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by:  Anthony D'Atri <anthony.datri@gmail.com>
2022-06-20 09:50:20 +05:30
Nikhilkumar Shelke
86f4cd3dca docs: remove incorrect 'size' from output of 'snapshot info'
The 'size' shown in the output of snapshot info command relies on
rstats which is incorrect snapshot size. It tracks size of the
subvolume from the snapshot has been taken instead of the snapshot
itself. Hence having the 'size' field in the output of 'snapshot info'
doesn't make sense until the rstats is fixed.

Fixes: https://tracker.ceph.com/issues/55822
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-06-12 17:16:49 +05:30
Nikhilkumar Shelke
2b0ffbb36d docs: add details about all options used in 'ceph fs new' command
Fixes: https://tracker.ceph.com/issues/54111
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-06-12 16:25:40 +05:30
Kotresh HR
cd92ea0cb4 doc: Update quota kclient limitation
Fixes: https://tracker.ceph.com/issues/53509
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2022-06-06 12:41:47 +05:30
Kotresh HR
168b912b02 doc: Document subvolumegroup quota commands
Add documentation for subvolume group quota along
with 'subvolumegroup resize' and 'subvolumegroup info'
commands

Fixes: https://tracker.ceph.com/issues/53509
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2022-06-06 12:40:46 +05:30
Nikhilkumar Shelke
59a0cbc14b docs: set, get, list and remove custom metadata for snapshot
Set custom metadata on the snapshot as a key-value pair using
    $ ceph fs subvolume snapshot metadata set <vol_name> <subvol_name> <snap_name> <key_name> <value> [--group_name <subvol_group_name>]
    note: If the key_name already exists then the old value will get replaced by the new value.
    note: The key_name and value should be a string of ASCII characters (as specified in python's string.printable). The key_name is case-insensitive and always stored in lower case.
    note: Custom metadata on a snapshots is not preserved when snapshotting the subvolume, and hence, is also not preserved when cloning the subvolume snapshot.

Get custom metadata set on the snapshot using the metadata key::
    $ ceph fs subvolume snapshot metadata get <vol_name> <subvol_name> <snap_name> <key_name> [--group_name <subvol_group_name>]

List custom metadata (key-value pairs) set on the snapshot using::
    $ ceph fs subvolume snapshot metadata ls <vol_name> <subvol_name> <snap_name> [--group_name <subvol_group_name>]

Remove custom metadata set on the snapshot using the metadata key::
    $ ceph fs subvolume snapshot metadata rm <vol_name> <subvol_name> <snap_name> <key_name> [--group_name <subvol_group_name>] [--force]
    Using the '--force' flag allows the command to succeed that would otherwise fail if the metadata key did not exist.

Fixes: https://tracker.ceph.com/issues/55401
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-05-25 14:59:53 +05:30
Milind Changire
c15b854c0c doc/cephfs: remove subvol support from snap-schedule
Signed-off-by: Milind Changire <mchangir@redhat.com>
2022-05-16 12:24:42 +05:30
Xiubo Li
54126629a6 doc: cephfs: update with atime not supporting explaination
Signed-off-by: Xiubo Li <xiubli@redhat.com>
2022-04-21 14:10:24 +08:00
Venky Shankar
3f13df8388
Merge pull request #45603 from nmshelke/feature-54472
mgr/volumes: set, get, list and remove metadata of subvolume

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2022-04-19 16:52:13 +05:30