Commit Graph

695 Commits

Author SHA1 Message Date
Zac Dover
69d62c05ef doc/rados/operations: add prompts to operating.rst
This commit adds ".. prompt:: bash $"-style prompts to operating.rst.
This brings this file up to the standard established in 2020 when
Kefu added support for the ".. prompt::" directive.

This commit is a part of an initiative to modernize the presentation
of all BASH commands in the RADOS documentation.

The progress of this project can be tracked here:
https://tracker.ceph.com/issues/57108

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-08-14 09:14:56 +10:00
Kefu Chai
bda173fc09
Merge pull request #46242 from kamoltat/wip-ksirivad-fix-overlapping-message
pybind/mgr/pg_autoscaler: change overlapping roots to warning

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2022-08-10 00:15:28 +08:00
Kamoltat
e8490dae9f pybind/mgr/pg_autoscaler: change overlapping roots to warning
Change the log level of overlapping roots
from ``Error`` to ``Warning``.

Point the user to documentation that
explains the overlapping roots.

Added more information regarding overlapping roots
in the autoscaler documentation such as
the step to get rid of the warning.

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

Signed-off-by: Kamoltat <ksirivad@redhat.com>
2022-07-25 14:17:03 +00:00
Anthony D'Atri
3833372791 doc/radosgw/operations: Document how to fix empty autoscale-status output
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-07-24 20:54:56 -07:00
Josh Soref
8abce157f1 doc: Fix many spelling errors
* administrators
* allocated
* allowed
* approximate
* authenticate
* availability
* average
* behavior
* binaries
* bootstrap
* bootstrapping
* capacity
* cephadm
* clients
* combining
* command
* committed
* comparison
* compiled
* consequences
* continues
* convenience
* cookie
* crypto
* dashboard
* deduplication
* defaults
* delivered
* deployment
* describe
* directory
* documentation
* dynamic
* elimination
* entries
* expectancy
* explicit
* explicitly
* exporter
* github
* hard
* healthcheck
* heartbeat
* heavily
* http
* indices
* infrastructure
* inherit
* layout
* lexically
* likelihood
* logarithmic
* manually
* metadata
* minimization
* minimize
* object
* of
* operation
* opportunities
* overwrite
* prioritized
* recipe
* records
* requirements
* restructured
* running
* scalability
* second
* select
* significant
* specify
* subscription
* supported
* synonym
* throttle
* unpinning
* upgraded
* value
* version
* which
* with

Plus some line wrapping and additional edits...

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2022-07-02 23:38:18 -04:00
Eneko Lacunza
42c3018cfb doc/rados/operations: Add missing required parameters to stretch-mode CRUSH rule example
Rule example is missing min_size and max_size, both are required.

Signed-off-by: Eneko Lacunza <elacunza@binovo.es>
2022-05-06 09:31:27 +02:00
zdover23
42dd40365b
Merge pull request #46109 from bluikko/pgcalc_links
doc/rados: fix pgcalc links

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2022-05-03 08:39:12 +10:00
Ville Ojamo
45f8d746ac doc/rados/operations: fix pgcalc link
The pgcalc tool has moved to the "old" ceph site so update
the link to avoid a 404.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2022-05-02 15:59:26 +07:00
Ilya Dryomov
29941e306f
Merge pull request #45887 from bluikko/patch-3
doc: replace spaces with underscores in config option names

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2022-04-23 10:53:31 +02:00
Ville Ojamo
fb5981efb8 doc: remove spaces at line ends and doubles, fix wrapping
Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2022-04-23 09:35:28 +02: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
Greg Farnum
e15cfa7ecd doc: update blocklist doc for ranges and up-to-date-ness
Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2022-04-13 00:14:16 +00:00
Ilya Dryomov
1ab943cabb doc,test: clean up crush rule min/max_size leftovers
These fields were removed in quincy in commit f95eb04411 ("crush:
eliminate min_size and max_size").

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2022-04-01 14:00:13 +02:00
Kamoltat
7f1c7637e2 doc/rados/operations/placement-groups: typo two 'the'
typo, should not have two 'the' next to each
other.

Signed-off-by: Kamoltat <ksirivad@redhat.com>
2022-03-09 15:36:20 +00:00
Kamoltat
4a01fc7798 doc/rados/operations/placement-groups: fix --bulk commands
Some parts of the documents regarding
the bulk flag  have typos.

Command for creating a pool

was: `ceph osd create test_pool --bulk`

should be: `ceph osd pool create test_pool --bulk`

Command for setting bulk value in a pool

was: `ceph osd pool set test_pool bulk=<true/false/1/0>`

should be: `ceph osd pool set test_pool bulk <true/false/1/0>`

Also removed a bit of trailing white spaces.

Changed `complements` to `complement`.

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

Signed-off-by: Kamoltat <ksirivad@redhat.com>
2022-03-09 04:27:33 +00:00
Franciszek Stachura
f841def599 doc: Fix links to CRUSH, RADOS and DSP research papers.
Signed-off-by: Franciszek Stachura <fbstachura@gmail.com>
2022-01-30 17:23:33 +01:00
Zac Dover
04bb8ae5e4 doc/rados: update broken pdf link
This PR repairs a link to a PDF. The link was broken
when the PDF assets were moved during the restructure
of the ceph.io website in 2021.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-01-20 11:01:42 +10:00
Yuri Weinstein
a8bb49d4d9
Merge pull request #39440 from pdvian/wip-warn-filestore-osds
mon/OSDMonitor, osd: Add warning on filestore deprecation and force use of wpq scheduler for filestore OSDs

Reviewed-by: Neha Ojha <nojha@redhat.com>
2022-01-12 08:49:02 -08:00
Sage Weil
d2265e81fb Merge PR #44054 into master
* refs/pull/44054/head:
	doc/rados/operations: document pg_num_max
	mgr: set max of 32 pgs for .mgr pool
	mgr/dashboard: expect pg_num_max property for pools
	mon/OSDMonitor: add option --pg-num_max arg for create pool
	mon/OSDMonitor: disallow setting pg_num < min or > max
	mgr/pg_autoscaler: apply pg_num_max
	mon: add pg_num_max pool property

Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2022-01-06 08:54:45 -05:00
Prashant D
658dbf4528 doc/rados/operations: Document health check OSD_FILESTORE
Signed-off-by: Prashant D <pdhange@redhat.com>
2022-01-05 10:08:25 +00:00
Sage Weil
7ae62167e3 doc/rados/operations: document pg_num_max
Signed-off-by: Sage Weil <sage@newdream.net>
2022-01-03 14:12:54 -05:00
Kamoltat
9baed0394e docs: Added noautoscale to docs + release notes
Updated the docs in
https://docs.ceph.com/en/latest/rados/operations/placement-groups/
and updated the release notes to reflect noautoscale flag.

Signed-off-by: Kamoltat <ksirivad@redhat.com>
2021-12-22 21:42:52 +00:00
Kamoltat
abaab51dd8 Added ReleasesNotes and documentation
Add Release Notes and remove any `profile`
related stuff in the autoscaler documentation
and replace it with `bulk` flag.

Signed-off-by: Kamoltat <ksirivad@redhat.com>
2021-12-21 07:56:37 +00:00
Kamoltat
5f0f967c93 mon: osd pool create <pool-name> with --bulk flag
Creating the pool with `--bulk` will allow
the pg_autoscaler to use the `scale-down`
mode on.

Creating pool:

`ceph osd pool create <pool-name> --bulk`

Get var:

`ceph osd pool get <pool-name> bulk`

Set var:

`ceph osd pool set <pool-name> bulk=true/false/1/0`

Removed `autoscale_profile` and incorporate bulk flag
into calculating `final_pg_target` for each pool.

bin/ceph osd pool autoscale-status no longer has
`PROFILE` column but has `BULK` instead.

Signed-off-by: Kamoltat <ksirivad@redhat.com>
2021-12-20 21:46:37 +00:00
Neha Ojha
fc8797cd4f
Merge pull request #44280 from chrisphoffman/warn_pg
mon: Omit MANY_OBJECTS_PER_PG warning when autoscaler is on

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-12-16 08:33:13 -08:00
Dimitri Papadopoulos
7677651618
doc,man: typos found by codespell
Signed-off-by: Dimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
2021-12-15 12:04:36 +01:00
Christopher Hoffman
6c51b1fc9b doc/rados/operations: Updated rados docs to include
changes to health-checks in MANY_OBJECTS_PER_PG
warning when autoscale is on.

Signed-off-by: Christopher Hoffman <choffman@redhat.com>
2021-12-13 22:02:10 +00:00
Sebastian Wagner
ee7ed53df8
doc/cephadm: host location: add link to types
Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-11-25 15:52:20 +01:00
Kamoltat
a9f9f7b3fd pybind/mgr/pg_autoscale: revert to default profile scale-up
pg_autoscale module will now start out all the pools
with a scale-up profile by default.

Added tests in workunits/mon/pg_autoscaler.sh
to evaluate if the default pool creation is
a scale-up profile

Updated documentation and release notes to
reflect the change in the default behavior
of the pg_autoscale profile.

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

Signed-off-by: Kamoltat <ksirivad@redhat.com>
2021-11-19 18:55:36 +00:00
Gregory Farnum
251b6e243d
Merge pull request #43373 from gregsfortytwo/wip-mon-stretch-new-tiebreaker-52126
mon: Allow specifying new tiebreaker monitors

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-10-07 15:16:23 -07:00
Greg Farnum
37d3aee4a9 doc: update stretch mode documentation for new commands
Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2021-10-05 00:01:02 +00:00
Anthony D'Atri
2a181ef933 ceph: add example BlueStore migration via the ceph-objectstore-tool dup operation
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2021-09-22 18:01:33 -07:00
Anthony D'Atri
4396cb9411 doc: clarify stale_read and placement-groups wording
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2021-09-16 16:40:33 -07:00
Sebastian Wagner
d9ec8eb7a8
doc/cephadm: Add lots of links to other chapters
Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-09-11 20:04:14 +02:00
wangxinyu
a59059b87f doc: fix typos
Signed-off-by: wangxinyu <wangxinyu@inspur.com>
2021-09-05 10:19:47 +08:00
Kamoltat Sirivadhna
aeca18d479
Merge pull request #42741 from sosodev/master
mgr/pg_autoscaler: add threshold module option
2021-08-26 13:13:02 -04:00
Gregory Farnum
02bda6d799
Merge pull request #41335 from noonedeadpunk/doc/stretch_mon
doc/rados/operations/stretch-mode: Adjust description of mon.e placement

Reviewed-by: Greg Farnum <gfarnum@redhat.com>
2021-08-23 16:13:54 -07:00
Kyle
a84e4dfd63 Add CLI command to set threshold
Signed-off-by: Kyle McGough <kmcgough@digitalocean.com>
2021-08-12 10:49:38 -07:00
Kyle
0f6184fc3d mgr/pg_autoscaler: add threshold module option
Signed-off-by: Kyle McGough <kmcgough@digitalocean.com>
2021-08-10 15:43:52 -07:00
Kamoltat
65fec053e0 doc/rados/operations/placement-groups: added bias + profile
Added documentations on the autoscale profile and bias

Signed-off-by: Kamoltat <ksirivad@redhat.com>
2021-08-09 13:59:17 +00:00
Deepika Upadhyay
ba52429897 doc/rados/op: ceph/df show DIRTY field N/A
DIRTY field should only be available if cache tiering is in use.

Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-07-27 07:06:29 +05:30
Sage Weil
f95eb04411 crush: eliminate min_size and max_size
We don't use min/max_size for anything any more.  Switch to encoding it
universally as 1 and 100, and ignoring when we decode.  We keep it around
for backward compat when (re)encoding without the SERVER_QUINCY feature.

Drop the crush_rule_mask struct since the only variable piece now is the
type.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-06-28 18:34:31 -04:00
Sage Weil
8976fcf476 doc: scrub 'ruleset' from docs
Signed-off-by: Sage Weil <sage@newdream.net>
2021-06-28 18:34:31 -04:00
Kefu Chai
29064f1bf8
Merge pull request #41937 from liewegas/mgr-crash
mgr: generate crash dumps for Python exceptions in mgr modules

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-06-26 22:18:14 +08:00
Anthony D'Atri
d6b4734716 doc/rados/operations: Updates pools.rst
Add clarity, change example PG counts to a power of two.

Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2021-06-23 10:30:37 -07:00
Sage Weil
24ac3088b6 mgr/crash: separate RECENT_MGR_MODULE_CRASH error for mgr module crashes
Generate a different warning for crashes in mgr module python code, as
they do not mean that the entire mgr daemon crashed.  Document.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-06-23 13:00:49 -04:00
Patrick Donnelly
f5fa58cb1f
doc: document new .mgr pool
And that pool names beginning with `.` are reserved names.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-06-11 19:35:17 -07:00
Sridhar Seshasayee
76420f9d59 doc: Update mclock-config-ref to reflect automated OSD benchmarking
Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2021-06-03 14:45:21 +05:30
luo.runbing
d9315c88d5
doc: add missing crush-device-class={device-class} pair for clay code profile
`crush-device-class` is optional for `ceph osd erasure-code-profile set`,
add it for the sake of completeness

Signed-off-by: luo.runbing <luo.runbing@zte.com.cn>
2021-05-26 11:14:38 +08:00
Dmitriy Rabotyagov
ef90c16239 doc/rados/operations/stretch-mode: Adjust description of mon.e placement
From current state of the documentation it is not clear about where in
tree mon.e should be located. This may raise questions from operators[1]

Also remove trailing whitespaces from doc.

[1] https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/XWI5VNTMPA2JZEE7VCEQT4ACWVVKKOPQ/

Signed-off-by: Dmitriy Rabotyagov <noonedeadpunk@ya.ru>
2021-05-14 10:24:46 +03:00