From 919c4b540e0f7a77454124340715d710ed333aee Mon Sep 17 00:00:00 2001 From: Changpeng Liu Date: Wed, 25 Jan 2017 14:59:22 +0800 Subject: [PATCH] doc/nvmf: add NVMeoF kernel based initiator usage Change-Id: Icea0d7fbf1801cc4df66392ece5ac67e0d9584c0 Signed-off-by: Changpeng Liu --- doc/nvmf/getting_started.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/nvmf/getting_started.md b/doc/nvmf/getting_started.md index 448f3bda2..fbc4e86cc 100644 --- a/doc/nvmf/getting_started.md +++ b/doc/nvmf/getting_started.md @@ -56,3 +56,26 @@ the target requires elevated privileges (root) to run. ~~~{.sh} app/nvmf_tgt/nvmf_tgt -c /path/to/nvmf.conf ~~~ + +# Configuring NVMe over Fabrics Host {#nvmf_host} + +Both the Linux kernel and SPDK implemented NVMe over Fabrics host. Users who want to test +`nvmf_tgt` with kernel based host should upgrade to Linux kernel 4.8 or later, or can use +Linux distributions Fedora or Ubuntu with Linux 4.8 kernel or later. A client tool nvme-cli +is recommended to connect/disconect with NVMe over Fabrics target subsystems. Before +connecting to remote subsystems, users should verify nvme-rdma driver is loaded. + +Discovery: +~~~{.sh} +nvme discovery -t rdma -s 192.168.100.8 -s 4420 +~~~ + +Connect: +~~~{.sh} +nvme connect -t rdma -n "nqn.2016-06.io.spdk:cnode1" -a 192.168.100.8 -s 4420 +~~~ + +Disconnect: +~~~{.sh} +nvme disconnect -n "nqn.2016-06.io.spdk.cnode1" +~~~