Commit Graph

564 Commits

Author SHA1 Message Date
Patrick Donnelly
5180c39db5
doc: add alternate_name cephfs feature to table
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-05-14 12:22:20 -07:00
Kefu Chai
1c04ce6f3a doc/man: build and install cephfs-shell manpage
otherwise the manpage of cephfs-shell is not built and installed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-05 14:41:50 +08:00
Kefu Chai
6a48787c4d doc/man/8/cephfs-shell: reformat options
* format global options using option directive
* fix the header, so man/conf.py is able to parse
  the description
* define "Synopsis" section to be consistent with other manpages.
* drop reference to glossary using "term" as manapge does not have
  reference to glossary entries.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-05 09:27:53 +08:00
Patrick Donnelly
52faaf848e
Revert "Merge PR #41134 into master"
This reverts commit 93bca2d0e9, reversing
changes made to 7e70b15c43.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-05-04 14:46:47 -07:00
Kefu Chai
5191008aa4 doc/man: build and install cephfs-shell manpage
otherwise the manpage of cephfs-shell is not built and installed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-04 15:11:22 +08:00
Kefu Chai
0fa568b54a doc/man/8/cephfs-shell: reformat options
* format global options using option directive
* fix the header, so man/conf.py is able to parse
  the description
* define "Synopsis" section to be consistent with other manpages.
* drop reference to glossary using "term" as manapge does not have
  reference to glossary entries.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-04 15:11:22 +08:00
Kefu Chai
79e8c4f9e8 doc/cephfs: render options using confval directive
less repeating, better maintainability this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-02 17:48:31 +08:00
Kefu Chai
92ca8bbe38 doc/cephfs/mds-config-ref: remove duplicated confval
this change addresses the warning of:

/home/jenkins-build/build/workspace/ceph-pr-docs/doc/cephfs/mds-config-ref.rst:2: WARNING: duplicate confval_option description of mds_cache_memory_limit, other instance in cephfs/cache-configuration
/home/jenkins-build/build/workspace/ceph-pr-docs/doc/cephfs/mds-config-ref.rst:2: WARNING: duplicate confval_option description of mds_cache_reservation, other instance in cephfs/cache-configuration

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-01 23:05:37 +08:00
Patrick Donnelly
b9c7d52987
Merge PR #41012 into master
* refs/pull/41012/head:
	doc/cephfs/cache-config: use config item macros

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-04-30 21:03:17 -07:00
Varsha Rao
6ff3c1da87 doc/cephfs/nfs: add section about ganesha logs
Fixes: https://tracker.ceph.com/issues/50008
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-04-30 11:16:48 +05:30
Varsha Rao
ff11cdb4bc doc/cephfs/nfs: Replace volume/nfs with nfs
Recently, nfs related code was moved out of volumes plugin[1]. So using the
name volume/nfs for the interface is not appropriate.

[1] https://github.com/ceph/ceph/pull/40526

Signed-off-by: Varsha Rao <varao@redhat.com>
2021-04-30 11:09:23 +05:30
Varsha Rao
923e689e08 doc/cephfs/nfs: add note about export management with volume/nfs interface only
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-04-30 11:09:23 +05:30
Kefu Chai
9e3aa76f4a
Merge pull request #41040 from tchaikov/wip-doc-mds-conf
doc/cephfs/mds-config-ref: render options using confval directive

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-04-30 00:33:41 +08:00
Kefu Chai
f680f5c5e8 doc/cephfs/mds-config-ref: render options using confval directive
less repeating, better maintanability this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-27 17:36:00 +08:00
Venky Shankar
8343471a0f
Merge pull request #40933 from vshankar/wip-50266
cephfs-mirror: sanitize `daemons status` JSON

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2021-04-27 12:22:37 +05:30
Dan van der Ster
6f04c4d6c3 doc/cephfs/cache-config: use config item macros
Correct the defaults following 8df2388b9f.

Related-to: https://tracker.ceph.com/issues/48403
Signed-off-by: Dan van der Ster <daniel.vanderster@cern.ch>
2021-04-26 16:27:01 +02:00
Kefu Chai
19ccf3655f doc/cephfs/mds-config-ref: render options using confval directive
less repeating, better maintanability this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-26 21:01:44 +08:00
Patrick Donnelly
a4d3377ff4
Merge PR #40526 into master
* refs/pull/40526/head:
	spec: add nfs to spec file
	mgr/nfs: Don't enable nfs module by default
	mgr/nfs: check for invalid chars in cluster id
	mgr/nfs: Use CLICommand wrapper
	mgr/nfs: reorg nfs files
	mgr/nfs: Check if transport or protocol are list instance
	mgr/nfs: reorg cluster class and common helper methods
	mgr/nfs: move common export helper methods to ExportMgr class
	mgr/nfs: move validate methods into new ValidateExport class
	mgr/nfs: add custom exception module
	mgr/nfs: create new module for export utils
	mgr/nfs: rename fs dir to export
	mgr/volumes/nfs: Move nfs code out of volumes plugin

Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2021-04-22 09:20:59 -07:00
Kefu Chai
f3344192e3
Merge pull request #40580 from anthonyeleven/anthonyeleven/clean-up-cephfs-standby
doc/cephfs: refine cephfs/standby

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-04-22 14:53:09 +08:00
Varsha Rao
2a99da961a mgr/nfs: Don't enable nfs module by default
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-04-22 11:38:30 +05:30
Venky Shankar
3c600928c2 doc: adjust daemon status section with changed JSON
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-04-20 21:18:54 -04:00
Sage Weil
3a7c72a9ed Merge PR #40411 into master
* refs/pull/40411/head:
	doc: add note about removal of the `cephfs` nfs cluster type
	mgr/volumes/nfs: drop `type` param during cluster create

Reviewed-by: Sage Weil <sage@redhat.com>
Reviewed-by: Varsha Rao <varao@redhat.com>
2021-04-16 10:48:04 -04:00
Michael Fritch
e9b2c38354
mgr/volumes/nfs: drop type param during cluster create
PR #37600 introduced support for both `cephfs` and `rgw` exports
to be configured using a single nfs-ganesha cluster

Fixes: https://tracker.ceph.com/issues/50369
Signed-off-by: Michael Fritch <mfritch@suse.com>
2021-04-14 18:21:36 -06:00
Anthony D'Atri
9587fb3b59 doc: refine cephfs/standby 2021-04-09 12:37:07 -07:00
Jos Collin
26b7e5855b
doc: add lsflags command to Administrative Commands document
Fixes: https://tracker.ceph.com/issues/48682
Signed-off-by: Jos Collin <jcollin@redhat.com>
2021-04-08 11:09:18 +05:30
Patrick Donnelly
61b014c4a6
Merge PR #39939 into master
* refs/pull/39939/head:
	cephfs: ceph-dokan - properly log the mounted root
	cephfs: Update ceph-dokan "--removable" flag
	cephfs: document using multiple fs on Windows
	cephfs: provide additional volume details on Windows
	cephfs: add ceph-dokan unmap command

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-04-06 10:46:23 -07:00
Varsha Rao
08f1d906c2 doc/cephfs/nfs: add user id, fs name and key to FSAL block
Fixes: https://tracker.ceph.com/issues/50161
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-04-06 15:52:04 +05:30
Venky Shankar
c22d239fcc doc: document CephFS Snapshot Mirroring
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-04-01 19:09:09 +05:30
Lucian Petrut
5a1be89c5a cephfs: document using multiple fs on Windows
This change updates the ceph-dokan documentation, showing how
a non-default Ceph filesystem can be mounted.

Fixes: https://tracker.ceph.com/issues/49662
Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2021-04-01 06:15:50 +00:00
Lucian Petrut
cd9b098afd cephfs: add ceph-dokan unmap command
At the moment, Windows CephFS mounts can only be removed by
terminating the daemon (e.g. sending CTRL-C) or through the
Windows mount manager if the "-o -m" parameters were passed
when the mapping was created.

This change adds the "ceph-dokan unmap" command, which takes
the mountpoint as input.

Fixes: https://tracker.ceph.com/issues/49662
Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2021-04-01 06:14:49 +00:00
Patrick Donnelly
da4dcd673b doc: add links for pacific cephfs features
Note: cephfs-mirror does not yet have user-facing documentation to link
to.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-03-31 11:44:11 -04:00
Rachana Patel
abd4ae9f9b cephfs-top: allow configurable stats refresh interval
Signed-off-by: Rachana Patel <racpatel@redhat.com>
2021-03-24 06:33:47 +00:00
Patrick Donnelly
5b4a7668f1
Merge PR #40305 into master
* refs/pull/40305/head:
	doc/cephfs/nfs: Add note about cephadm NFS-Ganesha daemon port

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Jeff Layton <jlayton@redhat.com>
2021-03-23 18:45:48 -07:00
Patrick Donnelly
5000b33180
Merge PR #40145 into master
* refs/pull/40145/head:
	doc: add note about disabling standby-replay during upgrades
	qa: add test for standby-replay disable
	mon: fail standby-replay daemons when flag is turned off

Reviewed-by: Sidharth Anupkrishnan <sanupkri@redhat.com>
2021-03-22 20:03:02 -07:00
Varsha Rao
fec8bbf5cd doc/cephfs/nfs: Add note about cephadm NFS-Ganesha daemon port
Fixes: https://tracker.ceph.com/issues/49921
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-03-22 17:25:59 +05:30
Kefu Chai
f5a8f34116 doc/cephfs: fix broken links
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-22 01:41:53 +08: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
Dan van der Ster
8d5608f695 doc: max_maps -> max_caps
Signed-off-by: Dan van der Ster <daniel.vanderster@cern.ch>
2021-03-18 08:05:49 +01:00
Patrick Donnelly
822789547e
Merge PR #40058 into master
* refs/pull/40058/head:
	doc: mds cap acquisition readdir throttle documentation

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-03-17 19:41:09 -07:00
Patrick Donnelly
29b4c0d9d5
doc: add note about disabling standby-replay during upgrades
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-03-16 08:35:17 -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
Kotresh HR
92c51c8308 doc: mds cap acquisition readdir throttle documentation
Fixes: https://tracker.ceph.com/issues/49763
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2021-03-12 23:12:01 +05:30
Patrick Donnelly
b7f8c681d2
Merge PR #39671 into master
* refs/pull/39671/head:
	doc: snap-schedule documentation

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
2021-03-11 09:23:20 -08:00
Jan Fajerski
96556f1fbc doc: snap-schedule documentation
Fixes: https://tracker.ceph.com/issues/48017

Signed-off-by: Jan Fajerski <jfajerski@suse.com>
2021-03-10 18:24:03 +01:00
Patrick Donnelly
4b506bbe4e
Merge PR #38913 into master
* refs/pull/38913/head:
	qa/tasks/cephfs/nfs: Add tests for updating fs exports
	mgr/volumes/nfs: Handle rook restart error
	doc/cephfs/nfs: Add about update export interface
	mgr/volumes/nfs: Add command to update cephfs exports
	pybind/volumes/nfs: set mds caps according to user specified access type
	mgr/volumes/module: Remove unused json module

Reviewed-by: Jeff Layton <jlayton@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-03-10 07:01:27 -08:00
Lucian Petrut
eaa415f169 doc: add ceph-dokan documentation
This change documents ceph-dokan, describing the prerequisites,
usage and limitations.

Some of this was mentioned in README.windows.rst but is now being
moved to the Ceph doc pages.

Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2021-03-05 13:15:45 +00:00
Varsha Rao
05d1fb0751 doc/cephfs/nfs: Add about update export interface
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-03-04 15:18:07 +05:30
Patrick Donnelly
4a00f0a716
Merge PR #38763 into master
* refs/pull/38763/head:
	doc/cephfs: improve fs-nfs-exports.rst
	doc/cephfs: improve nfs.rst

Reviewed-by: Varsha Rao <varao@redhat.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
2021-02-19 07:54:32 -08:00
Rishabh Dave
6ba55be889 doc/cephfs: improve fs-nfs-exports.rst
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2021-02-17 19:09:11 +05:30
Rishabh Dave
c887abc64a doc/cephfs: improve nfs.rst
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2021-02-08 19:00:04 +05:30