docs(readme): update documentation re. targets

saltstack-formulas · Oct 4, 2019 · c90f86d · c90f86d
1 parent 36c63a7
commit c90f86d
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 9 deletions.
diff --git a/docs/README.rst b/docs/README.rst
@@ -14,8 +14,14 @@ iscsi-formula
    :scale: 100%
    :target: https://github.com/semantic-release/semantic-release
 
-A SaltStack formula that is empty. It has dummy content to help with a quick
-start on a new formula and it serves as a style guide.
+Configure iSCSI targets and initiator on GNU/Linux and FreeBSD.
+
+Technology
+----------
+.. image:: docs/link-transport-storage-protocols.png
+   :target: https://github.com/saltstack-formulas/iscsi-formula
+   :scale: 25 %
+   :alt: Link/Transport and Storage protocol infographic
 
 .. contents:: **Table of Contents**
 
@@ -59,10 +65,19 @@ starts the associated iscsi services.
 ---------------------
 Install and configure the iSCSI Target service. Supported vendor implementations include-
 
-- ``/etc/ctl.conf`` for ``ctld(8)`` on FreeBSD 
-- ``/etc/target/saveconfig.json` for ``LIOkernel target`` on GNU/Linux
-- ``/etc/targets.conf`` for ``tgt(8)`` on GNU/Linux (largely obsolete)
-- ``/etc/ietd.conf`` for `ietd(8)`` on GNU/Linux (largely obsolete)
+- ``/etc/ctl.conf`` for ``ctld(8)`` on FreeBSD
+- ``/etc/target/saveconfig.json` for ``LIO`` on GNU/Linux
+- ``/etc/targets.conf`` for ``tgt(8)`` on GNU/Linux
+- ``/etc/ietd.conf`` for `ietd(8)`` on GNU/Linux
+
+The defaults targets are-
+
+- ctld on FreeBSD
+- LIO on CentOS, OpenSUSE, Arch
+- tgt on Debian
+
+The default choice is modifable via the `iscsi.target.provider` pillar value.
+New providers can be introduced via pull request.
 
 ``iscsi.initiator``
 ------------------

diff --git a/docs/link-transport-storage-protocols.png b/docs/link-transport-storage-protocols.png
diff --git a/iscsi/defaults.yaml b/iscsi/defaults.yaml
@@ -69,6 +69,9 @@ iscsi:
       fcoe:
         name: fcoe_target
         text: fcoe_target
+      iser:
+        name: ('ib_iser', 'ib_isert', 'rdma_ucm', 'rdma_cm', 'ib_cm',)
+        text: null
     data:
       iscsi: {}
       fcoe: {}

diff --git a/iscsi/osfamilymap.yaml b/iscsi/osfamilymap.yaml
@@ -71,7 +71,7 @@ Suse:
   initiator:
     pkgs:
       wanted:
-        - libopen-iscsiusr0_2_0
+        # libopen-iscsiusr0_2_0
         - open-iscsi
         - libiscsi8
         - librdmacm1
@@ -105,7 +105,7 @@ Gentoo:
 Arch:
   config:
     servicename:
-      open-iscsi:   ##open-iscsi on archlinux uses non-standard service names
+      open-iscsi:
        - iscsi
        - iscsid
   initiator:

diff --git a/iscsi/target/config/files/default/tgtd.tmpl b/iscsi/target/config/files/default/tgtd.tmpl
@@ -18,7 +18,7 @@
 {{ readconf(value, spaces|int+4) }}
 {{shift}}{{ '</' ~ key.split(" ")[0] ~ '>' }}
 
-    {%- elif value is string or value is number %}
+    {% elif value is string or value is number %}
 {{shift}}{{ key }} {{ value }}
     {%- endif %}
 {%- endmacro -%}

diff --git a/pillar.example b/pillar.example
@@ -2,6 +2,17 @@
 # vim: ft=yaml
 ---
 iscsi:
+
+    {%- if grains.os_family in ('Debian',) %}
+  target:
+    pkgs:
+      wanted:
+        - infiniband-diags
+        - ibutils
+        - ibverbs-utils
+        - rdmacm-utils perftest
+    {%- endif %}
+
   config:
     data:
       open-iscsi: