Skip to content

Commit

Permalink
Merge pull request #156 from martin-belanger/doc-stas-config
Browse files Browse the repository at this point in the history 
doc: document stas-config service/target.
  • Loading branch information
@martin-belanger
martin-belanger authored Jun 10, 2022
2 parents 8c4c702 + 7e28142 commit f24b4b5
Show file tree
Hide file tree
Showing 6 changed files with 152 additions and 10 deletions.
8 changes: 6 additions & 2 deletions doc/man/stacd.service.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
</citerefentry>
is a system service used to automatically connect to I/O controllers
discovered by <citerefentry>
<refentrytitle>stacf</refentrytitle>
<refentrytitle>stafd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>.
</para>
Expand All @@ -59,10 +59,14 @@
<citerefentry>
<refentrytitle>stacd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
</citerefentry>,
<citerefentry>
<refentrytitle>stafd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>stas-config.target</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
Expand Down
4 changes: 4 additions & 0 deletions doc/man/stafd.service.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@
<citerefentry>
<refentrytitle>stafd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>stas-config.target</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
Expand Down
72 changes: 72 additions & 0 deletions doc/man/stas-config.target.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
SPDX-License-Identifier: Apache-2.0
Copyright (c) 2022, Dell Inc. or its subsidiaries. All rights reserved.
-->
<refentry id="stas-config.target">
<refentryinfo>
<title>stas-config.target</title>
<productname>nvme-stas</productname>
<author>
<personname>
<honorific>Mr</honorific>
<firstname>Martin</firstname>
<surname>Belanger</surname>
</personname>
<affiliation>
<orgname>Dell, Inc.</orgname>
</affiliation>
</author>
</refentryinfo>

<refmeta>
<refentrytitle>stas-config.target</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>

<refnamediv>
<refname>stas-config.target</refname>
</refnamediv>

<refsynopsisdiv>
<para>
<filename>/usr/lib/systemd/system/stas-config.target</filename>
</para>
</refsynopsisdiv>

<refsect1>
<title>Description</title>
<para>
This target is used as a synchronization point before starting
<citerefentry><refentrytitle>stacd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> and
<citerefentry><refentrytitle>stafd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>

<para>
It ensures that <filename>/etc/nvme/hostnqn</filename> and
<filename>/etc/nvme/hostid</filename> are present before starting
<citerefentry><refentrytitle>stacd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> and
<citerefentry><refentrytitle>stafd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</refsect1>

<refsect1>
<title>See Also</title>

<para>
<citerefentry>
<refentrytitle>stacd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
<citerefentry>
<refentrytitle>stafd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>


66 changes: 66 additions & 0 deletions doc/man/[email protected]
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
SPDX-License-Identifier: Apache-2.0
Copyright (c) 2022, Dell Inc. or its subsidiaries. All rights reserved.
-->
<refentry id="[email protected]">
<refentryinfo>
<title>[email protected]</title>
<productname>nvme-stas</productname>
<author>
<personname>
<honorific>Mr</honorific>
<firstname>Martin</firstname>
<surname>Belanger</surname>
</personname>
<affiliation>
<orgname>Dell, Inc.</orgname>
</affiliation>
</author>
</refentryinfo>

<refmeta>
<refentrytitle>[email protected]</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>

<refnamediv>
<refname>[email protected]</refname>
</refnamediv>

<refsynopsisdiv>
<para>
<filename>/usr/lib/systemd/system/[email protected]</filename>
</para>
</refsynopsisdiv>

<refsect1>
<title>Description</title>
<para>
This service is used for the automatic run-time generation of
NVMe configuration located in <filename>/etc/nvme</filename>
(e.g. <filename>/etc/nvme/hostnqn</filename>). This is needed by
<citerefentry><refentrytitle>stacd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> and
<citerefentry><refentrytitle>stafd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</refsect1>

<refsect1>
<title>See Also</title>

<para>
<citerefentry>
<refentrytitle>stacd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
<citerefentry>
<refentrytitle>stafd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>

6 changes: 2 additions & 4 deletions usr/lib/systemd/system/stacd.in.service
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@
[Unit]
Description=@STAC_DESCRIPTION@ (@STAC_ACRONYM@)
Documentation=man:@[email protected](8) man:@STACD_PROCNAME@(8)
Wants=modprobe@nvme_tcp.service network.target
After=modprobe@nvme_tcp.service network.target
Wants=stas-config.target
After=stas-config.target
Wants=modprobe@nvme_tcp.service network.target stas-config.target
After=modprobe@nvme_tcp.service network.target stas-config.target

# Check that the nvme-tcp kernel module was previously
# loaded by checking for the presence of /dev/nvme-fabrics.
Expand Down
6 changes: 2 additions & 4 deletions usr/lib/systemd/system/stafd.in.service
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@
[Unit]
Description=@STAF_DESCRIPTION@ (@STAF_ACRONYM@)
Documentation=man:@[email protected](8) man:@STAFD_PROCNAME@(8)
Wants=modprobe@nvme_tcp.service network.target
After=modprobe@nvme_tcp.service network.target avahi-daemon.service
Wants=stas-config.target
After=stas-config.target
Wants=modprobe@nvme_tcp.service network.target stas-config.target
After=modprobe@nvme_tcp.service network.target stas-config.target avahi-daemon.service

# Check that the nvme-tcp kernel module was previously
# loaded by checking for the presence of /dev/nvme-fabrics.
Expand Down

0 comments on commit f24b4b5

Please sign in to comment.