Commit Graph

519 Commits

Author SHA1 Message Date
Laura Flores
1734647008
doc/mgr/telemetry: fix formatting problem
There was strange bolding and bullet point placement due to a missing new line in the perf description.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-07-28 10:11:17 -05:00
Josh Durgin
624068d244
Merge pull request #42322 from ljflores/wip-lflores-telemetry-docs
doc/mgr/telemetry: update Telemetry Module docs to include perf channel

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-07-27 17:31:33 -07:00
Sage Weil
9aeefbc666 doc/mgr/rook: update title
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-27 10:47:55 -04:00
Sage Weil
7d3443412c doc/mgr/nfs: reference customizing ingress
Link to the cephadm docs on modifying the service directly.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-27 10:47:55 -04:00
Sage Weil
b5a32d632d doc/mgr/nfs: add section for manual ganesha config; reframe
This documentation is incomplete because this mode of operation is not
tested/validated.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-27 10:47:55 -04:00
Sage Weil
8d9db910f7 doc/mgr/nfs: document ingress in more detail
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:17 -04:00
Sage Weil
0448a8d39d doc/mgr/nfs: typo
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:17 -04:00
Sage Weil
684c6a2dba doc/mgr/nfs: add note about incomplete ingress
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:17 -04:00
Sage Weil
ad5fe4452d mgr/nfs: add --squash option to 'nfs export create rgw ...'
The cephfs variant already has it.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:17 -04:00
Sage Weil
8b96d9c22b doc/mgr/nfs: revisions
- clean up language
- move config hierarchy to the bottom (this is an implementation detail
that is only useful if managing ganesha externally)

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:06 -04:00
Kefu Chai
9e5986c441 doc/mgr/administrator: document mgr_disabled_modules
this option prevent mgr from loading specified modules. which could
be handly when debugging issues with always_on_modules.

and document mgr_standby_modules as well.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-07-20 11:09:09 +08:00
Ernesto Puerta
64dbe17fdb
Merge pull request #42188 from votdev/issue_51408_motd
mgr/dashboard: Add configurable MOTD or wall notification

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Nizamudeen A <nia@redhat.com>
Reviewed-by: Paul Cuzner <pcuzner@redhat.com>
Reviewed-by: Tatjana Dehler <tdehler@suse.com>
Reviewed-by: sebastian-philipp <NOT@FOUND>
Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2021-07-19 19:56:50 +02:00
Sage Weil
62e4ea5ff1 doc/mgr/nfs: fix 'export apply', pool name
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-15 09:47:39 -04:00
Sage Weil
3cfd779e5b doc/cephfs/fs-nfs-exports: document new export apply capabilities
- import list
- import ganesha conf

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-14 16:20:11 -04:00
Sage Weil
01c006c2de Merge PR #42041 into master
* refs/pull/42041/head:
	mgr/restful: ignore min/max_size
	test/crush: drop min/max_size refs
	qa/workunits/mon/pool_ops: remove test for min/max_size check
	qa: scrub a few remaining mentions of ruleset
	qa/standalone/mon/osd-*: fix tests
	PendingReleaseNotes: note min/max_size removal
	mgr/dashboard: remove max/min_size and ruleset
	mon/OSDMonitor: fix calls to CrushTester
	crush: eliminate min_size and max_size
	test/cli/crushtool: reunumber rulesets in test maps
	crushtool: require min/max or num-rep for --test
	crush: remove last traces of 'ruleset'
	test/cli/crushtool: use 'id' instead of 'ruleset' in crush inputs
	crushtool: take --min-rep and --max-rep explicitly
	crush/CrushTester: drop --ruleset
	doc: scrub 'ruleset' from docs
	src/erasure-code: rule, not ruleset
	mon/OSDMonitor: remove check_crush_rule() callers
	mon/OSDMonitor: rule, not ruleset
	crushtool: remove check for overlapped ruels
	crush/CrushWrapper: get_osd_pool_default_crush_replicated_ruleset -> rule
	crush: remove find_rule()
	mon/OSDMonitor: use pool's crush rule directly
	osd/OSDMap: drop checks for ruleset == ruleid
	osd/OSDMap: use pool's crush rule_id directly
	mon/PGMap: use pool's crush_rule directly
	mon/OSDMonitor: remove crush ruleset->rule rewrite

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Avan Thakkar <athakkar@redhat.com>
2021-07-14 14:38:59 -04:00
Volker Theile
f7f163e75c mgr/dashboard: Add configurable MOTD or wall notification
Fixes: https://tracker.ceph.com/issues/51408

Signed-off-by: Volker Theile <vtheile@suse.com>
2021-07-14 10:48:49 +02:00
Laura Flores
f318eed2a4 doc/mgr/telemetry: update Telemetry Module docs to include perf channel
PR #42074 adds a new perf channel to the Telemetry Module. With this commit, the docs will reflect that addition. Within the Telemetry Module docs, I explain the purpose of the new perf channel as well as some use cases of the metrics that will be collected under the channel.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-07-13 20:44:44 +00:00
Varsha Rao
387369373c doc/mgr/nfs: update about RGW exports
This patch just moves the RGW exports created using nfs module to mgr/nfs
document. The RGW requirements will be updated in a different PR.

Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 15:04:54 +05:30
Varsha Rao
5db2b48f14 doc/mgr/nfs: update cephfs export create command about client and squash arguments
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 14:37:39 +05:30
Varsha Rao
ce7fef695b doc/mgr/nfs: update nfs links
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 14:37:39 +05:30
Varsha Rao
29f28563ec doc/mgr/nfs: add missing cluster_id to export info command
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 14:37:39 +05:30
Varsha Rao
c79b797465 doc/cephfs: move nfs doc under mgr docs
Fixes: https://tracker.ceph.com/issues/51428
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 14:37:39 +05:30
Sage Weil
8976fcf476 doc: scrub 'ruleset' from docs
Signed-off-by: Sage Weil <sage@newdream.net>
2021-06-28 18:34:31 -04:00
Patrick Donnelly
319b578b14
Merge PR #40972 into master
* refs/pull/40972/head:
	doc: add missing note about restoring allow_standby_replay
	doc: clarify distributed ephemeral pins new mechanism
	doc: update mds_autoscaler documentation to reflect recent changes

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2021-06-15 14:57:44 -07:00
Patrick Donnelly
f5fa58cb1f
doc: document new .mgr pool
And that pool names beginning with `.` are reserved names.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-06-11 19:35:17 -07:00
Patrick Donnelly
570c7ffc01
doc: update mds_autoscaler documentation to reflect recent changes
Notably, Sage changed how this worked in [1].

[1] 6d8c0e4722

Fixes: https://tracker.ceph.com/issues/51187
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-06-11 19:07:42 -07:00
hoamer
78bb36cb62 doc/mgr/administrator: add a more precise description for creating key
added a more precise description to handle filename when creating key for mgr

Signed-off-by: hoamer <kontakt@sebastian-neugebauer.de>
2021-06-04 16:56:56 +08:00
Kefu Chai
28b08874ae doc/mgr/modules: add a "debugging" section
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-06-02 16:58:58 +08:00
Kefu Chai
dfdcf2cf92 doc/mgr: use confval directive to define options
less repeating this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-28 07:44:44 +08:00
Kefu Chai
b87189f713 doc/mgr/influx: use :confval: directive
less repeating this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-25 08:59:29 +08:00
Kefu Chai
f2750a7912 doc/mgr/prometheus: use confval directive to define options
less repeating this way.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 16:05:04 +08:00
Kefu Chai
bb351842bc doc/rados/configuration/general-config-ref: use describe to define non-options
max_open_files is not generated from yaml files, so define it using
"describe" directive instead.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 22:21:43 +08:00
Kefu Chai
98dc0d4e85 doc/_ext: load options defined by mgr modules
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 20:54:42 +08:00
Kefu Chai
ed79c4f74a doc/mgr/modules: should use Option class for defining options
it is the encouraged way to define options nowadays.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 11:57:30 +08:00
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
Daniel Pivonka
41a1df1b96 doc/cephadm: fix rgw realm and zone flags
Signed-off-by: Daniel Pivonka <dpivonka@redhat.com>
2021-03-26 16:18:28 -04:00
Alfonso Martínez
58253a0002 mgr/dashboard: fix error notification shown when no rgw daemons are running.
- Adapted code to changes introduced in: https://github.com/ceph/ceph/pull/40220
- Improved error handling.
- Increased test coverage.
- Some refactoring.
- Simplified documentation about setting default daemon host and port.

Fixes: https://tracker.ceph.com/issues/49655
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-03-23 11:14:11 +01: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
Kefu Chai
cdbc1a9f22 doc/mgr: fix formatting
a code block should start with "::".

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-12 00:32:45 +08:00
Sebastian Wagner
175ee83909 mgr/orch: replace def add_{type}(...) with generic add_daemon()
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-03-10 15:02:41 +01:00
Sebastian Wagner
b6a2dfc777
Merge pull request #39877 from liewegas/cephadm-rgw-simplification
mgr/cephadm: simplify handling for rgw

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
Reviewed-by: Or Friedmann <ofriedma@redhat.com>
2021-03-10 13:58:37 +01:00
Sage Weil
50bc491373 doc: update docs
Signed-off-by: Sage Weil <sage@newdream.net>
2021-03-09 14:29:39 -05:00
Jonas Jelten
4f98499bfa doc/mgr/crash: explain needed crash upload permissions
Signed-off-by: Jonas Jelten <jj@sft.lol>
2021-03-09 14:12:32 +01:00
Sebastian Wagner
d529f1db82 doc/mgr/orchestrator_modules: adapt to now orch interface
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-03-01 16:50:42 +01:00
Sebastian Wagner
a4aef4a49d doc/cephadm: move host labels to host mgmt
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
1033c46ad7 doc/cephadm: group MDS sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
b3846f6f6a doc/cephadm: group MON sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
0fb2ccb49b doc/cephadm: make custom containers its own chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
818ed4f202 doc/cephadm: group RGW mgmt sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
11fe5ef7cf doc/cephadm: group general service mgmt sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00