#2257: massive docs addition for config file

docs/source/configuration/simulation/nodes/common/common_host_node_attributes.rst

@@ -0,0 +1,41 @@
+.. only:: comment
+
+    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+
+``ip_address``
+^^^^^^^^^^^^^^
+
+The IP address of the |NODE| in the network.
+
+``subnet_mask``
+^^^^^^^^^^^^^^^
+
+Optional. Default value is ``255.255.255.0``.
+
+The subnet mask for the |NODE| to use.
+
+``default_gateway``
+^^^^^^^^^^^^^^^^^^^
+
+The IP address that the |NODE| will use as the default gateway. Typically, this is the IP address of the closest router that the |NODE| is connected to.
+
+``dns_server``
+^^^^^^^^^^^^^^
+
+Optional. Default value is ``None``
+
+The IP address of the node which holds an instance of the DNS server. Some applications may use a domain name e.g. the WebBrowser (TODO: WebBrowser page)
+
+``applications``
+^^^^^^^^^^^^^^^^
+
+A list of applications which are not considered system software that need to be installed on the |NODE|.
+
+See :ref:`Applications <applications_config>`
+
+``services``
+^^^^^^^^^^^^
+
+A list of services which are not considered system software that need to be installed on the |NODE|.
+
+See :ref:`Services <services_config>`

docs/source/configuration/simulation/nodes/common/common_network_node_attributes.rst

@@ -0,0 +1,49 @@
+.. only:: comment
+
+    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+
+``routes``
+----------
+
+A list of routes which tells the |NODE| where to forward the packet to depending on the target IP address.
+
+e.g.
+
+.. code-block:: yaml
+
+    nodes:
+        - ref: node
+        ...
+        routes:
+            - address: 192.168.0.10
+            subnet_mask: 255.255.255.0
+            next_hop_ip_address: 192.168.1.1
+            metric: 0
+
+``address``
+"""""""""""
+
+The target IP address for the route. If the packet destination IP address matches this, the router will route the packet according to the ``next_hop_ip_address``.
+
+This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``.
+
+``subnet_mask``
+"""""""""""""""
+
+Optional. Default value is ``255.255.255.0``.
+
+The subnet mask setting for the route.
+
+``next_hop_ip_address``
+"""""""""""""""""""""""
+
+The IP address of the next hop IP address that the packet will follow if the address matches the packet's destination IP address.
+
+This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``.
+
+``metric``
+""""""""""
+
+Optional. Default value is ``0``. This value accepts floats.
+
+The cost or distance of a route. The higher the value, the more cost or distance is attributed to the route.

docs/source/configuration/simulation/nodes/common/common_node_attributes.rst

@@ -0,0 +1,13 @@
+.. only:: comment
+
+    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+
+``ref``
+-------
+
+Human readable name used as reference for the |NODE|. Not used in code.
+
+``hostname``
+------------
+
+The hostname of the |NODE|. This will be used to reference the |NODE|.

docs/source/configuration/simulation/nodes/common/node_type_list.rst

@@ -0,0 +1,18 @@
+.. only:: comment
+
+    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+
+``type``
+--------
+
+The type of node to add.
+
+Available options are:
+
+- ``computer``
+- ``firewall``
+- ``router``
+- ``server``
+- ``switch``
+
+To create a |NODE|, type must be |NODE_TYPE|.