Commit Graph

1810 Commits

Author SHA1 Message Date
Niklas Hambüchen
d91e75e1e9 doc/rados/operations: Improve crush_location docs
* Fix incorrect syntax
* Use underscores for config options, like other ceph docs did
* Fix incorrect statement that crush_location_hook adds fiels; it replaces
* Explain `root=default host=HOSTNAME` is not set if `crush_location` is given
* Remove duplication across sections
* Point out that `root=default` is important

Signed-off-by: Niklas Hambüchen <mail@nh2.me>
2024-03-30 23:11:17 +01:00
Taha Jahangir
3cd39e3582
docs/rados: remove incorrect ceph command
The removed line was (incorrectly changed) output of the previous command.

Signed-off-by: Taha Jahangir <mtjahangir@gmail.com>
2024-03-25 13:32:12 +03:30
Zac Dover
063fb89b21
Merge pull request #56287 from rzarzynski/wip-ec-profile-set-paranoid-on-override
mon, doc: overriding ec profile requires --yes-i-really-mean-it

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2024-03-25 06:57:30 +10:00
Zac Dover
5d300db825 doc/start: link to mon map command
Link to the "ceph mon stat" command when "Intro to Ceph" document first
mentions Monitor Maps.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-22 08:14:57 +10:00
Casey Bodley
0c72fcc26a
Merge pull request #56008 from kchheda3/wip-notification-subsys
rgw/notification: add rgw notification specific debug log subsystem

Reviewed-by: Yuval Lifshitz <ylifshit@redhat.com>
2024-03-21 15:08:35 +00:00
kchheda3
429967917b rgw/notification: add rgw notification specific debug log subsystem.
decorate the events with event details while logging.

Signed-off-by: kchheda3 <kchheda3@bloomberg.net>
2024-03-19 13:54:35 -04:00
Radoslaw Zarzynski
629ba7bd34 mon, doc: overriding ec profile requires --yes-i-really-mean-it
This is per https://tracker.ceph.com/issues/64333#note-17 describing
driving factors of a catastrophic cluster failure.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2024-03-19 14:12:38 +00: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
Zac Dover
2a93a8e837 doc/glossary: add "librados" entry
Add a "librados" entry to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-14 16:29:09 +10:00
Zac Dover
eaaf722531 doc/rados: restore PGcalc tool
Restore the PGcalc tool to the documentation suite.

Co-authored-by: Josh Durgin <jdurgin@redhat.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-08 16:34:53 +10:00
Zac Dover
9da81b87ca doc/rados: link to pg setting commands
Link to the instructions for manually setting the number of PGs per
pool, from the mention of placement groups. These instructions are
included here in response to a request from Ronen Friedman on the
occasion of the removal of links to the PGcalc (see
https://github.com/ceph/ceph/pull/55899#pullrequestreview-1912940118).

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-04 20:41:16 +10:00
Zac Dover
ccb851d2a4 doc/rados: remove PGcalc from docs
Remove mention of the "PG calc" tool from the documentation. I have
removed all mention of this in one fell swoop to help posterity restore
mention of this tool if we decide we need to do so.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-03 20:28:00 +10:00
Zac Dover
0b6739a4aa doc/rados: add "change public network" procedure
Add a procedure to /doc/rados/operations/add-or-rm-mons.rst that
explains how to change the public_network in a Ceph cluster deployed
with cephadm. This procedure was developed by Eugen Block, and can be
seen in its original form here:
https://heiterbiswolkig.blogs.nde.ag/2024/02/22/cephadm-change-public-network/

Co-authored-by: Eugen Block <eblock@nde.ag>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-27 20:42:21 +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
Zac Dover
2e25193670 doc/rados: fix broken links
Fix broken links in doc/rados/operations/add-or-rm-mons.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-21 04:07:07 +10:00
Zac Dover
39c809b33f doc/rados: add PG definition
Add a definition of Placement Groups to
doc/rados/operations/placement-groups.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-18 12:10:57 +10:00
Anthony D'Atri
0563b942ff
Merge pull request #55585 from zdover23/wip-doc-2024-02-15-rados-operations-placement-groups-sage-blog-post
doc/rados: add link to pg blog post
2024-02-14 15:28:27 -05:00
Zac Dover
9344893e08 doc/rados: add link to pg blog post
Add a link in the "Placement Groups" section that links to Sage Weil's
April 5, 2019 blog post "New in Nautilus: PG merging and autotuning".

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-15 01:32:40 +10:00
Ronen Friedman
f9619805cb doc/osd: fix 'scrub a PG' commands in the documentation
Signed-off-by: Ronen Friedman <rfriedma@redhat.com>
2024-02-14 14:50:15 +02: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
Radoslaw Zarzynski
72be1f4a8a
Merge pull request #55332 from athanatos/sjust/wip-crush-multi-choose
crush: add multistep retry rules

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
Reviewed-by: Greg Farnum <gfarnum@redhat.com>
2024-02-08 22:56:55 +01:00
Zac Dover
5ad241442d doc/rados: update PG guidance
Update the "Creating a Pool" section of doc/rados/operations/pools.rst
so that the documentation no longer insists that the user change the
values of "osd_pool_default_pg_num" and "osd_pool_default_pgp_num".

See also: https://github.com/ceph/ceph/pull/55419

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

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-05 18:41:21 +10:00
Samuel Just
aa88dfac4e doc/rados/operations: add CRUSH MSR documentation
Signed-off-by: Samuel Just <sjust@redhat.com>
2024-02-03 21:00:11 -08: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
Casey Bodley
862b2eeb5b
Merge pull request #54867 from BBoozmen/oozmen_lc_subsystem
rgw/common: add rgw lifecycle specific debug log subsystem

Reviewed-by: Matt Benjamin <mbenjamin@redhat.com>
Reviewed-by: Jiffin Tony Thottan <jthottan@redhat.com>
2024-02-02 15:42:00 +00:00
Laura Flores
e2ce8ed1ff mgr: add read balancer support inside the balancer module
Read balancing may now be managed automatically via the balancer
manager module. Users may choose between two new modes: ``upmap-read``, which
offers upmap and read optimization simultaneously, or ``read``, which may be used
to only optimize reads. Existing balancer commands have also been added to
contain more information about read balancing.

Run the following commands to test the new automatic behavior:
`ceph balancer on` (on by default)
`ceph balancer mode <read|upmap-read>`
`ceph balancer status`

Run the following commands to test the new supervised behavior:
`ceph balancer off`
`ceph balancer mode <read|upmap-read>`
`ceph balancer eval` | `ceph balancer eval <pool-name>`
`ceph balancer eval-verbose` | `ceph balancer eval-verbose <pool-name>`
`ceph balancer optimize <plan-name>`
`ceph balancer show <plan-name>`
`ceph balancer eval <plan-name>`
`ceph balancer execute <plan-name>`

In the balancer module, there is also a new "self_test" function which tests
the module's basic functionality. This test can be triggered with the following
commands:
`ceph mgr module enable selftest`
`ceph mgr self-test module balancer`

Related Trello: https://trello.com/c/sWoKctzL/859-add-read-balancer-support-inside-the-balancer-module
Signed-off-by: Laura Flores <lflores@ibm.com>
2024-01-28 13:15:38 -06:00
Samuel Just
a5ce9c3863 Revert "crush: add multistep retry rules"
This PR was merged by accident before it was ready.
Let's revert for now and open a new PR.

Signed-off-by: Samuel Just <sjust@redhat.com>
2024-01-26 20:32:05 +00:00
Yuri Weinstein
37d5d931b0
Merge pull request #55096 from athanatos/sjust/for-review/wip-crush-msr
crush: add multistep retry rules

Reviewed-by: Laura Flores <lflores@redhat.com>
2024-01-26 11:57:53 -08:00
zdover23
19aa8fc73d
Merge pull request #55161 from tobydarling/patch-2
doc/rados/operations: Fix off-by-one erors in control.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-01-18 20:41:38 +10:00
Anthony D'Atri
9e1999c13d doc/rados/operations: add EC overhead table to erasure-code.rst
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2024-01-17 11:55:39 -05:00
tobydarling
c636e3ed2d doc/rados/operations: Fix off-by-one errors in control.rst
Description of examples was off by one

Signed-off-by: tobydarling <anothercoffee@gmail.com>
2024-01-13 14:42:15 +00:00
Samuel Just
e6a3b55e5c doc/rados/operations: add CRUSH MSR documentation
Signed-off-by: Samuel Just <sjust@redhat.com>
2024-01-08 19:25:55 -08:00
Laura Flores
159751b680 doc/rados/operations: document ceph balancer status detail
Document change in https://github.com/ceph/ceph/pull/54801

Signed-off-by: Laura Flores <lflores@ibm.com>
2024-01-03 17:33:32 +00:00
Zac Dover
69c57c3b55 doc/rados: improve subsection title in log-and-debug.rst
Change the title of "Logging Settings" to "Logging and Debugging
Settings" in doc/rados/troubleshooting/log-and-debug.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-02 22:21:08 +10:00
Oguzhan Ozmen
c3ad41ba35 rgw/common: add rgw lifecycle specific debug log subsystem
Signed-off-by: Oguzhan Ozmen <oozmen@bloomberg.net>
2023-12-11 14:41:51 -05:00
Zac Dover
b73656787d doc/rados: repair stretch-mode.rst
Remove a section of doc/rados/operations/stretch-mode.rst that I wrongly
re-included after its removal. The request for this (re)-removal is
here: https://github.com/ceph/ceph/pull/54689#discussion_r1413007655.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-03 13:17:46 +01:00
PC-Admin
28551b41f8 doc/rados: update "stretch mode"
Update stretch mode docs, min_size and max_size are no longer defined in
the CRUSH map and the example rule given will fail to compile.

Specify that the tiebreaker data centre cannot be defined in CRUSH as
this produces an error.

Signed-off-by: Michael Collins <perthserverplus@gmail.com>
2023-12-03 06:45:16 +01:00
Zac Dover
e63fa697b7 doc/rados: improve formatting of log-and-debug.rst
Improve the arrangment of information in the section "Ceph Subsystems"
in doc/rados/troubleshooting/log-and-debug.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-01 10:35:42 +01:00
zdover23
a0312323e6
Merge pull request #54685 from zdover23/wip-doc-2023-11-28-rados-tshooting-log-and-debug-small-repair
doc/rados: improve "Ceph Subsystems"

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-11-29 05:39:10 +01:00
Zac Dover
7bca5f57cc doc/rados: improve "Ceph Subsystems"
Improve the English in the subsection "Ceph Subsystems" in the section
"Subsystem, Log and Debug Settings" [sic] in
doc/rados/troubleshooting/log-and-debug.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-29 03:01:53 +01:00
Zac Dover
ca81963321 doc/rados: ops/pgs: s/power of 2/power of two
Change "power of 2" to "power of two" in
doc/rados/operations/placement-groups.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-29 02:50:29 +01:00
Zac Dover
d8cd49259d doc/rados: edit "Everything Failed! Now What?"
Edit the section "Everything Failed! Now what?" in
doc/rados/troubleshooting/troubleshooting-mon.rst.

Co-authored-by: Anthoy D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-27 06:27:28 +01:00
Zac Dover
0a1ce00168 doc/rados: edit "monitor store failures"
Edit the section "Monitor Store Failures" in
doc/rados/troubleshooting/troubleshooting-mon.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-25 16:50:32 +10:00
zdover23
68e0d99aa0
Merge pull request #54625 from zdover23/wip-doc-2023-11-23-rados-troubleshooting-mon-client-cant-connect
doc/rados: edit "client can't connect..."

Reviewed-by: Cole Mitchell <cole.mitchell.ceph@gmail.com>
2023-11-25 07:06:53 +10:00
Zac Dover
910e5efea1 doc/rados: format sections in tshooting-mon.rst
Format definition lists in the section "Do I need to restart a monitor
to adjust debug levels?" in
doc/rados/troubleshooting/troubleshooting-mon.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-23 21:54:54 +10:00
Zac Dover
ec298091b5 doc/rados: edit "client can't connect..."
Edit the section "Client can't connect or mount" in the file
doc/rados/troubleshooting/troubleshooting-mon.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-23 14:59:24 +10:00
Zac Dover
6ccb9f3ca1 doc/rados: edit "recovering broken monmap"
Edit the section "Recovering a monitor's broken monmap" in
doc/rados/troubleshooting/troubleshooting-mon.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-22 05:33:37 +10:00
zdover23
40f55c30e5
Merge pull request #54574 from zdover23/wip-doc-2023-11-21-rados-troubleshooting-mon-understanding-mon-status
doc/rados: edit "understanding mon_status"

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-11-21 04:42:49 +10:00
Zac Dover
08c16aa113 doc/rados: edit "understanding mon_status"
Edit the section "Understanding mon_status" in
doc/rados/troubleshooting/troubleshooting-mon.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-21 03:18:17 +10:00
Zac Dover
f627445806 doc/rados: edit "Using the Monitor's Admin Socket"
Edit the section "Using the Monitor's Admin Socket" in
doc/rados/troubleshooting/troubleshooting-mon.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-20 06:32:09 +10:00