From 9cb6b1ed8523c39acc3d3096c1154152ea7174e7 Mon Sep 17 00:00:00 2001
From: "A. Wilcox" <AWilcox@Wilcox-Tech.com>
Date: Wed, 26 Feb 2020 02:58:27 -0600
Subject: devel: Add 'netconfigtype' key specification

---
 devel/requirements/3b_runner.xml | 16 +++++++++++++
 devel/script/2_keys.xml          | 49 ++++++++++++++++++++++++++++++++++++++--
 2 files changed, 63 insertions(+), 2 deletions(-)

diff --git a/devel/requirements/3b_runner.xml b/devel/requirements/3b_runner.xml
index db80845..60441c8 100644
--- a/devel/requirements/3b_runner.xml
+++ b/devel/requirements/3b_runner.xml
@@ -162,6 +162,22 @@
                     <title>Runner.Validate.network.netssid.Key</title>
                     <para>If the third value of a <literal>netssid</literal> tuple is a valid security type and not <literal>none</literal>, the system shall ensure that the <literal>netssid</literal> tuple has a fourth value that specifies the security key.</para>
                 </formalpara>
+                <formalpara id="Runner.Validate.netconfigtype">
+                    <title>Runner.Validate.netconfigtype</title>
+                    <para>The system shall verify that the HorizonScript contains zero or one <literal>netconfigtype</literal> key.</para>
+                </formalpara>
+                <formalpara id="Runner.Validate.netconfigtype.Validity">
+                    <title>Runner.Validate.netconfigtype.Validity</title>
+                    <para>If the HorizonScript contains a <literal>netconfigtype</literal> key, the system shall ensure that the <literal>netconfigtype</literal> key has a valid form of a single string containing a recognised network configuration type.</para>
+                </formalpara>
+                <formalpara id="Runner.Validate.netconfigtype.netifrc">
+                    <title>Runner.Validate.netconfigtype.netifrc</title>
+                    <para>If the value of the <literal>netconfigtype</literal> key is <literal>netifrc</literal>, the system shall write any network configuration in a manner that can be used by the netifrc package.</para>
+                </formalpara>
+                <formalpara id="Runner.Validate.netconfigtype.eni">
+                    <title>Runner.Validate.netconfigtype.eni</title>
+                    <para>If the value of the <literal>netconfigtype</literal> key is <literal>eni</literal>, the system shall write any network configuration to a <filename>/etc/network/interfaces</filename> file that conforms to the standard provided.</para>
+                </formalpara>
                 <formalpara id="Runner.Validate.nameserver">
                     <title>Runner.Validate.nameserver</title>
                     <para>The system shall verify any <literal>nameserver</literal> keys contained in the HorizonScript.</para>
diff --git a/devel/script/2_keys.xml b/devel/script/2_keys.xml
index ccdc810..309f124 100644
--- a/devel/script/2_keys.xml
+++ b/devel/script/2_keys.xml
@@ -298,6 +298,51 @@ firmware false
                 </para>
             </formalpara>
         </section>
+        <section id="netconfigtype">
+            <title><literal>netconfigtype</literal></title>
+            <formalpara id="netconfigtype.name">
+                <title>Name</title>
+                <para><literal>netconfigtype</literal></para>
+            </formalpara>
+            <formalpara id="netconfigtype.purpose">
+                <title>Purpose</title>
+                <para>The <literal>netconfigtype</literal> key determines the desired network configuration type used on the target computer.</para>
+            </formalpara>
+            <formalpara id="netconfigtype.format">
+                <title>Format</title>
+                <para>The <literal>netconfigtype</literal> key is a single string that describes the desired network configuration system used on the target computer.  <literal>netconfigtype</literal> may appear at most once in a HorizonScript.
+                    Currently recognised network configuration systems for Horizon 1.0 are:
+                    <orderedlist id="netconfigtype.format.items">
+                        <listitem><para><literal>netifrc</literal> &mdash; The netifrc system, as used by Adélie Linux</para></listitem>
+                        <listitem><para><literal>eni</literal> &mdash; The /etc/network/interfaces system, as used by Alpine Linux</para></listitem>
+                        <!-- <listitem><para><literal>networkmanager</literal> &mdash; The NetworkManager system, usable by both Adélie and Alpine Linux</para></listitem> -->
+                    </orderedlist>
+                </para>
+            </formalpara>
+            <formalpara id="netconfigtype.default">
+                <title>Default</title>
+                <para>If no <literal>netconfigtype</literal> key is specified, the system will default to the <literal>netifrc</literal> configuration system.</para>
+            </formalpara>
+            <formalpara id="netconfigtype.examples">
+                <title>Examples</title>
+                <para>
+                    <example>
+                        <title>The <literal>netconfigtype</literal> Key &mdash; netifrc</title>
+                        <programlisting>
+netconfigtype netifrc
+                        </programlisting>
+                        <para>This configures the target computer to use netifrc for network configuration.</para>
+                    </example>
+                    <example>
+                        <title>The <literal>netconfigtype</literal> Key &mdash; /etc/network/interfaces</title>
+                        <programlisting>
+netconfigtype eni
+                        </programlisting>
+                        <para>This configures the target computer to use an /etc/network/interfaces file for network configuration.</para>
+                    </example>
+                </para>
+            </formalpara>
+        </section>
         <section id="netaddress">
             <title><literal>netaddress</literal></title>
             <formalpara id="netaddress.name">
@@ -330,8 +375,8 @@ firmware false
                 <title>Default</title>
                 <para>There is no default for this key.  It is invalid to enable networking and not provide at least one <literal>netaddress</literal> key.</para>
             </formalpara>
-            <formalpara id="netaddress.example">
-                <title>Example</title>
+            <formalpara id="netaddress.examples">
+                <title>Examples</title>
                 <para>
                     <example>
                         <title>The <literal>netaddress</literal> Key &mdash; Simple DHCP</title>
-- 
cgit v1.2.3-70-g09d2