0fc7daffe5
Use the final official spec name rather than a non-standard abbreviation. Change-Id: I4d797294be35b2fbf7b39570ea3246eb71c8d8ce Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
95 lines
4.3 KiB
Plaintext
95 lines
4.3 KiB
Plaintext
/*-
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright (c) Intel Corporation.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* * Neither the name of Intel Corporation nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
/**
|
|
* \page nvmf_getting_started NVMe over Fabrics Target Getting Started Guide
|
|
|
|
The NVMe over Fabrics target is a user space application that presents block devices over the
|
|
network using RDMA. It requires an RDMA-capable NIC with its corresponding OFED software package
|
|
installed to run. The target should work on all flavors of RDMA, but it is currently tested against
|
|
Mellanox NICs (RoCEv2) and Chelsio NICs (iWARP).
|
|
|
|
The NVMe over Fabrics specification defines subsystems that can be exported over the network. SPDK
|
|
has chosen to call the software that exports these subsystems a "target", which is the term used
|
|
for iSCSI. The specification refers to the "client" that connects to the target as a "host". Many
|
|
people will also refer to the host as an "initiator", which is the equivalent thing in iSCSI
|
|
parlance. SPDK will try to stick to the terms "target" and "host" to match the specification.
|
|
|
|
There will be both a target and a host implemented in the Linux kernel, and these are available
|
|
today as a set of patches against the kernel 4.8 release candidate. All of the testing against th
|
|
SPDK target has been against the proposed Linux kernel host. This means that for at least the host
|
|
machine, the kernel will need to be a release candidate until the code is actually merged. For the
|
|
system running the SPDK target, however, you can run any modern flavor of Linux as required by your
|
|
NIC vendor's OFED distribution.
|
|
|
|
\section nvmf_prereqs Prerequisites
|
|
|
|
This guide starts by assuming that you can already build the standard SPDK distribution on your
|
|
platform. By default, the NVMe over Fabrics target is not built. To build nvmf_tgt there are some
|
|
additional dependencies.
|
|
|
|
Fedora:
|
|
\verbatim
|
|
dnf install libibverbs-devel librdmacm-devel
|
|
\endverbatim
|
|
|
|
Ubuntu:
|
|
\verbatim
|
|
apt-get install libibverbs-dev librdmacm-dev
|
|
\endverbatim
|
|
|
|
Then build SPDK with RDMA enabled, either by editing CONFIG to enable CONFIG_RDMA or
|
|
enabling it on the `make` command line:
|
|
|
|
\verbatim
|
|
make CONFIG_RDMA=y <other config parameters>
|
|
\endverbatim
|
|
|
|
Once built, the binary will be in `app/nvmf_tgt`.
|
|
|
|
\section nvmf_config Configuring NVMe over Fabrics Target
|
|
|
|
A `nvmf_tgt`-specific configuration file is used to configure the NVMe over Fabrics target. This
|
|
file's primary purpose is to define subsystems. A fully documented example configuration file is
|
|
located at `etc/spdk/nvmf.conf.in`.
|
|
|
|
You should make a copy of the example configuration file, modify it to suit your environment, and
|
|
then run the nvmf_tgt application and pass it the configuration file using the -c option. Right now,
|
|
the target requires elevated privileges (root) to run.
|
|
|
|
\verbatim
|
|
app/nvmf_tgt/nvmf_tgt -c /path/to/nvmf.conf
|
|
\endverbatim
|
|
|
|
*/
|