Commit Graph

8110 Commits

Author SHA1 Message Date
mflehmig
00225dc531 doc/rados: Fix typo
Signed-off-by: Martin Flehmig <martin.flehmig@tu-dresden.de>
2021-05-17 14:42:12 +08:00
Neha Ojha
dda7820218
Merge pull request #41317 from neha-ojha/wip-commandwq-cleanup
common/options/global.yaml.in: remove osd_command_thread* timeouts

Reviewed-by: Sage Weil <sage@redhat.com>
2021-05-13 18:42:57 -07:00
David Galloway
268a826b5a doc: 15.2.12 Release Notes
Signed-off-by: David Galloway <dgallowa@redhat.com>
2021-05-13 17:28:27 -05:00
David Galloway
df85829df0 doc: 14.2.21 Release Notes
Signed-off-by: David Galloway <dgallowa@redhat.com>
2021-05-13 17:28:23 -05:00
Sage Weil
6edb1e9cf9 doc/security: summarize CVEs
Signed-off-by: Sage Weil <sage@newdream.net>
2021-05-13 17:20:55 -05:00
David Galloway
59fc89a1a3 doc: 16.2.4 Release Notes
Signed-off-by: David Galloway <dgallowa@redhat.com>
2021-05-13 15:03:57 -04:00
zdover23
3b787771ec
Merge pull request #41305 from zdover23/wip-doc-cephadm-monitoring-disabling-monitoring-2021-05-12
doc/cephadm: rewrite "disabling monitoring"

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-05-14 00:23:57 +10:00
Sage Weil
beb57679c6 Merge PR #39550 into master
* refs/pull/39550/head:
	mgr/cephadm: induce retune of osd memory on osd creation
	qa/tasks/cephadm.conf: autotune osd memory by default
	mgr/cephadm: do not autotune when _no_autotune_memory label is present
	mgr/cephadm: autotune osd memory
	common: add osd_memory_target_autotune
	mgr/cephadm: report memory usage, request (limit) in 'orch ps'
	doc/cephadm/host-management: document _admin group
	mgr/orchestrator: fix help formatting

Reviewed-by: Adam King <adking@redhat.com>
2021-05-13 09:57:14 -04:00
Yuval Lifshitz
fafe4ac06b
Merge pull request #40608 from tschoonj/etag-spelling
rgw: fix spelling of eTag in S3 message structure
2021-05-13 08:46:42 +03:00
Kefu Chai
ecc332248b
Merge pull request #41245 from tchaikov/wip-doc-confval-ext
doc/_ext: fixes related to mgr option rendering

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-05-13 09:21:51 +08:00
Neha Ojha
859d11fe4e doc/rados/configuration/osd-config-ref: remove osd_command_thread_timeout
Signed-off-by: Neha Ojha <nojha@redhat.com>
2021-05-12 19:59:39 +00:00
Sage Weil
1e4d20a592 mgr/cephadm: do not autotune when _no_autotune_memory label is present
Signed-off-by: Sage Weil <sage@newdream.net>
2021-05-12 11:02:34 -04:00
Sage Weil
85ea078787 mgr/cephadm: autotune osd memory
- set osd_memory_target_autotune=true to enable
- tuning is periodic (check every 10m by default)
- tuned values are reflected by osd_memory_target config options scoped
  to the host
- only make a change if it appears that we will affect at least 1 of the
  relevant OSDs
- attempt to clean out conflicting options.  (This is imperfect, since any
  manner of weirdly-scoped config options could be responsible; we only
  attempt to clean out one scoped directly to the osd name.)

Signed-off-by: Sage Weil <sage@newdream.net>
2021-05-12 11:02:34 -04:00
Sage Weil
eb3c38577a doc/cephadm/host-management: document _admin group
Signed-off-by: Sage Weil <sage@newdream.net>
2021-05-12 11:01:23 -04:00
Zac Dover
b67b6112ac doc/cephadm: rewrite "disabling monitoring"
* Simplified the text.
* Correctly formatted the prompts.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-05-12 22:54:54 +10:00
Ilya Dryomov
e78e41c7f4
Merge pull request #41256 from tchaikov/wip-doc-rbd-confval
doc/rbd/rbd-config-ref: use confval directive to define options

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2021-05-11 22:28:46 +02:00
Kefu Chai
8ff85103cb
Merge pull request #41276 from tchaikov/wip-docs-responsive-button
doc/_theme: show the menu button

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2021-05-11 20:57:49 +08:00
zdover23
36afbb8e2f
Merge pull request #41265 from zdover23/wip-doc-config-ssl-tls-for-grafana-2021-05-11
doc/cephadm: rewrite "config ssl/tls f. grafana"

Reviewed-by: Sebastian Wagner <sewagner@redhat.com>
2021-05-11 22:52:14 +10:00
Ilya Dryomov
d4579e1dca
Merge pull request #41194 from idryomov/wip-rbd-pwl-status
rbd: don't attempt to interpret image cache state json

Reviewed-by: Yin Congmin <congmin.yin@intel.com>
Reviewed-by: Mahati Chamarthy <mahati.chamarthy@intel.com>
2021-05-11 13:05:11 +02:00
Kefu Chai
58713ea61e doc/_theme: show the menu button
because we have a top-nav bar, which is setting on top of the bar
containing the menu button when the docs is displayed wit a device with
smaller width. in this change, the container of the menu button is moved
down a little bit, so it is visible again.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 17:57:47 +08:00
Kefu Chai
f2750a7912 doc/mgr/prometheus: use confval directive to define options
less repeating this way.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 16:05:04 +08:00
Kefu Chai
80eb4f42fb doc/_ext: print "default" using "literal" filter
there is chance that the default value of an option is empty, before
this change the rendered result would be "````", and sphinx is confused
at seeing this:

Unexpected section title or transition.

as it takes it as a notion of section title. after this change,
the "literal" filter is always applied to the default value, so an empty
string is rendered like "<empty string>" instead.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 16:05:04 +08:00
Kefu Chai
44e611ce30 doc/_ext: define a helper for current_module()
less repeating this way, this change also addresses the missing option
issue if the option to be rendered is the first option in a document,
and there is no "mgr_module" directive before it.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 16:05:04 +08:00
Kefu Chai
f948b5acf7 doc/_ext: do not require "mgr_module" at end of document
before this change,

.. mgr_module:: None

is required at end of a mgr module document to reset the context, so
the builder env is not polluted when processing the next document.

after this change, this ending directive is not needed anymore.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 15:43:59 +08:00
Kefu Chai
8c4c5eb8e1 doc/_ext: do not load all modules for a certain module
instead of collecting all options from all modules, just load the
options from the specified module, this addresses the issue where
options with the same name are overriden by the options defined by
another mgr module.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 15:43:59 +08:00
Kefu Chai
c1d6fc0f5d doc/_ext: add "module" option to confval
in addition to "mgr_module" directive, add the "module" option to
confval. this allows a certain option to specify its own module without
being nested in a "mgr_module" directive pair.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 15:43:59 +08:00
Kefu Chai
1c9aef07fc doc/_ext: use str for mgr module options by default
sometimes, they don't specify the option type and just default to "str".

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 15:43:59 +08:00
Kefu Chai
73dfb8d5a8 doc/_ext: compose name using cur_module and option name
so a mgr option can be referenced using
`mgr/<module_name>/<option_name>`.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 15:43:59 +08:00
Kefu Chai
cc43462ab3 doc/rados/operations: s/max_misplaced/target_max_misplaced_ratio/
max_misplaced with replaced by in target_max_misplaced_ratio
edbd592ee4, but the document was not
sync'ed. let's update it accordingly.

Fixes: https://tracker.ceph.com/issues/50745
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 12:23:02 +08:00
Kefu Chai
4a4c2fe8c8
Merge pull request #41207 from paulreece42/wip-doc-balancer-options
doc: added doc on more throttling options for the PG balancer module

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-05-11 12:04:49 +08:00
Kefu Chai
50c15dd7f0 doc/rbd/rbd-config-ref: use confval directive to define options
less repeating this way.

also fix a typo of "rbd_qos_writ_bps_limit", it should be
"rbd_qos_write_bps_limit".

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 10:14:46 +08:00
Zac Dover
b9554b0840 doc/cephadm: rewrite "config ssl/tls f. grafana"
This PR streamlines the grammar in the subsection
called "Configuring SSL/TLS for Grafana" in the
monitoring.rst file. It also corrects the prompt
rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-05-11 09:19:10 +10:00
Kefu Chai
f84504464a doc/_ext: render constraint and policies if available
they are used by rbd options.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-10 20:57:00 +08:00
Tom Schoonjans
893ce6b64a rgw: remove s3: prefix in eventName value of s3 event message structure
This change is necessary to match the event message structure seen on
AWS.

Signed-off-by: Tom Schoonjans <Tom.Schoonjans@rfi.ac.uk>
2021-05-08 06:30:02 +00:00
Sage Weil
7934141f69 Merge PR #41201 into master
* refs/pull/41201/head:
	doc/releases: 16.2.3

Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: David Galloway <dgallowa@redhat.com>
2021-05-06 16:55:16 -04:00
Sage Weil
b11226d3ee doc/releases: 16.2.3
Signed-off-by: Sage Weil <sage@newdream.net>
2021-05-06 15:00:36 -05:00
Paul Reece
eafa979b79 doc: added documentation on additional throttling options for the PG balancer module
Signed-off-by: Paul Reece <paul@reece.cc>
2021-05-06 14:09:34 -04:00
Kefu Chai
34a6edde49
Merge pull request #41198 from tchaikov/wip-doc-mgr-options
doc/_ext: load options defined by mgr modules

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-05-07 00:33:16 +08:00
Sage Weil
0b0705cdf5 Merge PR #41163 into master
* refs/pull/41163/head:
	doc/releases/releases.yml: add 16.2.2
	doc/releases/pacific: note cepahdm ingress+rgw support
	doc: 16.2.2 Release Notes

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Sage Weil <sage@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-05-06 11:24:38 -04:00
Kefu Chai
e6254a9dcb doc/_ext: rewrite directive using ObjectDescription
which allows us to use different scheme when defining an option,

without this change, if two options in different mgr module share the
same name we cannot differentiate them, after this change, their id
would prefixed with the module name.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 22:21:43 +08:00
Kefu Chai
bb351842bc doc/rados/configuration/general-config-ref: use describe to define non-options
max_open_files is not generated from yaml files, so define it using
"describe" directive instead.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 22:21:43 +08:00
Kefu Chai
98dc0d4e85 doc/_ext: load options defined by mgr modules
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 20:54:42 +08:00
Sebastian Wagner
f454a77d5e
Merge pull request #41186 from zdover23/wip-doc-cephadm-upgrade-starting-the-upgrade-2021-05-06
doc/cephadm: rewriting "starting the upgrade"

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-05-06 13:18:09 +02:00
Sebastian Wagner
01d3646271
Merge pull request #41187 from zdover23/wip-doc-cephadm-upgrade-monitoring-the-upgrade-2021-05-06
doc/cephadm: rewrite "monitoring the upgrade"

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-05-06 13:17:21 +02:00
Sebastian Wagner
e3b62e198f
Merge pull request #41188 from zdover23/wip-doc-cephadm-upgrade-cancelling-the-upgrade-2021-05-06
doc/cephadm: rewrite "cancelling the upgrade"

Reviewed-by: Sebastian Wagner <sewagner@redhat.com>
2021-05-06 13:16:04 +02:00
Sebastian Wagner
1fa93135a4
Merge pull request #41189 from zdover23/wip-doc-cephadm-upgrade-potential-problems-2021-05-06
doc/cephadm: rewrite "potential problems"

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-05-06 13:15:27 +02:00
Ilya Dryomov
797709ebb1 doc/rbd/rbd-persistent-write-back-cache: clarify some config settings
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-05-06 11:20:23 +02:00
Ilya Dryomov
a227abfb36 doc/rbd/rbd-persistent-write-back-cache: update "Cache Status" section
Amend the example output and drop the word "transient" -- currently it
is the exact opposite, as the status is updated only when the cache is
opened and closed.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2021-05-06 11:20:23 +02:00
Kefu Chai
ed79c4f74a doc/mgr/modules: should use Option class for defining options
it is the encouraged way to define options nowadays.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 11:57:30 +08:00
Zac Dover
630f0c8ad3 doc/cephadm: rewrite "using customized con..."
This PR rewrites the text in "Using Customized
Container Images" so that it is just a bit
clearer, and it also formats the prompt in the
text correctly.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-05-06 10:54:24 +10:00