RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-02-24 03:27:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: use ":confval:" role to reference options defined using confval

Browse Source 
Signed-off-by: Kefu Chai <kchai@redhat.com>
This commit is contained in:
Kefu Chai 2021-04-18 00:11:14 +08:00
parent a37f5a5eea
commit 02a15a81d8
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/_ext/ceph_confval.py
View File

@ -208,7 +208,7 @@ def setup(app) -> Dict[str, Any]:
app.add_directive('confval', CephOption)
app.add_object_type(
'confval_option',
'confval_option',
'confval',
objname='configuration value',
indextemplate='pair: %s; configuration value',
doc_field_types=[

8
doc/rados/configuration/msgr2.rst
View File

@ -78,16 +78,16 @@ Bind configuration options
Two new configuration options control whether the v1 and/or v2
protocol is used:
* ``ms_bind_msgr1`` [default: true] controls whether a daemon binds
* :confval:`ms_bind_msgr1` [default: true] controls whether a daemon binds
to a port speaking the v1 protocol
* ``ms_bind_msgr2`` [default: true] controls whether a daemon binds
* :confval:`ms_bind_msgr2` [default: true] controls whether a daemon binds
to a port speaking the v2 protocol
Similarly, two options control whether IPv4 and IPv6 addresses are used:
* ``ms_bind_ipv4`` [default: true] controls whether a daemon binds
* :confval:`ms_bind_ipv4` [default: true] controls whether a daemon binds
to an IPv4 address
* ``ms_bind_ipv6`` [default: false] controls whether a daemon binds
* :confval:`ms_bind_ipv6` [default: false] controls whether a daemon binds
to an IPv6 address
.. note:: The ability to bind to multiple ports has paved the way for

8
doc/rados/operations/health-checks.rst
View File

@ -68,7 +68,7 @@ order for monitor cluster to function properly.
MON_MSGR2_NOT_ENABLED
_____________________
The ``ms_bind_msgr2`` option is enabled but one or more monitors is
The :confval:`ms_bind_msgr2` option is enabled but one or more monitors is
not configured to bind to a v2 port in the cluster's monmap. This
means that features specific to the msgr2 protocol (e.g., encryption)
are not available on some or all connections.
@ -1141,9 +1141,9 @@ _______________
One or more PGs has not been scrubbed recently. PGs are normally scrubbed
within every configured interval specified by
:ref:`osd_scrub_max_interval <osd_scrub_max_interval>` globally. This
:confval:`osd_scrub_max_interval` globally. This
interval can be overriden on per-pool basis with
:ref:`scrub_max_interval <scrub_max_interval>`. The warning triggers when
:confval:`scrub_max_interval`. The warning triggers when
``mon_warn_pg_not_scrubbed_ratio`` percentage of interval has elapsed without a
scrub since it was due.
@ -1159,7 +1159,7 @@ PG_NOT_DEEP_SCRUBBED
____________________
One or more PGs has not been deep scrubbed recently. PGs are normally
scrubbed every ``osd_deep_scrub_interval`` seconds, and this warning
scrubbed every :confval:`osd_deep_scrub_interval` seconds, and this warning
triggers when ``mon_warn_pg_not_deep_scrubbed_ratio`` percentage of interval has elapsed
without a scrub since it was due.