Commit Graph

417 Commits

Author SHA1 Message Date
Kefu Chai
ecb8e5e9c7 doc/rados/operations/pools: define pool settings using "describe"
better readability and more structured this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-26 21:01:44 +08:00
Kefu Chai
4e27388ba7 doc/rados/configuration: reference options using :confval:
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-26 21:01:44 +08: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
be07a5b407 doc/rados/configuration: add missing options
and link to them when appropriate

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
4481f4ac75 doc/rados/configuration/general-config-ref: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-21 12:33:19 +08:00
Kefu Chai
4a4dc9f5a1 doc/rados/configuration/osd-config-ref: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-21 12:33:19 +08:00
Kefu Chai
d72fb1f3e6 doc/rados/configuration/osd-config-ref: use confval directive
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-20 22:49:20 +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
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
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
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
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
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
Zac Dover
f3180ad722 doc/rados: rewrite mclock docs (2 of 2)
This is my second attempt to rewrite the
second half of the mclock docs. The first attempt
is enshrined in https://github.com/ceph/ceph/pull/40571,
in which I got cute with git and got burned.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-04-10 06:49:43 +10:00
Adam Kupczyk
a2067a02d7 doc: Add BlueStore sharding documentation
Provide sharding explanation, configuration parameters explanation.
Provide resharding tool example into Pacific format.

Signed-off-by: Adam Kupczyk <akupczyk@redhat.com>
Co-authored-by: Josh Durgin <jdurgin@redhat.com>
2021-04-08 09:27:58 +02:00
Zac Dover
e262e85606 doc/rados: rewrite mclock-config-ref
This PR rewrites the material provided in
PR#40531, improving its elegance and
readability.

This PR rewrites the first 48 percent of the
material provided in PR#40531.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-04-07 03:17:51 +10:00
Kefu Chai
f26515fef7
Merge pull request #40168 from amathuria/wip-amathuria-fix-mon-trimming
mon: Modifying trim logic to change paxos_service_trim_max dynamically

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-04-03 22:12:26 +08:00
Sridhar Seshasayee
0ddeccf4b5 doc: Add mclock configuration reference documentation
Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2021-04-01 19:03:14 +05:30
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
Kefu Chai
b60d041efa doc/rados/configuration: format confval with "confval" directive
for better formatting

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-28 23:38:02 +08:00
Sage Weil
67e842d519 Merge PR #39654 into master
* refs/pull/39654/head:
	common/options: drop ms_async_max_op_threads
	msg/async: drop Stack::num_workers
	msg/async: s/num_workers/workers.size()/
	msg/async: use range-based loop in NetworkStack
	msg/async: do not pass worker id to Stack::spawn_worker()
	async/Stack: pass Worker* to NetworkStack::add_thread()
	async/rdma: do not reference worker id in RDMAStack::spawn_worker()
	async/dpdk: do not use worker id when creating worker
	async/PosixStack: do not reference worker id in ctor
	async/rdma: initialize worker in RDMAStack::create_worker()
	async/rdma: move RDMAStack::create_worker() to .cc

Reviewed-by: luo runbing <luo.runbing@zte.com.cn>
Reviewed-by: Haomai Wang <haomai@xsky.com>
2021-03-03 08:38:21 -05:00
Zac Dover
2ec313caba doc/cephadm: rewrite "b.strap a new cluster"
This PR rewrites the section "Bootstrap A New
Cluster" in the Cephadm Guide, in the Install
Chapter. I've broken this section up into what
seem to me to be the topics that the content
naturally divides into.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-03-02 04:20:35 +10:00
Kefu Chai
c27e0253d6
Merge pull request #38604 from cybozu/doc-fix-the-meaning-of-min_size
doc: fix the meaning of default_min_size of pools

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-02-26 17:25:45 +08:00
Kefu Chai
ee7184639d common/options: drop ms_async_max_op_threads
the last user of this option was DPDKStack::DPDKStack(). which used it
to initialize its func vector. but this option is not used anymore.

so let's drop it.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-02-26 11:28:07 +08:00
haoyixing
58406fabe8 doc/rados: remove some invalid ms option
Remove some outdated ms options.

Signed-off-by: haoyixing <haoyixing@kuaishou.com>
2021-02-03 20:53:41 +08: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
Anthony D'Atri
7673793945 doc/rados/configuration: clean up BlueStore config and enhance DB sizing guidance 2020-12-18 10:25:28 -08:00
Satoru Takeuchi
2981770f8e doc: fix the meaning of default_min_size of pools
`osd pool default min size` affects not only write operations,
but also read operations.

Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com>
2020-12-18 10:37:46 +09: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
胡玮文
4dd26d651f doc: Fixes a typo in mon_dns_srv_name.
Signed-off-by: 胡玮文 <huww98@outlook.com>
2020-12-11 17:16:21 +08:00
Kefu Chai
15affa5bca
Merge pull request #38457 from tchaikov/wip-mon-scrub-interval
mon: use TYPE_SEC for mon_scrub_interval

Reviewed-by: Joao Eduardo Luis <joao@suse.com>
Reviewed-by: Brad Hubbard <bhubbard@redhat.com>
2020-12-09 16:45:00 +08:00
Neha Ojha
55c0f16752
Merge pull request #38418 from anthonyeleven/anthonyeleven/clarify-op-priorities
doc: clarify osd recovery op priority and fix a couple of typos

Reviewed-by: David Zafman <dzafman@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-12-08 13:14:58 -08:00
Anthony D'Atri
bc41ae3a88 doc: clarify osd recovery op priority and fix a couple of typos
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-12-07 21:01:36 -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
Igor Fedotov
ba9b547120 doc/osd-config-ref: adjust default value for osd_delete_sleep_hybrid
Signed-off-by: Igor Fedotov <ifedotov@suse.com>
2020-12-05 00:09:52 +03:00