Commit Graph

7975 Commits

Author SHA1 Message Date
Alfonso Martínez
335a91d20d mgr/dashboard: update documentation about creating NFS export.
- You learn first that orchestrator-managed clusters are detected automatically (therefore the documentation that follows is exclusively for user-defined clusters).
- Include nfs-ganesha in the security scope list.

Fixes: https://tracker.ceph.com/issues/50440
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-04-22 14:10:25 +02:00
Ilya Dryomov
477b705fe7
Merge pull request #40928 from idryomov/wip-gid-reclaim-notes
doc: 14.2.20, 15.2.11 and 16.2.1 releases and notes (CVE-2021-20288)

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Nathan Cutler <ncutler@suse.com>
2021-04-20 10:46:29 +02:00
Ilya Dryomov
a2b1c69981 doc/releases/index: update for 14.2.20, 15.2.11 and 16.2.1
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-20 10:05:28 +02:00
Kefu Chai
0be78da368
Merge pull request #40877 from mgfritch/doc-rgw-python3-print
doc/rgw: update to python3 print syntax

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-04-20 15:02:49 +08:00
Kefu Chai
2041207674 doc/man/8/ceph-authtool: fix the indent of option
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 22:09:52 +08:00
Kefu Chai
8e0158a047 doc/rados/configuration/mon-config-ref: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 22:03:45 +08:00
Kefu Chai
e5722a46e1 doc/rados/configuration/auth-config-ref: drop section of keyrings
as per Sage, the caps are out of date (should be based on profiles) and
the keyring locations aren't useful information

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 21:45:07 +08:00
Kefu Chai
366a1263bb
Merge pull request #40897 from tchaikov/wip-doc-more-conf-vals
doc/rados/configuration: use confval directive to define options.

Reviewed-by: Reviewed-by: Sage Weil <sage@redhat.com>
2021-04-19 21:43:43 +08:00
Ilya Dryomov
bd87bf3e30
Merge pull request #40905 from idryomov/wip-rbd-kms-config-map-doc
doc/rbd/rbd-kubernetes: update for recent ceph-csi versions

Reviewed-by: Madhu Rajanna <madhupr007@gmail.com>
Reviewed-by: Sage Weil <sage@redhat.com>
2021-04-19 15:40:21 +02:00
zdover23
df10995f7a
Merge pull request #40378 from zdover23/wip-doc-cephadm-osd-declarative-state-rewrite-2021-Mar-25
doc/cephadm: rewrite "delcarative state" in osd.rst

Reviewed-by: Sage Weil <sweil@redhat.com>
2021-04-19 23:03:21 +10:00
Matt Benjamin
b040f25b71
Merge pull request #37730 from thotz/rgwkmsvaultsslsupport
rgw: extending existing ssl support for vault KMS
2021-04-19 07:37:29 -04:00
Ilya Dryomov
6f77102706 doc/rbd/rbd-kubernetes: expose volume expansion functionality
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-19 11:52:23 +02:00
Ilya Dryomov
d0d4100040 doc/rbd/rbd-kubernetes: imageFeatures is required
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-19 11:52:23 +02:00
Ilya Dryomov
2656448617 doc/rbd/rbd-kubernetes: mention KMS config map
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-19 11:52:23 +02:00
Kefu Chai
cdd059b3e4 doc/rados/configuration/mon-config-ref: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:35:31 +08:00
Kefu Chai
536f096055 doc/rados/configuration/msgr2: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:46 +08:00
Kefu Chai
3a62ba9463 doc/rados/configuration/auth-config-ref: use "describe" to define default keyrings
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:46 +08:00
Kefu Chai
fffa02706b doc/_ext: use iec_size() instead of filesizeformat()
to format size options in the same format supported by our C++
strict_iec_cast() parser. so they are more consistent from user's
perspective.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:46 +08:00
Kefu Chai
3767e0cb16 doc/rados/configuration: merge ms-ref into network-conf-ref
the latter provides more context, and "messenger" is how the networking
infra is implemented.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:46 +08:00
Kefu Chai
1ecd8e7f97 doc/rados/configuration/ceph-conf: use "describe" to define option types
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:46 +08:00
Kefu Chai
a67451d05d doc/rados/configuration: fix formatting of code block
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:46 +08:00
Kefu Chai
76fb3d147d doc: use "confsec" role for configure section
and rename confval_section to confsec for shorter name

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:45 +08:00
Kefu Chai
66a86596a3 doc/rados/configuration/ceph-conf: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:45 +08:00
Kefu Chai
02a15a81d8 doc: use ":confval:" role to reference options defined using confval
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:45 +08:00
Kefu Chai
a37f5a5eea doc/rados/configuration/osd-config-ref: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:45 +08:00
Kefu Chai
d1c6182fa2 doc/_ext: render see_also field
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:45 +08:00
Kefu Chai
1128f4e22f doc/_ext: render more fields in an option
* print "enum_value" as a list
* print "note" and "warning"

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:45 +08:00
Kefu Chai
23c7081dab doc/rados/configuration/mclock-config-ref: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:43 +08:00
Kefu Chai
20676f00c9 doc/rados/configuration/pool-pg-config-ref: use confval directive
for defining options.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:11 +08:00
Kefu Chai
65925d78c6 doc/rados/configuration/bluestore-config-ref: use confval directive
for defining options.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-19 17:08:07 +08:00
Kefu Chai
d9631287dc
Merge pull request #40890 from tchaikov/wip-yamlize-options-doc
common/options,doc: extract formatted desc into .yaml.in

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-04-17 10:43:58 +08:00
Jiffin Tony Thottan
c2af1cdc13 doc/radosgw/vault: add documentation for ssl authentication
Now RGW server can use custom ssl certs to authenticate with vault
server, adding steps for the same

Signed-off-by: Jiffin Tony Thottan <jthottan@redhat.com>
2021-04-16 23:07:59 +05:30
Kefu Chai
f86cc95ecf doc/rados/configuration/mon-osd-interaction: use confval directive to define options
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-17 00:02:45 +08:00
Kefu Chai
4da18aaf57 common/options,doc: extract formatted desc into .yaml.in
* add a field named "fmt_desc", which is the description formatted using
  reStructuredText. it is preserved as it is if it's different from the
  desc or long_desc of an option. we can consolidate it with long_desc
  in future, and use pretty printer which has minimal support for
  reStructuredText for printing the formatted descriptions for a better
  user experience of command line. but at this moment, fmt_desc has
  only one consumer: the "ceph_confval" sphinx extension which extracts
  and translate the options yaml file to reStructuredText, which is in
  turn rendered by sphinx.
* remove unused options from the doc
  - journal_queue_max_ops
  - journal_queue_max_bytes

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-17 00:02:45 +08:00
Sage Weil
b0f1146a6c Merge PR #40712 into master
* refs/pull/40712/head:
	doc/cephadm: wrong command for single daemon events

Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Juan Miguel Olmo <jolmomar@redhat.com>
2021-04-16 11:31:24 -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
Kefu Chai
bfb4d7720a doc: use "describe" directive for meta variables
they are not options, so we should not use confval for defining them.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-16 20:27:24 +08:00
Kefu Chai
bd9b597242 doc: add "confval_section" directive
instead of reusing "confval" directive, define a new directive just
for configration sections

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-16 20:27:24 +08:00
Patrick Donnelly
bd7db0c878
Merge PR #40539 into master
* refs/pull/40539/head:
	cephfs-top: set the cursor to be invisible
	cephfs-top: self-adapt the display according the window size
	cephfs-top: use the default window object from curses.wrapper()
	cephfs-top: improve the output

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
2021-04-15 21:06:31 -07:00
Patrick Donnelly
3a30edf3de
Merge PR #39660 into master
* refs/pull/39660/head:
	qa: Update the mdsmap schema in mgr/dashboard/test_health.py
	doc: add lsflags command to Administrative Commands document
	qa: test fs lsflags command
	mon: add command to print fs flags
	mds: print each flag value

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2021-04-15 21:03:19 -07:00
Kefu Chai
b3e9c97ff4
Merge pull request #40876 from tchaikov/wip-top-bar-spacing
doc/_theme: increasing the padding in navigation bar

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-04-16 08:25:13 +08:00
Michael Fritch
e1023aa65e
doc/rgw: update to python3 print syntax
python3 requires parens for a `print` statement

Signed-off-by: Michael Fritch <mfritch@suse.com>
2021-04-15 15:38:16 -06:00
Kefu Chai
6711b735f1 doc/_theme: increasing the padding in navigation bar
otherwise the "home-icon" and the right most "Edit on GitHub" are displayed
right next to the left and right borders of the top-bar.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-16 00:57:28 +08:00
Kefu Chai
4394f75fbd
Merge pull request #40847 from tchaikov/wip-doc-build
admin/build-doc: use htmldir builder for livehtml

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-04-15 23:06:15 +08:00
Sage Weil
e65123b479 doc/releases: add 14.2.20, 15.2.11 and 16.2.1 releases and notes
Signed-off-by: Sage Weil <sage@newdream.net>
2021-04-15 14:03:30 +02:00
Sage Weil
cf12cc790b doc/security: document global_id reclaim CVE
Signed-off-by: Sage Weil <sage@newdream.net>
2021-04-15 14:03:30 +02:00
Ilya Dryomov
2e445fc888 doc/releases/releases: add 15.2.10 release
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-15 13:22:22 +02:00
David Galloway
aa4a53a3c1 doc/releases/octopus.rst: 15.2.10 Release Notes
Signed-off-by: David Galloway <dgallowa@redhat.com>
2021-04-15 12:57:44 +02:00
Xiubo Li
0b4807aefb cephfs-top: improve the output
When adding more metrics the top line will be too long and maybe
wrapped with serval lines, which will make it hard to read.

Signed-off-by: Xiubo Li <xiubli@redhat.com>
2021-04-15 16:27:34 +08: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