ceph/doc/rbd/nvmeof-overview.rst
Orit Wasserman 9f86c35a0d doc: Add NVMe-oF gateway documentation
- Add nvmeof-initiator-esx.rst
- Add nvmeof-initiator-linux.rst
- Add nvmeof-initiators.rst
- Add nvmeof-overview.rst
- Add nvmeof-requirements.rst
- Add nvmeof-target-configure.rst
- Add links to rbd-integrations.rst

Co-authored-by: Ilya Dryomov <idryomov@redhat.com>
Co-authored-by: Zac Dover <zac.dover@proton.me>
Signed-off-by: Orit Wasserman <owasserm@ibm.com>
2024-02-23 03:40:17 +10:00

49 lines
2.4 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. _ceph-nvmeof:
======================
Ceph NVMe-oF Gateway
======================
The NVMe-oF Gateway presents an NVMe-oF target that exports
RADOS Block Device (RBD) images as NVMe namespaces. The NVMe-oF protocol allows
clients (initiators) to send NVMe commands to storage devices (targets) over a
TCP/IP network, enabling clients without native Ceph client support to access
Ceph block storage.
Each NVMe-oF gateway consists of an `SPDK <https://spdk.io/>`_ NVMe-oF target
with ``bdev_rbd`` and a control daemon. Cephs NVMe-oF gateway can be used to
provision a fully integrated block-storage infrastructure with all the features
and benefits of a conventional Storage Area Network (SAN).
.. ditaa::
Cluster Network (optional)
+-------------------------------------------+
| | | |
+-------+ +-------+ +-------+ +-------+
| | | | | | | |
| OSD 1 | | OSD 2 | | OSD 3 | | OSD N |
| {s}| | {s}| | {s}| | {s}|
+-------+ +-------+ +-------+ +-------+
| | | |
+--------->| | +---------+ | |<----------+
: | | | RBD | | | :
| +----------------| Image |----------------+ |
| Public Network | {d} | |
| +---------+ |
| |
| +--------------------+ |
| +--------------+ | NVMeoF Initiators | +--------------+ |
| | NVMeoF GW | | +-----------+ | | NVMeoF GW | |
+-->| RBD Module |<--+ | Various | +-->| RBD Module |<--+
| | | | Operating | | | |
+--------------+ | | Systems | | +--------------+
| +-----------+ |
+--------------------+
.. toctree::
:maxdepth: 1
Requirements <nvmeof-requirements>
Configuring the NVME-oF Target <nvmeof-target-configure>
Configuring the NVMe-oF Initiators <nvmeof-initiators>