1NVME-STAS(7)                                                      NVME-STAS(7)
2
3
4

NAME

6       nvme-stas - NVMe over Fabrics STorage Appliance Services
7

INTRODUCTION

9       This page describes the services provided by the nvme-stas package.
10
11       nvme-stas is composed of two services, stafd(8) and stacd(8), running
12       on a host computer (the NVMe Host).
13
14   STorage Appliance Finder (stafd)
15       The tasks performed by stafd include:
16
17       •   Register for mDNS service type _nvme-disc._tcp with Avahi, the
18           service discovery daemon. This allows stafd to automatically locate
19           Central or Direct Discovery Controllers (CDC, DDC) with
20           zero-configuration networking (zeroconf).  stafd also allows users
21           to manually enter CDCs and DDCs in a configuration file
22           (/etc/stas/stafd.conf) when users prefer not to enable mDNS-based
23           zeroconf.
24
25       •   Connect to discovered or configured CDCs or DDCs.
26
27       •   Retrieve the list of NVMe subsystem IO Controllers or Discovery
28           Controller referrals from the Discovery Log Page using the NVMe
29           command "Get Log Page".
30
31       •   Maintain a cache of the discovery log pages.
32
33       •   Provide a D-Bus API where other applications can interact with
34           stafd. This API can be used, for example, to retrieve the list of
35           cached discovery log pages.
36
37   STorage Appliance Connector (stacd)
38       The tasks performed by stacd include:
39
40       •   Read the list of storage subsystems (i.e., discovery log pages)
41           from stafd over the D-Bus API.
42
43       •   Similar to stafd, stacd can also read a list of storage subsystems
44           to connect to from a configuration file: (/etc/stas/stacd.conf).
45
46       •   Set up the I/O controller connections to each storage subsystem.
47
48       •   Provide a D-Bus API where other applications can interact with
49           stacd. For example, an application could retrieve the list of I/O
50           controllers that stacd connected to.
51
52   System configuration
53       A host must be provided with a Host NQN and a Host ID.  nvme-stas will
54       not run without these two mandatory configuration parameters. To follow
55       in the footsteps of nvme-cli and libnvme, nvme-stas will use the same
56       Host NQN and ID that nvme-cli and libnvme use by default. In other
57       words, nvme-stas will read the Host NQN and ID from these two files by
58       default:
59
60       •   /etc/nvme/hostnqn
61
62       •   /etc/nvme/hostid
63
64       Using the same configuration files will ensure consistency between
65       nvme-stas, nvme-cli, and libnvme. On the other hand, nvme-stas can
66       operate with a different Host NQN and/or ID. In that case, one can
67       specify them in /etc/stas/sys.conf.
68
69                   A new optional configuration parameters introduced in
70       TP8010, the
71                   Host Symbolic Name, can also be specified in
72       /etc/stas/sys.conf.
73                   The documentation for /etc/stas/sys.conf
74                   can be found /etc/stas/sys.conf.doc.
75               .PP
76

SEE ALSO

78       stacctl(1), stacd.conf(5), stacd.service(8), stacd(8), stafctl(1),
79       stafd.conf(5), stafd.service(8), stafd(8),
80
81
82
83nvme-stas 2.0-rc5                                                 NVME-STAS(7)
Impressum