table of contents
| NVME-STAS(7) | NVME-STAS(7) |
NAME¶
nvme-stas - NVMe over Fabrics STorage Appliance Services
INTRODUCTION¶
This page describes the services provided by the nvme-stas package.
nvme-stas is composed of two services, stafd(8) and stacd(8), running on a host computer (the NVMe Host).
STorage Appliance Finder (stafd)¶
The tasks performed by stafd include:
STorage Appliance Connector (stacd)¶
The tasks performed by stacd include:
System configuration¶
A host must be provided with a Host NQN and a Host ID. nvme-stas will not run without these two mandatory configuration parameters. To follow in the footsteps of nvme-cli and libnvme, nvme-stas will use the same Host NQN and ID that nvme-cli and libnvme use by default. In other words, nvme-stas will read the Host NQN and ID from these two files by default:
Using the same configuration files will ensure consistency between nvme-stas, nvme-cli, and libnvme. On the other hand, nvme-stas can operate with a different Host NQN and/or ID. In that case, one can specify them in the [Host] section of /etc/nvme/nvme-stas.conf.
A new optional configuration parameter introduced in TP8010, the Host Symbolic Name, can only be specified there: it has no system-wide file of its own. The documentation for /etc/nvme/nvme-stas.conf can be found in nvme-stas.conf(5).
Including controllers¶
Both stafd and stacd can be told which controllers to connect to explicitly, instead of relying solely on mDNS discovery or Discovery Log Page Entries. A Discovery Controller for stafd is a [Discovery Controller] section, and an I/O subsystem for stacd is a [Subsystem] section, both in the connectivity configuration (/etc/nvme/nvme-stas.conf). See nvme-stas.conf(5).
Excluding controllers¶
Controllers that should not be connected to are excluded via libnvme's host-wide exclusion list: /etc/nvme/exclusions.conf and /etc/nvme/exclusions.conf.d/, which are managed with nvme exclusion. That list is honored by every NVMe-oF tool on the host, not just stafd and stacd, and it is read live: an entry added there takes effect on the next connection attempt, without reloading stafd or stacd.
For the design rationale behind the exclusion list, see libnvme's EXCLUSIONS.md[1] design document.
SEE ALSO¶
stacctl(1), stacd.conf(5), stacd.service(8), stacd(8), stafctl(1), stafd.conf(5), stafd.service(8), stafd(8), nvme-stas.conf(5).
NOTES¶
- 1.
- EXCLUSIONS.md
| nvme-stas 3.1 |