Commit Graph

63 Commits

Author SHA1 Message Date
Zac Dover
ea1a470fb4 doc: s/Whereas,/Although/
Change the subordinating conjunction "Whereas" followed by a comma to
the less grammatically-incorrect "Although". I've been meaning to do
this since 22 Mar 2023.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-11-01 23:43:07 +10:00
Zac Dover
78878511a3 doc/rados: remove HitSet-related key information
Remove HitSet-related key information from
doc/rados/operations/pools.rst. HitSet-related keys are relevant only to
releases of Ceph that support cache tiering. Only Quincy and earlier
(inclusive) releases of Ceph support cache tiering. Backport this commit
from main to Reef, but not to Quincy or to release branches earlier than
Quincy.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-10-27 12:43:14 +10:00
Zac Dover
d0cdfc1d72 doc/rados: edit troubleshooting-pg (2 of x)
Edit doc/rados/troubleshooting/troubleshooting-pg.rst (1 of x).

Follows https://github.com/ceph/ceph/pull/54052.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-10-20 05:42:31 +10:00
Zac Dover
d009f0757c doc/configuration: edit "bg" in mon-config-ref.rst
Edit the English in the section "Background" in
doc/rados/configuration/mon-config-ref.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-08 22:03:54 +10:00
luo rixin
6da360833a doc: remove leveldb support from doc
Signed-off-by: luo rixin <luorixin@huawei.com>
2023-05-04 10:43:08 +08:00
Zac Dover
9223863fc8 doc/rados: m-config-ref: edit "background"
Edit the "Background" section of doc/rados/monitor/config-ref.rst

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-04-28 08:45:04 +10:00
Zac Dover
8f4ad5dc9d doc/glossary: add "ceph monitor" entry
This commit adds information to the "ceph monitor" entry in
glossary.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-12 03:20:07 +10:00
Ville Ojamo
98ac8e1130 doc: replace spaces with underscores in config option names
Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2022-04-23 09:35:27 +02:00
Kefu Chai
c34cc03684 doc/rados/configuration/mon-config-ref: link by ref instead of relative hyperlink
the latter is more fragile.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-22 12:08:54 +08:00
Kefu Chai
ae5f2b2ca3 doc/rados/configuration/mon-config-ref: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-22 12:08:54 +08:00
Kefu Chai
52a5655296 doc/rados/configuration/mon-config-ref: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-21 12:37:03 +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
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
Aishwarya Mathuria
2e1141e439 mon: Modifying trim logic to change paxos_service_trim_max dynamically
Currently, the Paxos Service trim logic is bounded by a max value (paxos_service_trim_max). This change dynamically modifies the max value when the number of logs to be trimmed is higher than paxos_service_trim_max.

 The paxos_service_trim_max_multiplier has been added in case we want to increase paxos_service_trim_max by a certain factor. If this option is enabled we get a new upper bound when trim sizes are high.

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

Signed-off-by: Aishwarya Mathuria <amathuri@redhat.com>
2021-03-30 00:13:37 +05:30
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
Kefu Chai
fc82b0ae8e mon: use TYPE_SEC for mon_scrub_interval
* common/legacy_config_opts.h: drop mon_scrub_interval from legacy
  settings. as this option is not in critical path. so we can afford
  the overhead of look its value up in the map.
* common/options.cc: change mon_scrub_interval's type from TYPE_INT
  to TYPE_SECS, so we can use human friendly representations like
  "3 days" when specifying its value
* mon/Monitor.cc: adapt to the changes above.
* doc/rados: update the doc for "mon scrub interval" accordingly

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-06 16:30:45 +08:00
zdover23
de870cac81
Merge pull request #38092 from anthonyeleven/anthonyeleven/docs-mixed-device-trick
doc/rados/operations: enhance primary affinity section

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-23 22:20:13 +10:00
Anthony D'Atri
7fde53bbb1 doc/rados/operations: POOL_NEAR_FULL on OSD_NEAR_FULL
Fixes: https://tracker.ceph.com/issues/40579
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-22 00:02:54 -08:00
Anthony D'Atri
61a7eb8647 doc/rados/operations: enhance primary affinity section
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-21 23:57:31 -08:00
Robert Sander
1b42759e19 doc: remove references to ceph-deploy
The documentation still has many traces of ceph-deploy. This tool has
been deprecated with the Octopus release. This commit tries to remove
most of ceph-deploy occurences.

Signed-off-by: Robert Sander <r.sander@heinlein-support.de>
2020-09-02 21:14:36 +02:00
Kefu Chai
fe07df9f19 doc: always refernce terms in case sensitive mode
to silence warning from sphinx like:

ceph/doc/install/ceph-deploy/quick-start-preflight.rst:5: WARNING: term node not found in case sensitive match.made a reference to Node instead.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:18 +08:00
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00
Sridhar Seshasayee
33c647e811 osd/OSDMap: Show health warning if a pool is configured with size 1
Introduce a config option called 'mon_warn_on_pool_no_redundancy' that is
used to show a health warning if any pool in the ceph cluster is
configured with a size of 1. The user can mute/unmute the warning using
'ceph health mute/unmute POOL_NO_REDUNDANCY'.

Add standalone test to verify warning on setting pool size=1. Set the
associated warning to 'false' in ceph.conf.template under qa/tasks so
that existing tests do not break.

Fixes: https://tracker.ceph.com/issues/41666
Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2019-11-11 10:36:35 +05:30
David Zafman
336b6b66ca
Merge pull request #28755 from dzafman/wip-network
feature: Health warnings on long network ping times, add "dump_osd_network" to get a report

Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2019-09-05 07:54:43 -07:00
David Zafman
5f83a6158b osd doc mon mgr: To milliseconds for config value, user input and threshold out
Signed-off-by: David Zafman <dzafman@redhat.com>
2019-09-04 17:13:32 +00:00
James McClune
8d8cbabff4 doc: updated ceph monitor config options
Executed ceph-conf --dump-all on a freshly installed v14.2.2 (nautilus)
cluster. Compared the global defaults to the keys/values specified in
mon-config-ref.rst. Checked options.cc to make sure the obsolete keys
are no longer used.

Fixes: https://tracker.ceph.com/issues/41516
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2019-08-29 23:54:10 -04:00
David Zafman
f4a0be2e87 doc: Add documentation and release notes
Signed-off-by: David Zafman <dzafman@redhat.com>
2019-08-26 15:25:34 +00:00
James McClune
820ada1e58 doc: default values for mon_health_to_clog_* were flipped
On a freshly installed nautilus cluster (i.e. 14.2.2), the default values are:

mon_health_to_clog_interval = 3600
mon_health_to_clog_tick_interval = 60.000000

Fixes: https://tracker.ceph.com/issues/41403
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2019-08-25 11:35:41 -04:00
Sridhar Seshasayee
3b96417e18 mon/OSDMonitor: Use generic priority cache tuner for mon caches
Use priority cache manager to tune inc, full and rocksdb caches.

Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2019-08-06 20:22:16 +05:30
Kai Wagner
1bf96668a5 doc: Remove value 'mon_osd_max_split_count' from the docs
Signed-off-by: Kai Wagner <kwagner@suse.com>
2019-02-22 11:16:34 +01:00
Josh Durgin
682def2e32 qa, doc: update ec fast read setting
31dd620883 renamed it but did not update the suites or docs

Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2019-02-08 17:11:34 -05:00
Sage Weil
1675cd5096 doc/rados/configuration: fix some 'mon addr' references
Signed-off-by: Sage Weil <sage@redhat.com>
2019-01-03 11:17:31 -06:00
James McClune
dafdd0f29f
doc: updated crush map tunables link
Updated crush map tunables link in rados/configuration/mon-config-ref.rst
Fixes: https://tracker.ceph.com/issues/36339

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-10-07 22:13:32 -04:00
Kefu Chai
5ee1fd2c32 doc: fix typos
Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-09-21 12:41:42 +08:00
James McClune
f38426a766 doc: fixed hit set type link
Fixed reference link for hit set type value. Restructured wording in description.
Fixes: https://tracker.ceph.com/issues/34539

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-09-09 21:41:08 -04:00
Bryan Stillwell
2e98517d36 doc: Fixed spelling errors in configuration section
Correct a number of spelling mistakes and word omissions in the cluster
configuration section of the docs.

Signed-off-by: Bryan Stillwell <bstillwell@godaddy.com>
2018-08-23 16:17:08 -06:00
Wido den Hollander
1213f0f9f1
common/config: Add description to (near)full ratio settings
For many users it is not clear that these only apply to initial creation
of the cluster and that afterwards these commands need to be used:

  ceph osd set-nearfull-ratio <float[0.0-1.0]>
  ceph osd set-full-ratio <float[0.0-1.0]>

Signed-off-by: Wido den Hollander <wido@42on.com>
2018-06-06 13:17:24 +02:00
Kefu Chai
127d25ccbd doc: fix warning reported by "build-doc linkcheck"
all the HTTP 301 (moved permanently) should be killed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-10-24 15:58:48 +08:00
Yao Guotao
f22c502553 doc: update default value of option mon_sync_timeout
Signed-off-by: Yao Guotao <yaoguot@gmail.com>
2017-09-19 04:47:00 -04:00
yaoguotao
d121f5619b doc: update default value of parameter mon_subscribe_interval
Signed-off-by: yaoguotao <yaoguot@gmail.com>
2017-09-12 05:09:10 -04:00
John Wilkins
6640837da3 doc/rados: Removed contractions to improve readabilty for ESL speakers.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-07-27 09:46:53 -07:00
linbing
7fc78257c3 mon: delete unused config opts of mon_sync_fs_threshold and remove it in mon-config-ref
Signed-off-by: linbing <linbing@t2cloud.net>
2017-06-14 13:20:22 +08:00
Drunkard Zhang
58ba14e2fd doc: hyperlink fixes
Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2017-05-19 09:41:33 +08:00
Kefu Chai
4b52a03859 doc: add descriptions for mon/mgr options
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-05-13 01:30:29 +08:00
David Zafman
a5731076ad osd: Handle backfillfull_ratio just like nearfull and full
Add BACKFILLFULL as a local OSD cur_state
Notify monitor of this new fullness state

Signed-off-by: David Zafman <dzafman@redhat.com>
2017-04-17 08:00:24 -07:00
Wido den Hollander
61bf31f847
doc: Add MON docs about pool flags and pool removal config settings
Signed-off-by: Wido den Hollander <wido@42on.com>
2016-11-11 10:00:27 +01:00
Wido den Hollander
4dfacf8031 doc: Add docs about looking up Monitors through DNS
Signed-off-by: Wido den Hollander <wido@42on.com>
2016-10-17 13:48:36 +02:00
MinSheng Lin
7f4e147885 doc: remove the description of deleted options
Fixes: http://tracker.ceph.com/issues/17041

Signed-off-by: MinSheng Lin <minsheng.l@inwinstack.com>
2016-08-16 22:13:12 +08:00
Yatin Kumbhare
c480ffa49d doc: fix broken link for bootstrapping monitors
Signed-off-by: Yatin Kumbhare yatinkumbhare@gmail.com
2016-05-04 11:34:20 +05:30
Yatin Kumbhare
c244eb2d61 doc: fix broken link to monitor quorum
Link pointing in Monitor Quorum section to
ceph configuration file was broken.
Fixing it to point to configuration section.

Signed-off-by: Yatin Kumbhare yatinkumbhare@gmail.com
2016-04-21 11:42:39 +05:30