Commit Graph

7512 Commits

Author SHA1 Message Date
Patrick Donnelly
60510411be
Merge PR #38160 into master
* refs/pull/38160/head:
	doc/mgr/volumes: Document 'fs subvolume authorized_list' cli
	qa: Add tests for list auth-ids of a subvolume
	mgr/volumes: Update the 'volumes' key to 'subvolumes' in auth metadata file
	mgr/volumes: Optionally authorize existing auth-ids
	mgr/volumes: Preserve existing caps while authorize/deauthorize auth-id
	mgr/volumes: Disallow authorize existing auth_id
	mgr/volumes: Add subvolume authorized_list command
	mgr/volumes: Add tenant_id option to subvolume authorize
	mgr/volumes: Persist auth and subvolume metadata

Reviewed-by: Ramana Raja <rraja@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-01-15 11:53:06 -08:00
Mykola Golub
aab9de639f
Merge pull request #38862 from dillaman/wip-librbd-migration-qcow
librbd/migration: basic QCOW format handler

Reviewed-by: Mykola Golub <mgolub@suse.com>
2021-01-15 20:58:30 +02:00
Kefu Chai
014e83728d
Merge pull request #38722 from tchaikov/wip-mgr-args-ann
mgr: use annotations for argdesc

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-16 01:51:27 +08:00
Kefu Chai
ae7faa9db5 doc/mgr: document CLICommand and friends
the annotation and docstring are critical after we use them for
describing the command.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-15 23:11:58 +08:00
Kefu Chai
620e318b2e doc/_ext: use iterator of tuple to build dict
As suggested by Ernesto Puerta <epuertat@redhat.com>

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-15 17:25:27 +08:00
Kefu Chai
0fb8a988df doc/_ext: PEP8 compliance
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-15 17:25:27 +08:00
Kefu Chai
d25ed64449 doc/_ext: do not mock ceph_argparse
this module is used for convert argspec to argdesc by
CLICommand.load_func_metadata()

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-15 17:25:27 +08:00
Kefu Chai
925c4d8d04 doc/_ext: add python_path option to ceph-mgr-commands
so we can add more python paths in addition to the one used for finding
mgr modules.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-15 17:25:27 +08:00
Kefu Chai
fbbe4474ac doc/_ext: parse prefix and args for command signature
unlike the commands defined by C++, the commands defined by python
now uses "prefix" and "args" properties of elements in COMMAND class
attribute to define their command and arguments. the "cmd" property is
still available for the ceph CLI.

but the ceph_command sphinx extension should now use "prefix" and "args"
for printing out the usage of commands implemented using python. in
this change, the extension is updated to read "prefix" and "args"
properties of command defined by python modules.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-15 17:25:27 +08:00
Kotresh HR
9f9f8adc47 doc/mgr/volumes: Document 'fs subvolume authorized_list' cli
Fixes: https://tracker.ceph.com/issues/44931
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2021-01-15 10:10:43 +05:30
Patrick Donnelly
b4935c06d6
Merge PR #38708 into master
* refs/pull/38708/head:
	doc: update multiple mds scrub docs

Reviewed-by: Jeff Layton <jlayton@redhat.com>
2021-01-14 09:22:40 -08:00
Jason Dillaman
bd8db295ea librbd/migration: basic QCOW2 format handler
The initial implementation does not support backing files, compression,
snapshots, (deprecated) encryption, external data files, nor L2 subcluster
allocation. The former three features will be added in a future commit.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2021-01-14 09:35:35 -05:00
Jason Dillaman
83aa1a9e73 librbd/migration: basic QCOW v1 format handler
The initial implementation does not support backing files, compression, nor
(deprecated) encryption. The former two features will be added in a future commit.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2021-01-14 09:35:34 -05:00
Jason Dillaman
45addcbd2e
Merge pull request #38838 from orozery/rbd-encryption-cli
librbd: rbd encryption cli

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2021-01-13 19:49:23 -05:00
Kefu Chai
ce0eafccf7
Merge pull request #38879 from Rethan/remove-osd-heartbeat-option
doc/rados: remove unused osd heartbeat option

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-01-14 01:54:01 +08:00
Patrick Donnelly
72c3b5e6a3
Merge PR #37876 into master
* refs/pull/37876/head:
	systemd: cephfs-mirror systemd unit files
	doc, man: man page for `cephfs-mirror` tool
	doc: document mirror daemon internals
	cephfs-mirror: switch to using PeerReplayer class
	cephfs-mirror: cancel ongoing snapshot syncs on dir removal
	cephfs-mirror: display peer snapshot sync stats
	cephfs-mirror: carve out (and implement) mirroring snapshots to peers
	cephfs-mirror: remove `cephfs_mirror_directory_choose_policy` option
	cephfs-mirror: include helper routines to separate source
	cephfs-mirror: remove peer only when peer is tracked
	cephfs-mirror: typedef ceph_mount_info as MountRef shared pointer
	cephfs-mirror: enclose json dump in object section
	cephfs-mirror: note current peer set
	cephfs-mirror: fix option typo and document certain options
	cephfs-mirror: remove unnecessary command line options
	cephfs-mirror: default log level 0/5

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-01-13 08:26:05 -08:00
Or Ozeri
b2c3d5d4b2 librbd: add encryption cli
This commit adds rbd encryption cli (encryption format and nbd map)

Signed-off-by: Or Ozeri <oro@il.ibm.com>
2021-01-13 17:57:17 +02:00
haoyixing
82755b5809 doc/rados: remove unused osd heartbeat option
Since commit a5f9ca, option osd_mon_ack_timeout was removed, change
doc accordingly.

Signed-off-by: haoyixing <haoyixing@kuaishou.com>
2021-01-13 18:20:39 +08:00
Venky Shankar
42233bb5df doc, man: man page for cephfs-mirror tool
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-01-12 05:57:32 -05:00
Venky Shankar
439c18c490 doc: document mirror daemon internals
... fix some typos and reorganize sections to be reader
friendly. Also include a requirements section.

Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-01-12 05:56:52 -05:00
Jeff Layton
dac04fc19f doc: document ms_mode option in the mount.ceph manpage
Fixes: https://tracker.ceph.com/issues/48838
Signed-off-by: Jeff Layton <jlayton@redhat.com>
2021-01-11 15:42:14 -05:00
Venky Shankar
4dd3f42552 doc, man: man page for cephfs-top utility
Fixes: http://tracker.ceph.com/issues/48602
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-01-11 06:15:53 -05:00
Venky Shankar
c513422ec5 doc: document cephfs-top utility
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-01-11 06:15:53 -05:00
Sebastian Wagner
8d80817c74
Merge pull request #38615 from adk3798/haproxy-stuff
mgr/cephadm: HA for RGW endpoints

Reviewed-by: Daniel-Pivonka <dpivonka@redhat.com>
Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-11 12:02:25 +01:00
Kefu Chai
b5fd5b505f
Merge pull request #38753 from Rethan/style-ceph-df-output
mon/PGMap: align to same side when output ceph df / ceph df detail

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-01-09 12:06:47 +08:00
Patrick Donnelly
d03064d930
Merge PR #38642 into master
* refs/pull/38642/head:
	rpm/deb/cmake: install mount.fuse.ceph man page

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-01-08 15:12:42 -08:00
Daniel-Pivonka
a398fc239f cephadm: HA for RGW endpoints
Cephadm deploying keepalived and HAproxy for providing High availability for RGW endpoints

Fixes: https://tracker.ceph.com/issues/45116

Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
Signed-off-by: Adam King <adking@redhat.com>
Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-01-08 17:00:51 -05:00
Jason Dillaman
6b6abfac56
Merge pull request #38725 from CongMinYin/immutable-obejct-cache-doc
doc/rbd: Immutable object cache doc

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2021-01-08 09:24:21 -05:00
Kefu Chai
fdb26d2c10
Merge pull request #38807 from tchaikov/wip-mon-cmd-doc
doc: build mon_command_api.rst using a homebrew extension

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-08 20:35:28 +08:00
Kefu Chai
ef281f6b55 doc/_ext: accept params separated with ", "
"mon enable_stretch_mode" command's arg descriptors are delimited with
", ", so we should ignore empty kv when split the params with ",".

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-08 11:35:42 +08:00
Kefu Chai
202b805aaf doc: build mon_command_api.rst using a homebrew extension
so we can build the command doc using ReadTheDoc infra, without adding
the generated rst file to the source repo.

before this change, all the commands are ordered alphabetically. after
this change, command docs are generated by two directives, and are
ordered separately. we could restructure the directives and merge them.

but let's leave it for a future change if this is important.

for more details on writing sphinx directives, see
https://www.sphinx-doc.org/en/master/extdev/markupapi.html and
https://docutils.sourceforge.io/docs/howto/rst-directives.html

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-08 11:35:42 +08:00
Sebastian Wagner
eed40cf636 doc/cephadm: /etc/ceph is created automaticlly now
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-07 12:52:19 +01:00
Sebastian Wagner
28cc065271 doc/cephadm: CephFS: Encourage users to call ceph fs volume create
Manually deploying MDS daemons is an advanced topic.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-07 12:52:19 +01:00
Sebastian Wagner
77677f5a97 doc/cephadm: update stability notes
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-07 12:52:19 +01:00
Sebastian Wagner
3aeda544a1 doc/cephadm: Rm doc/dev/cephadm from user docs
We should not link the dev guide form the user documentation. The user docs are already convoluted and hard to follow. Adding the dev guide is not helpful.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-07 12:52:12 +01:00
Sebastian Wagner
4871269f34
Merge pull request #38784 from sebastian-philipp/resurect-doc-dev-cephadm
doc/dev: resurrect hidden dev/cephadm.rst

Reviewed-by: Varsha Rao <varao@redhat.com>
2021-01-07 11:46:12 +01:00
Patrick Donnelly
7b39daab79
Merge PR #38587 into master
* refs/pull/38587/head:
	doc: add explanatory note about cache trim rate setting

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-01-06 13:34:38 -08:00
Patrick Donnelly
03e7f9d827
doc: update multiple mds scrub docs
Fixes: https://tracker.ceph.com/issues/44192
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-01-06 13:32:10 -08:00
Patrick Donnelly
06fff9aa82
Merge PR #38769 into master
* refs/pull/38769/head:
	doc/cephfs: add data pool-MDS instructions link

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Rishabh Dave <ridave@redhat.com>
2021-01-06 06:50:24 -08:00
Sebastian Wagner
6b3c46f508 doc/dev: resurrect hidden dev/cephadm.rst
some time ago, a cephadm folder was added that did hide the
old dev documentation page.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-06 14:13:11 +01:00
Zac Dover
725d294218 doc/cephfs: add data pool-MDS instructions link
- This commit adds a link to the "Create a Ceph
File System" page. The link that it adds is to the
"Adding a data pool to the MDS" subsection of the
file layouts page.
- s/mds/file system/

Fixes: https://tracker.ceph.com/issues/48531
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-01-06 15:52:24 +10:00
Yin Congmin
2093c88229 tools: update immutable object cache water mark
Signed-off-by: Yin Congmin <congmin.yin@intel.com>
2021-01-06 09:18:48 +08:00
Yin Congmin
b4b7161a12 doc/rbd: add the configuration description of immutable object cache throttle
Signed-off-by: Yin Congmin <congmin.yin@intel.com>
2021-01-06 08:45:45 +08:00
Patrick Donnelly
edd6d3ddcd
Merge PR #38742 into master
* refs/pull/38742/head:
	doc/cephfs/nfs: Add more details about path and pseudo path
	doc/cephfs/nfs: Add note about how to fetch port details with rook
	doc/cephfs/nfs: Add warning note about management of dashboard created exports

Reviewed-by: Rishabh Dave <ridave@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Jeff Layton <jlayton@redhat.com>
2021-01-05 08:38:41 -08:00
Jason Dillaman
6b40dddb27
Merge pull request #38520 from lixiaoy1/wip-doc-pwl
doc: add RBD persistent write-back cache

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2021-01-05 09:12:20 -05:00
lixiaoy1
948e1e82e2 doc: add RBD persistent write-back cache
Signed-off-by: Li, Xiaoyan <xiaoyan.li@intel.com>
2021-01-05 09:37:30 -05:00
Varsha Rao
948ea79fb0 doc/cephfs/nfs: Add more details about path and pseudo path
Fixes: https://tracker.ceph.com/issues/48731
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-01-05 18:04:34 +05:30
Varsha Rao
e626e54b72 doc/cephfs/nfs: Add note about how to fetch port details with rook
Fixes: https://tracker.ceph.com/issues/48731
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-01-05 18:04:34 +05:30
Varsha Rao
8ccb57069a doc/cephfs/nfs: Add warning note about management of dashboard created exports
Fixes: https://tracker.ceph.com/issues/48731
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-01-05 18:04:34 +05:30
zdover23
94e7c6f95a
Merge pull request #38745 from zdover23/wip-doc-jan-2021-dev-guide-basic-workflow-reorg
doc/dev: restructure basic-workflow.rst

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-01-05 18:34:19 +10:00