Commit 5240cbbb authored by Seth Howell's avatar Seth Howell Committed by Jim Harris
Browse files

doc: update the NVMe-oF user guide 



Update it to reflect the preferred way of initializing a transport over
RPC.

Change-Id: I6e37cca927e41082fd29808298ed8f5c4c3cdb60
Signed-off-by: default avatarSeth Howell <seth.howell@intel.com>
Reviewed-on: https://review.gerrithub.io/429842


Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
parent 962ba4e8

doc/nvmf.md

+6 −11
Original line number Diff line number Diff line
@@ -109,21 +109,16 @@ of the new script `scripts/config_converter.py`. 


### Using RPCs {#nvmf_config_rpc}



Start the nvmf_tgt application with elevated privileges and instruct it to wait for RPCs.

The set_nvmf_target_options RPC can then be used to configure basic target parameters.

Below is an example where the target is configured with an I/O unit size of 8192,

4 max qpairs per controller, and an in capsule data size of 0. The parameters controlled

by set_nvmf_target_options may only be modified before the SPDK NVMe-oF subsystem is initialized.

Once the target options are configured. You need to start the NVMe-oF subsystem with start_subsystem_init.

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

example where the target is started and the RDMA transport is configured with an I/O

unit size of 8192 bytes, 4 max qpairs per controller, and an in capsule data size of 0 bytes.



~~~{.sh}

app/nvmf_tgt/nvmf_tgt --wait-for-rpc

scripts/rpc.py set_nvmf_target_options -u 8192 -p 4 -c 0

scripts/rpc.py start_subsystem_init

app/nvmf_tgt/nvmf_tgt

scripts/rpc.py nvmf_create_transport -t RDMA -u 8192 -p 4 -c 0

~~~



Note: The start_subsystem_init rpc is referring to SPDK application subsystems and not the NVMe over Fabrics concept.



Below is an example of creating a malloc bdev and assigning it to a subsystem. Adjust the bdevs,

NQN, serial number, and IP address to your own circumstances.