Commit Graph

1472 Commits

Author SHA1 Message Date
Patrick Donnelly
3eb19650bb
doc: document debugging for libcephsqlite
Fixes: https://tracker.ceph.com/issues/57127
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-08-15 13:24:21 -04:00
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
Sridhar Seshasayee
e0b5316171 osd: Set initial mClock QoS params at CONF_DEFAULT level
Create the initial mClock QoS params at CONF_DEFAULT level using
set_val_default(). This allows switching to a custom profile on a
running OSD and to make necessary changes to the desired QoS params.
Note that Switching to ‘custom’ profile and then subsequently changing
the QoS params using “config set osd.n …” will be at a higher level i.e.
at CONF_MON.

But When switching back to a built-in profile, the new values won’t take
effect since CONF_DEFAULT < CONF_MON. For the values to take effect, the
config keys created as part of the ‘custom’ profile must be removed from
the ConfigMonitor store after switching back to a built-in profile.

- Added a couple of standalone tests to exercise the scenario.
- Updated the mClock configuration document and the mClock internal
  documentation with a couple of typos relating to the best effort weights.
- Added new sections to the mClock configuration document outlining the
  steps to switch between the built-in and custom profile and vice-versa.

Fixes: https://tracker.ceph.com/issues/55153
Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2022-07-06 16:15:58 +05:30
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
Josh Durgin
4e94f27cf5
Merge pull request #45284 from tobias-urdin/doc-memory-profiling-valgrind-massif
doc: Add alternative memory profiling to doc

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2022-06-16 15:17:53 -07:00
Anthony D'Atri
1a0e0cd4b6 doc/rados/configuration: clarify VMware note in bluestore-config-ref.rst
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-05-16 18:46:58 -07:00
Anthony D'Atri
7a2a565101 doc/rados/configuration: Enhance BlueStore min_alloc_size section
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-05-15 14:50:47 -07:00
Ziye Yang
27b7ccacd4 blk/spdk: Add the support to use nvme device provided by NVMe-of Target
This patch is used to add the support to use the nvmedevice provided
by NVMe-oF target.

Signed-off-by: Ziye Yang <ziye.yang@intel.com>
2022-05-15 09:15:40 +08: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
Anthony D'Atri
ec56816c80
Merge pull request #46102 from bluikko/ioctx_get_stats_docs
doc/rados/api: fix invalid RST syntax and don't sudo for vim
2022-05-02 00:11:14 -07:00
Ville Ojamo
04b8cf09b3 doc/rados/api: fix invalid RST syntax and don't sudo for vim
Fix invalid syntax where "linenos:" was printed in the
final rendered documentation instead of being used as
formatting syntax.

There is no need to use sudo for editing a source file
so run vim without sudo.

Change the whole block to use bash prompt since it is
a command.

Also modify the preceding text to hopefully not bold it.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2022-05-02 11:50:52 +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
Gregory Farnum
6536d0c1af
Merge pull request #44151 from gregsfortytwo/wip-cidr-blocklist
Implement CIDR blocklisting

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2022-04-21 08:31:16 -07:00
Ziye Yang
86cb8c75c3 Add the support to use DML library for PMEM device.
The purpose of this patch is to add the initial support to
offload memory/pmem operations by sync usage through hardware path
in DML library.

Signed-off-by: Ziye Yang <ziye.yang@intel.com>
2022-04-19 14:51:12 +08:00
Ernesto Puerta
a2de0b20e7
Merge pull request #45083 from ceph/epuertat-patch-4
doc: fix config option links

Reviewed-by: anthonyeleven <NOT@FOUND>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2022-04-13 10:37:01 +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
Anthony D'Atri
fadcbbefb8 doc/rados/configuration: document min_alloc_size values and space amplification
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-04-10 03:27:34 -07:00
Kefu Chai
e1a7985ea6
Merge pull request #45743 from m-ildefons/docs-python3-librados
docs: update install steps for python librados

Reviewed-by: Kefu Chai <tchaikov@gmail.com>
2022-04-05 13:36:38 +08: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
Moritz Röhrich
dad15f2dfd
docs: update install steps for python librados
- Put the correct package names for python librados in the install
  instructions.
- librados-devel does not actually pull in python3-librados as
  dependency anymore, remove mention of this.
- Add instructions for openSUSE/SLE

Signed-off-by: Moritz Röhrich <moritz.rohrich@suse.com>
2022-04-01 10:49:20 +02:00
Sridhar Seshasayee
afe3a7543c doc: Improvements to mClock configuration reference documentation
Improve the documentation around.
 - mclock client types.
 - Describe in greater detail about mclock config profiles.
 - Add notes about manually benchmarking OSDs and tuning bluestore throttle
   parameters.
 - Include a couple of missing mclock configuration options.

Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2022-03-24 15:12:13 +05:30
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
Tobias Urdin
0b6cbf303c doc: Add alternative memory profiling to doc
This adds documentation about alternative
memory profiling options for services such
as RadosGW using the Massif heap memory profiler
with Valgrind.

That was used to produce output like served
in the bug report [1]

[1] https://tracker.ceph.com/issues/54482

Signed-off-by: Tobias Urdin <tobias.urdin@binero.com>
2022-03-07 19:57:47 +00:00
Ilya Dryomov
33b16fd04d doc: document "ceph config get <who> <option>"
... and note the confusing asymmetry with "ceph config set <who>
<option> <value>".

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2022-03-02 14:17:31 +01:00
Ernesto Puerta
a5e71ae163
doc: fix config option links
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2022-02-21 17:08:02 +01: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
Melissa
e6e0344981
doc/cephadm: deployment scenarios single host and isolated environment
This PR adds a deployment scenarios section to the cephadm docs to document the single-host-defaults flag, and explain how to deploy in an isolated environment.

Signed-off-by: Melissa Li <melissali@redhat.com>
2021-11-24 15:02:37 +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
Jos Collin
722f95e7ff
doc: update dev list and kernel client
Signed-off-by: Jos Collin <jcollin@redhat.com>
2021-11-09 16:38:12 +05:30
Zac Dover
73da90ce27 doc/rados: storage-devices.rst rewrite
This commit is a minor improvement to the
English syntax of storage-devices.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-10-28 00:07:21 +10:00