Commit Graph

511 Commits

Author SHA1 Message Date
Zac Dover
c65d2056c2 doc/rados: remove dual-stack docs
Remove references to dual-stack mode in
doc/rados/configuration/network-config-ref.rst and
doc/rados/configuration/msgr2.rst. This feature seems to have been
planned but never to have been completely implemented.

See the tracker issue listed below for an email exchange detailing the
confusion caused by the presence in the documentation of this
now-removed information.

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

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-04-23 16:37:27 +10:00
Pierre Riteau
23d2740241 doc/rados: fix outdated value for ms_bind_port_max
The highest port number used by OSD or MDS daemons was increased from
7300 to 7568 in [1] but the documentation still refers to 7300 in
multiple locations.

[1] https://github.com/ceph/ceph/pull/42210

Fixes: https://tracker.ceph.com/issues/65609
Signed-off-by: Pierre Riteau <pierre@stackhpc.com>
2024-04-22 11:28:53 +02:00
Zac Dover
233b670704 doc/rados: update common.rst
Clarify some overwritten paragraphs in
doc/rados/configuration/common.rst. Cf.
https://github.com/ceph/ceph/pull/50795/files#r1153897231.

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-17 23:40:49 +10:00
Pierre Riteau
d25b6b9dd2 doc/rados/configuration/osd-config-ref: fix typo
Signed-off-by: Pierre Riteau <pierre@stackhpc.com>
2024-02-20 22:54:01 +01:00
Ronen Friedman
5ad6f16562 doc/osd: update the documentation of several scrub-related options
Signed-off-by: Ronen Friedman <rfriedma@redhat.com>
2024-02-11 21:30:05 +02:00
Zac Dover
4dc12092be doc/rados: update config for autoscaler
Update doc/rados/configuration/pool-pg-config-ref.rst to account for the
behavior of autoscaler.

Previously, this file was last meaningfully altered in 2013, prior to
the invention of autoscaler. A recent confusion was brought to my
attention on the Ceph Slack whereby a user attempted to alter the
default values of a Quincy cluster, as suggested in this documentation.
That alteration caused Ceph to throw the error "Error ERANGE: 'pgp_num'
must be greater than 0 and lower or equal than 'pg_num', which in this
case is one" and a related "rgw_init_ioctx ERROR" reading in part
"Numerical result out of range". The user removed the
"osd_pool_default_pgp_num" configuration line from ceph.conf and the
cluster worked as expected. I presume that this is because the removal
of this configuration line allowed autoscaler to work as intended.

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

Co-authored-by: David Orman <ormandj@corenode.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-03 12:35:19 +10:00
Zac Dover
c886e05404 doc/config: edit "ceph-conf.rst"
Edit the first section of doc/rados/configuration/ceph-conf.rst.
Initially I just wanted to change "series" to "set", but once I got my
hands dirty I ended up simplifying some sentences.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-12 20:21:41 +10:00
Anthony D'Atri
4ad0aa1155
Merge pull request #54339 from aclamk/fix-aclamk-bs-reshard-doc-v2
doc/rados/configuration/bluestore-config-ref: Fix lowcase typo
2023-11-03 19:28:26 -04:00
Adam Kupczyk
f14ef59984 doc/rados/configuration/bluestore-config-ref: Fix lowcase typo
Letter "O" got lowcased to "o".
Reverted that.

Signed-off-by: Adam Kupczyk <akupczyk@ibm.com>
2023-11-03 20:32:28 +01:00
Anthony D'Atri
165c8f3242
Merge pull request #54331 from aclamk/fix-aclamk-bs-reshard-doc
Fixing example of BlueStore resharding.
2023-11-03 12:17:13 -04:00
Adam Kupczyk
59a7f01b5c doc/rados/configuration/bluestore-config-ref: Fix lowcase typo
Letters "L P" got lowcased to "l p".
Reverted that.

Signed-off-by: Adam Kupczyk <akupczyk@ibm.com>
2023-11-03 16:50:19 +01:00
Zac Dover
19b139932d doc/rados: improve "scrubbing" explanation
Improve the English describing the operation of scrubbing PGs in
doc/rados/configuration/osd-config-ref.rst.

Co-authored-by: Ronen Friedman <rfriedma@redhat.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-10-31 22:15:57 +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
eab0be5ca5 doc/rados: remove FileStore material (in Reef)
Remove FileStore-related material because FileStore is not supported in
Reef.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-10-14 04:40:26 +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
Ville Ojamo
df43ab5ba6
doc/rados/configuration: Avoid repeating "support" in msgr2.rst
Instead of saying "[...] support is not supported"
change the first "support" to "operation".

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-08-02 11:31:50 +07:00
Ville Ojamo
06cb565215 doc/rados/configuration: add links to MON DNS
Add two links to MON DNS lookup and an anchor in the destination document.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-07-24 10:15:01 +07:00
Zac Dover
ac47899863 doc/rados: edit ceph-conf.rst (4 of x)
Edit doc/rados/configuration/ceph-conf.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-07-23 21:56:05 +10:00
Zac Dover
b1fb80ae08 doc/rados: edit ceph-conf.rst (3 of x)
Edit doc/rados/configuration/ceph-conf.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-07-22 14:42:32 +10:00
Zac Dover
69b9b20be1 doc/rados: edit ceph-conf.rst (2 of x)
Edit doc/rados/configuration/ceph-conf.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-07-16 19:08:45 +10:00
Zac Dover
dd8d91b0de doc/rados: edit ceph-conf.rst
Edit doc/rados/configuration/ceph-conf.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-07-14 15:02:28 +10:00
Yuri Weinstein
b2ec2aff80
Merge pull request #50651 from rosinL/cleanup
Cleanup the LevelDB residue


Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2023-06-05 11:32:51 -04:00
Zac Dover
1ceeab30eb doc/rados: edit bluestore-config-ref.rst (2 of x)
Edit the second part of doc/rados/configuration/bluestore-config-ref.rst.

https://tracker.ceph.com/issues/58485

Co-authored-by: Anthoy D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-05-27 21:10:16 +10:00
Zac Dover
3879e4ad41 doc/rados: edit bluestore-config-ref.rst (1 of x)
Edit the first part of doc/rados/configuration/bluestore-config-ref.rst.

https://tracker.ceph.com/issues/58485

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-05-27 05:11:37 +10:00
Zac Dover
8128ce20fe doc/rados: fix link in common.rst
Fix a link in doc/rados/configuration/common.rst that was missing its
final letter, causing a 404 error when readers attempted to follow it.

This bug was reported by stalwart friend of the Ceph documentation
project Eugen Block, who is here credited as a co-author. This bug was
reported at https://pad.ceph.com/p/Report_Documentation_Bugs.

Co-authored-by: Eugen Block <eblock@nde.ag>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-05-25 19:01:49 +10:00
Zac Dover
1202e4207b doc/rados: edit filestore-config-ref.rst
Edit doc/rados/configuration/filestore-config-ref.rst.

https://tracker.ceph.com/issues/58485

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-05-25 10:16:51 +10:00
Sridhar Seshasayee
414ac7dd2c osd/scheduler: Reset ephemeral changes to mClock built-in profile
This is a follow-up to PR: https://github.com/ceph/ceph/pull/48703.
This commit also considers changes made ephemerally using either the
'daemon' or the 'tell' interfaces to override the built-in mClock
QoS parameters. In such a scenario, the ephemeral changes are removed
using the rm_val() method exposed by the config subsytem and logging
this information.

Other changes:

1. Add a standalone test to exercise the fix.
2. Add documentation note on the outcome of the attempt to modify
   built-in profile defaults.

Fixes: https://tracker.ceph.com/issues/61155
Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2023-05-18 14:03:45 +05:30
Sridhar Seshasayee
b701fbc01d doc/: Modify mClock configuration documentation to reflect profile changes
Modify the relevant documentation to reflect:

- change in the default mClock profile to 'balanced'
- new allocations for ops across mClock profiles
- change in the osd_max_backfills limit
- miscellaneous changes related to warnings.

Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2023-05-08 16:22:00 +05:30
Sridhar Seshasayee
d29548aca8 doc: Modify mClock configuration documentation to reflect new cost model
Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2023-05-08 16:22:00 +05:30
Anthony D'Atri
79256c1213 doc/rados/configuration: correct space amp in bluestore-config-ref.rst
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2023-05-05 20:43:15 -04: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
zdover23
195262cf6b
Merge pull request #51143 from NitzanMordhai/wip-nitzan-filestore-removal-docs-update
docs: warning and remove few docs section for Filestore

Reviewed-by: Zac Dover <zac.dover@proton.me>
2023-04-20 07:42:58 +02:00
Nitzan Mordechai
d79f2a8154 docs: warning and remove few docs section for Filestore
Update docs after filestore removal.

Signed-off-by: Nitzan Mordechai <nmordech@redhat.com>
2023-04-20 05:01:53 +00:00
Anthony D'Atri
cdceabd684
Merge pull request #50639 from bitfehler/bitfehler/doc-pg-num
doc: account for PG autoscaling being the default
2023-04-17 22:58:51 +02:00
Zac Dover
3d0acf9372 doc/rados/config: edit auth-config-ref
Line edit doc/rados/config/auth-config-ref.rst.

https://tracker.ceph.com/issues/58485

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-04-09 11:26:21 +10:00
Zac Dover
6c9f226742 doc/rados: line-edit common.rst
Edit syntax and semantics in doc/configuration/common.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-04-08 13:11:41 +10:00
zdover23
f66bdb87f7
Merge pull request #45354 from dvanders/dualdoc
doc/msgr2: update dual stack status

Reviewed-by: Zac Dover <zac.dover@proton.me>
2023-03-31 16:25:31 +10:00
Zac Dover
4a66819da4 doc/glossary: add "Scrubbing"
Add "Scrubbing" to the glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-03-28 08:07:30 +10:00
Conrad Hoffmann
402d2eacbc doc: account for PG autoscaling being the default
The current documentation tries really hard to convince people to set
both `osd_pool_default_pg_num` and `osd_pool_default_pgp_num` in their
configs, but at least the latter has undesirable side effects on any
Ceph version that has PG autoscaling enabled by default (at least quincy
and beyond).

Assume a cluster with defaults of `64` for `pg_num` and `pgp_num`.
Starting `radosgw` will fail as it tries to create various pools without
providing values for `pg_num` or `pgp_num`. This triggers the following
in `OSDMonitor::prepare_new_pool()`:

- `pg_num` is set to `1`, because autoscaling is enabled
- `pgp_num` is set to `osd pool default pgp_num`, which we set to `64`
- This is an invalid setup, so the pool creation fails

Likewise, `ceph osd pool create mypool` (without providing values for
`pg_num` or `pgp_num`) does not work.

Following this rationale:

- Not providing a default value for `pgp_num` will always do the right
  thing, unless you use advanced features, in which case you can be
  expected to set both values on pool creation
- Setting `osd_pool_default_pgp_num` in your config breaks pool creation
  for various cases

This commit:

- Removes `osd_pool_default_pgp_num` from all example configs
- Adds mentions of the autoscaling and how it interacts with the default
  values in various places

For each file that was touched, the following maintenance was also
performed:

- Change interternal spaces to underscores for config values
- Remove mentions of filestore or any of its settings
- Fix minor inconsistencies, like indentation etc.

There is also a ticket which I think is very relevant and fixed by this,
though it only captures part of the broader issue addressed here:

Fixes: https://tracker.ceph.com/issues/47176
Signed-off-by: Conrad Hoffmann <ch@bitfehler.net>
2023-03-23 22:15:25 +01:00
Zac Dover
ed5919964b doc/rados: line edit mon-lookup-dns top matter
Improve the syntax of the top matter of
doc/rados/operations/mon-lookup-dns.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-03-19 17:34:58 +10:00
Zac Dover
983ea9cc73 doc/rados: document osd_op_thread_suicide_timeout
Add default value for osd_op_thread_suicide_timeout configuration value
to the OSD Configuraton Reference.

https://tracker.ceph.com/issues/58590

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-29 20:24:58 +10:00
zdover23
f780ca2e3d
Merge pull request #49820 from zdover23/wip-doc-2023-01-21-rados-config-pool-pg-config-ref
doc/rados: refine pool-pg-config-ref.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
2023-01-23 21:50:59 +10:00
Zac Dover
dfb0b4a6ad doc/rados: refine ceph-conf.rst
Correct grammar and usage in ceph-conf.rst.

https://tracker.ceph.com/issues/58485

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-23 19:16:16 +10:00
Zac Dover
11724c9b8e doc/rados: refine pool-pg-config-ref.rst
Remove pleonasm.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-21 15:04:12 +10:00
Zac Dover
88087f7f66 doc/rados: add prompts to bluestore-config-ref.rst
Add unselectable prompts to
doc/rados/configuration/bluestore-config-ref.rst.

https://tracker.ceph.com/issues/57108

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-21 17:41:04 +10:00
colemitchell
a4d5157845
Merge pull request #49514 from zdover23/wip-doc-2022-12-20-glossary-cephx-config-ref-link
doc/glossary: link to CephX Config ref

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-12-19 19:41:17 -05:00
colemitchell
4a31ae3282
Merge pull request #49513 from zdover23/wip-doc-2022-12-20-rados-auth-config-ref-prompts
doc/rados: add prompts to auth-config-ref.rst

Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
2022-12-19 13:18:59 -05:00
Zac Dover
36a8f27e96 doc/glossary: link to CephX Config ref
Link to the CephX Configuration Reference in the "CephX" entry in the
glossary.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-20 04:16:19 +10:00