Commit Graph

26 Commits

Author SHA1 Message Date
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
Pere Diaz Bou
69aa388d90 doc/mgr: Add cache documentation
Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-01-05 10:11:58 +01:00
Dimitri Papadopoulos
7677651618
doc,man: typos found by codespell
Signed-off-by: Dimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
2021-12-15 12:04:36 +01:00
Laura Flores
46236139f9 mon: remove detail option for mgr module ls command
Signed-off-by: Laura Flores <lflores@redhat.com>
2021-10-15 16:20:16 +00:00
Laura Flores
2a10be5347 mon: simplify 'mgr module ls' output
Fixes: https://tracker.ceph.com/issues/45322
Signed-off-by: Laura Flores <lflores@redhat.com>
2021-10-04 23:36:57 +00: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
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
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
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
Anthony D'Atri
21d68cf137 doc: standardize config option names to use interstitial underscores
Ceph config option names may use spaces, underscores, or by one reference hyphens
as interstitial separators. Most usage within the doc tree uses underscores,
though example conf files and especially structured lists of options mostly
use spaces. Mostly. Underscores help differentiate the config names from
surrounding text, and moreover facilitate scripting, grep, awk, etc and match
their form in src/common/options.cc.

This PR conforms these occurrences of option names to use interstitial underscores instead of spaces.

Fixes: https://tracker.ceph.com/issues/48301
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-12-15 13:55:38 -08:00
Sage Weil
8128045511 do not use 'ceph tell mgr'
This is now for a daemon/asok command, not a module command.

Signed-off-by: Sage Weil <sage@redhat.com>
2019-10-01 16:30:53 -05:00
John Spray
414d94ae42 doc/dashboard: don't advise mgr_initial_modules
This setting tends to confuse people, as it's only respected
on the very first startup of the cluster.  Instead, mention
it (with appropriate caveats) on the general mgr admin
page.

Signed-off-by: John Spray <john.spray@redhat.com>
2018-07-03 09:48:56 +01:00
Jos Collin
1007a19b7e doc: Updated dashboard doc references
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-06-28 16:02:06 +05:30
Kefu Chai
789b23ad85 doc/mgr: remove none user-facing code from doc
Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-02-09 01:47:35 +08:00
John Spray
d220e1adc3 doc: describe using mgr module ... commands
...including the new "mgr services" command.

Signed-off-by: John Spray <john.spray@redhat.com>
2017-11-01 08:21:43 -04:00
Alfredo Deza
309c73e8b0 doc/mgr add a label for the administrator guide
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:08:08 -04:00
John Spray
b28c300258 qa/doc: update for "mgr tell" no longer needed
Signed-off-by: John Spray <john.spray@redhat.com>
2017-07-19 08:58:40 -04:00
Greg Farnum
a4b1395419 doc: fix link for ceph-mgr cephx authorization
Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2017-07-10 10:56:53 -07:00
Kefu Chai
254e07441c doc: kill sphinx warnings
* doc/release-notes.rst: escape asterisks not used for inline emphasis
    fix bad hyper links
* doc/rados/troubleshooting/troubleshooting-osd.rst: escape asterisks
    not used for inline emphasis
* doc/radosgw/index.rst: add orphan docs to toc
* doc/dev/perf_histograms.rst: indent block quote
* doc/install/manual-freebsd-deployment.rst: fix block quotes
* doc/mgr/administrator.rst: escape asterisks not used for inline emphasis
* doc/start/quick-rbd.rst: add missing hyper link target

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-07-07 11:50:33 +08:00
Sage Weil
289f5ed093 doc: update docs for enabling mgr modules
Signed-off-by: Sage Weil <sage@redhat.com>
2017-06-29 23:10:51 -04:00
Greg Farnum
6846f4830c mgr: print a more helpful error message for when users lack mgr cephx caps
Add some brief documentation on updating their caps and link to it.

Fixes: http://tracker.ceph.com/issues/20296

Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2017-06-16 18:41:10 -07:00
John Spray
1cfeff3661 doc/mgr: update for mgr_beacon_period change
This setting got renamed.

Signed-off-by: John Spray <john.spray@redhat.com>
2017-06-14 10:04:22 -04:00
John Spray
b61f0c0b31 doc/mgr: fix auth keys instruction
This was out of date.

Signed-off-by: John Spray <john.spray@redhat.com>
2017-06-14 09:54:26 -04:00
Ken Dreyer
be7de7ab0d doc: fix mgr literal block rST syntax
Prior to this change, there were double-colon ("::") characters in the
HTML docs to indicate literal blocks.

The proceeding paragraphs were not pre-formatted because there was no
newline between the double-colon and the to-be-pre-formatted paragraph.

Move the "::" characters inline to simplify the syntax and make Sphinx
properly interpret these texts as literal blocks.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-10-25 19:51:53 -06:00
huanwen ren
b7891ee3f2 doc/mgr: fix mgr how long to wait to failover
Signed-off-by: huanwen ren <ren.huanwen@zte.com.cn>
2016-10-19 17:01:28 +08:00
John Spray
567b9fb692 doc: add initial ceph-mgr docs
Signed-off-by: John Spray <john.spray@redhat.com>
2016-09-29 17:27:05 +01:00