From: Kefu Chai Date: Sun, 18 Apr 2021 00:17:31 +0000 (+0800) Subject: doc/rados/configuration: merge ms-ref into network-conf-ref X-Git-Tag: v17.1.0~2202^2~4 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=3767e0cb1650a00988aa29ec2f37bd29d764a390;p=ceph.git doc/rados/configuration: merge ms-ref into network-conf-ref the latter provides more context, and "messenger" is how the networking infra is implemented. Signed-off-by: Kefu Chai --- diff --git a/doc/rados/configuration/index.rst b/doc/rados/configuration/index.rst index 327259374abaf..871f12afaab3c 100644 --- a/doc/rados/configuration/index.rst +++ b/doc/rados/configuration/index.rst @@ -44,7 +44,6 @@ To optimize the performance of your cluster, refer to the following: FileStore Settings Journal Settings Pool, PG & CRUSH Settings - Messaging Settings General Settings diff --git a/doc/rados/configuration/ms-ref.rst b/doc/rados/configuration/ms-ref.rst deleted file mode 100644 index dfb5d559faf1c..0000000000000 --- a/doc/rados/configuration/ms-ref.rst +++ /dev/null @@ -1,85 +0,0 @@ -=========== - Messaging -=========== - -General Settings -================ - -``ms_tcp_nodelay`` - -:Description: Disables Nagle's algorithm on messenger TCP sessions. -:Type: Boolean -:Required: No -:Default: ``true`` - - -``ms_initial_backoff`` - -:Description: The initial time to wait before reconnecting on a fault. -:Type: Double -:Required: No -:Default: ``.2`` - - -``ms_max_backoff`` - -:Description: The maximum time to wait before reconnecting on a fault. -:Type: Double -:Required: No -:Default: ``15.0`` - - -``ms_die_on_bad_msg`` - -:Description: Debug option; do not configure. -:Type: Boolean -:Required: No -:Default: ``false`` - - -``ms_dispatch_throttle_bytes`` - -:Description: Throttles total size of messages waiting to be dispatched. -:Type: 64-bit Unsigned Integer -:Required: No -:Default: ``100 << 20`` - - -``ms_bind_ipv6`` - -:Description: Enable to bind daemons to IPv6 addresses instead of IPv4. Not required if you specify a daemon or cluster IP. -:Type: Boolean -:Required: No -:Default: ``false`` - - -``ms_inject_socket_failures`` - -:Description: Debug option; do not configure. -:Type: 64-bit Unsigned Integer -:Required: No -:Default: ``0`` - -Async messenger options -======================= - - -``ms_async_transport_type`` - -:Description: Transport type used by Async Messenger. Can be ``posix``, ``dpdk`` - or ``rdma``. Posix uses standard TCP/IP networking and is default. - Other transports may be experimental and support may be limited. -:Type: String -:Required: No -:Default: ``posix`` - - -``ms_async_op_threads`` - -:Description: Initial number of worker threads used by each Async Messenger instance. - Should be at least equal to highest number of replicas, but you can - decrease it if you are low on CPU core count and/or you host a lot of - OSDs on single server. -:Type: 64-bit Unsigned Integer -:Required: No -:Default: ``3`` diff --git a/doc/rados/configuration/network-config-ref.rst b/doc/rados/configuration/network-config-ref.rst index a0ef8c3b47dc4..6a353c9a08c4a 100644 --- a/doc/rados/configuration/network-config-ref.rst +++ b/doc/rados/configuration/network-config-ref.rst @@ -326,6 +326,18 @@ Ceph disables TCP buffering by default. .. confval:: ms_tcp_nodelay .. confval:: ms_tcp_rcvbuf +General Settings +---------------- + +.. confval:: ms_type +.. confval:: ms_async_op_threads +.. confval:: ms_initial_backoff +.. confval:: ms_max_backoff +.. confval:: ms_die_on_bad_msg +.. confval:: ms_dispatch_throttle_bytes +.. confval:: ms_inject_socket_failures + + .. _Scalability and High Availability: ../../../architecture#scalability-and-high-availability .. _Hardware Recommendations - Networks: ../../../start/hardware-recommendations#networks .. _hardware recommendations: ../../../start/hardware-recommendations diff --git a/src/common/options/global.yaml.in b/src/common/options/global.yaml.in index 29d1b36100673..8f72aea0f7006 100644 --- a/src/common/options/global.yaml.in +++ b/src/common/options/global.yaml.in @@ -945,6 +945,9 @@ options: type: str level: advanced desc: Messenger implementation to use for network communication + fmt_desc: Transport type used by Async Messenger. Can be ``async+posix``, + ``async+dpdk`` or ``async+rdma``. Posix uses standard TCP/IP networking and is + default. Other transports may be experimental and support may be limited. default: async+posix flags: - startup @@ -1077,12 +1080,14 @@ options: type: float level: advanced desc: Initial backoff after a network error is detected (seconds) + fmt_desc: The initial time to wait before reconnecting on a fault. default: 0.2 with_legacy: true - name: ms_max_backoff type: float level: advanced desc: Maximum backoff after a network error before retrying (seconds) + fmt_desc: The maximum time to wait before reconnecting on a fault. default: 15 see_also: - ms_initial_backoff @@ -1103,6 +1108,7 @@ options: type: bool level: dev desc: Induce a daemon crash/exit when a bad network message is received + fmt_desc: Debug option; do not configure. default: false with_legacy: true - name: ms_die_on_unhandled_msg @@ -1133,6 +1139,7 @@ options: type: size level: advanced desc: Limit messages that are read off the network but still being processed + fmt_desc: Throttles total size of messages waiting to be dispatched. default: 100_M with_legacy: true - name: ms_bind_exclude_lo_iface @@ -1244,6 +1251,7 @@ options: type: uint level: dev desc: Inject a socket failure every Nth socket operation + fmt_desc: Debug option; do not configure. default: 0 with_legacy: true - name: ms_inject_delay_type @@ -1312,6 +1320,10 @@ options: type: uint level: advanced desc: Threadpool size for AsyncMessenger (ms_type=async) + fmt_desc: Initial number of worker threads used by each Async Messenger instance. + Should be at least equal to highest number of replicas, but you can + decrease it if you are low on CPU core count and/or you host a lot of + OSDs on single server. default: 3 min: 1 max: 24