Commit Graph

1347 Commits

Author SHA1 Message Date
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
Ilya Dryomov
7eb9c5ddb2 Merge branch 'master' into wip-unauthorized-gids
Sync up with master up to commit 3d8e73b266 ("Merge pull request
#40731 from tchaikov/wip-yamlize-options").  Specifically, bring in
src/common/options.cc yamlization and move new auth-related options
into src/common/options/global.yaml.in.

Conflicts:
	src/common/options.cc
	src/common/options/global.yaml.in

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-04-13 15:42:06 +02: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
Sage Weil
18b343b06e mon/HealthMonitor: raise AUTH_INSECURE_GLOBAL_ID_RENEWAL[_ALLOWED]
Two new alerts:

- AUTH_INSECURE_GLOBAL_ID_RENEWAL_ALLOWED if we are allowing clients to reclaim
global_ids in an insecure manner (for backwards compatibility until
clients are upgraded)

- AUTH_INSECURE_GLBOAL_ID_RENEWAL if there are currently clients connected that
do not know how to securely renew their global_id, as exposed by
auth_expose_insecure_global_id_reclaim=true.  The client auth names and IPs
are listed the alert details (up to a limit, at least).

The docs recommend operators mute these alerts instead of silencing, but
we still include option that allow the alerts to be disabled entirely.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-04-06 17:28:55 -04: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
f755e353e8 os/bluestore: separate omap per-pool vs per-pg alerts
Currently the health alert raised does not match the docs, and the docs
do not describe what the health alert indicates.

Octopus added per-pool omap storage.  This improves space accounting
and reporting.

Pacific added per-pg omap storage (object hash in key).  This speeds up
PG removal.

Separate everthing out into two distinct alerts raised from bluestore
and surfaced as health alerts, with corresponding config options to
disable, and update the docs accordingly.

Also update the fsck options for warn vs error, and raise separate
errors for the per-pg and per-pool cases.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-03-24 07:34:39 -05:00
Patrick Donnelly
6ad5901422
Merge PR #39191 into master
* refs/pull/39191/head:
	pybind/mgr/snap_schedule: use ceph VFS
	pybind/mgr/snap_schedule: idempotentize table creation
	mgr: add ceph sqlite VFS
	doc: add libcephsqlite
	ceph.spec,debian: package libcephsqlite
	test/libcephsqlite,qa: add tests for libcephsqlite
	libcephsqlite: rework architecture and backend
	SimpleRADOSStriper: wait for finished aios after write
	SimpleRADOSStriper: add new minimal async striper
	mon: define simple-rados-client-with-blocklist profile
	librados: define must renew lock flag
	common: add timeval conversion for durations
	Revert "libradosstriper: add function to read into char*"
	test_libcephsqlite: test random inserts
	cephsqlite: fix compiler errors
	cmake: improve build inst for cephsqlite
	libcephsqlite: sqlite interface to RADOS
	libradosstriper: add function to read into char*

Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-03-22 10:06:11 -07: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
Patrick Donnelly
d08a977a76
doc: add libcephsqlite
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-03-19 08:52:55 -07:00
Patrick Donnelly
108f486afe
mon: define simple-rados-client-with-blocklist profile
A mon profile that grants the ability for rados clients to blocklist
others (similar to rbd).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-03-19 08:52:55 -07:00
Jonas Jelten
76a67d7753 doc: update osd-class-path error messages
the return value is "95 Operation not supported"

Signed-off-by: Jonas Jelten <jj@sft.lol>
2021-03-16 16:16:02 +01: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
089938a1af
Merge pull request #39558 from sebastian-philipp/doc-rados-rm-toctree-cephadm
doc/rados: avoid including cephadm into the toctree

Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-03-03 16:17:51 +01: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
Sebastian Wagner
bd2ef3c869 doc/rados: avoid including cephadm into the toctree
Otherwise cephadm will be also included in the doc/rados toctree

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-24 18:25:20 +01:00
Kefu Chai
bb17a4fc1d
Merge pull request #39564 from tchaikov/wip-doc-layout
doc: consolidate the layout settings using CSS

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-02-24 11:36:14 +08:00
Neha Ojha
b7bb6cf6ce
Merge pull request #39288 from cybozu/fix-the-procedure-of-recovery-mon-quorum-using-osd
doc: fix the procedure of recovery mon quorum using osd

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-23 13:38:31 -08:00
Kefu Chai
bdfbdb8910
Merge pull request #39471 from sebastian-philipp/rados-rm-manage-upstart
doc/rados/operations: Remove upstart

Reviewed-by: Brad Hubbard <bhubbard@redhat.com>
2021-02-19 14:56:17 +08:00
Kefu Chai
702f376601 doc: consolidate the layout settings using CSS
instead of inlining the layout related settings, move them to a single
place. and do the layout using the flex box instead using tables.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-02-19 11:29:39 +08:00
Sebastian Wagner
02584d3ee7 doc/cephadm: Restoring the MON quorum
Fixes: https://tracker.ceph.com/issues/49214
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-16 13:48:09 +01:00
Sebastian Wagner
318cb12e08 doc/rados/operations: Remove upstart
Followup on 2c755cef69

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-15 13:13:36 +01:00
Kefu Chai
72dee5d0d3
Merge pull request #39258 from Rethan/doc-remove-ms-options
doc/rados: remove some invalid ms option

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-02-05 13:48:10 +08:00
Satoru Takeuchi
7f9dad3eb5 doc: fix the procedure of recovery mon quorum using osd
`ceph-monstore-tool` expects mons names are sorted by ip adrress. However,
this is not always true after the following PR.

https://github.com/ceph/ceph/pull/22193

We can bypass this problem by using `--mon-ids` option.

Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com>
2021-02-04 06:09:06 +00:00
Zac Dover
f4e053ab5f doc/rados: s/realy/really/
This corrects the spelling of "realy" to "really".
Hat-tip to IcePic, who noticed this on 03 Feb 2021.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-04 01:04:24 +10: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
Brad Hubbard
0060cc52f9 doc/rados/api: Update code samples to python3
Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2021-02-01 11:14:16 +10: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
haoyixing
5c25778258 mon/PGMap: align to same side when output ceph df / ceph df detail
Aligns are not in the same side when showing raw storage usage and
pools, change to the same side.

Signed-off-by: haoyixing <haoyixing@kuaishou.com>
2021-01-04 19:59:16 +08:00
Jonas Jelten
cb300ee6b8 doc: fix and improve the explainations of up and acting osd sets
acting = where clients requests are processed
up = where pgs were planned to be by crush+upmap

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

Signed-off-by: Jonas Jelten <jj@sft.lol>
2020-12-27 18:33:36 +01:00
zdover23
867f910941
Merge pull request #38621 from anthonyeleven/anthonyeleven/bluestore-doc-cleanup
doc/rados/configuration: clean up BlueStore config and enhance DB sizing

Reviewed-by: Igor Fedotov <ifedotov@suse.com>
2020-12-22 22:05:17 +10: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
Ernesto Puerta
65b11e931e
Merge pull request #38473 from votdev/issue_48474_health_check
mgr/dashboard: Display a warning message in Dashboard when debug mode is enabled

Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Tatjana Dehler <tdehler@suse.com>
2020-12-17 17:35:01 +01:00
Volker Theile
a1aa760acf mgr/dashboard: Display a warning message in Dashboard when debug mode is enabled
Set a health check warning if debug mode is enabled.

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

Signed-off-by: Volker Theile <vtheile@suse.com>
2020-12-16 14:13:44 +01: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