doc/nvmf: Update nvmf_create_transport example

Some users refer to this document as an example of
"gold" RDMA configuration. But some parameters of
RDMA transport are not optimal for good performance,
e.g. `-c 0` disables in-capsule data, that reduces
IOPS of write operations with small payload; `-m 4`
allows to have only 4 qpairs per controller, that
doesn't allow to have more than 4 IO qpairs.
This patch sets several parameters which are default
for RDMA.

Signed-off-by: Alexey Marchuk <alexeymar@mellanox.com>
Reported-by: Mike Gerdts <mgerdts@nvidia.com>
Change-Id: I118bb032eaf7f38e981d06ee312b36c7f0c8322a
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/11454
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
This commit is contained in:
Alexey Marchuk 2022-02-08 18:16:19 +03:00 committed by Tomasz Zawadzki
parent 84bec316c2
commit adde7ea533

View File

@ -152,13 +152,13 @@ working with NVMe over Fabrics specific RPCs can be found on the @ref jsonrpc_co
Start the nvmf_tgt application with elevated privileges. Once the target is started, Start the nvmf_tgt application with elevated privileges. Once the target is started,
the nvmf_create_transport rpc can be used to initialize a given transport. Below is an the nvmf_create_transport rpc can be used to initialize a given transport. Below is an
example where the target is started and configured with two different transports. example where the target is started and configured with two different transports.
The RDMA transport is configured with an I/O unit size of 8192 bytes, 4 max qpairs per controller, The RDMA transport is configured with an I/O unit size of 8192 bytes, max I/O size 131072 and an
and an in capsule data size of 0 bytes. The TCP transport is configured with an I/O unit size of in capsule data size of 8192 bytes. The TCP transport is configured with an I/O unit size of
16384 bytes, 8 max qpairs per controller, and an in capsule data size of 8192 bytes. 16384 bytes, 8 max qpairs per controller, and an in capsule data size of 8192 bytes.
~~~{.sh} ~~~{.sh}
build/bin/nvmf_tgt build/bin/nvmf_tgt
scripts/rpc.py nvmf_create_transport -t RDMA -u 8192 -m 4 -c 0 scripts/rpc.py nvmf_create_transport -t RDMA -u 8192 -i 131072 -c 8192
scripts/rpc.py nvmf_create_transport -t TCP -u 16384 -m 8 -c 8192 scripts/rpc.py nvmf_create_transport -t TCP -u 16384 -m 8 -c 8192
~~~ ~~~