#2257: setting up application and service docs
This commit is contained in:
Czar Echavez
@@ -20,16 +20,6 @@ e.g.
|
||||
links:
|
||||
...
|
||||
|
||||
**nodes:**
|
||||
* ``type``: one of ``router``, ``switch``, ``computer``, or ``server``, this affects what other sub-options should be defined.
|
||||
* ``hostname`` - a non-unique name used for logging and outputs.
|
||||
* ``num_ports`` (optional, routers and switches only): number of network interfaces present on the device.
|
||||
* ``ports`` (optional, routers and switches only): configuration for each network interface, including IP address and subnet mask.
|
||||
* ``acl`` (Router only): Define the ACL rules at each index of the ACL on the router. the possible options are: ``action`` (PERMIT or DENY), ``src_port``, ``dst_port``, ``protocol``, ``src_ip``, ``dst_ip``. Any options left blank default to none which usually means that it will apply across all options. For example leaving ``src_ip`` blank will apply the rule to all IP addresses.
|
||||
* ``services`` (computers and servers only): a list of services to install on the node. They must define a ``ref``, ``type``, and ``options`` that depend on which ``type`` was selected.
|
||||
* ``applications`` (computer and servers only): Similar to services. A list of application to install on the node.
|
||||
* ``network_interfaces`` (computers and servers only): If the node has multiple networking devices, the second, third, fourth, etc... must be defined here with an ``ip_address`` and ``subnet_mask``.
|
||||
|
||||
``nodes``
|
||||
---------
|
||||
|
||||
|
||||
@@ -3,39 +3,29 @@
|
||||
© 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``
|
||||
^^^^^^^^^^^^^^^^
|
||||
.. include:: ../software/applications.rst
|
||||
|
||||
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>`
|
||||
.. include:: ../software/services.rst
|
||||
|
||||
@@ -2,9 +2,30 @@
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
.. _applications_config:
|
||||
|
||||
``applications``
|
||||
================
|
||||
----------------
|
||||
|
||||
apps
|
||||
List of available applications that can be installed on a |NODE|:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
../software/applications/data_manipulation_bot.rst
|
||||
../software/applications/database_client.rst
|
||||
../software/applications/dos_bot.rst
|
||||
../software/applications/web_browser.rst
|
||||
|
||||
More info :py:mod:`primaite.game.game.APPLICATION_TYPES_MAPPING`
|
||||
|
||||
.. include:: ../software/common/system_software.rst
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
../software/applications/web_browser.rst
|
||||
|
||||
More info :py:mod:`primaite.simulator.network.hardware.nodes.host.host_node.SYSTEM_SOFTWARE`
|
||||
|
||||
.. |SOFTWARE_TYPE| replace:: application
|
||||
.. |SOFTWARE_TYPES| replace:: applications
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``DataManipulationBot``
|
||||
-----------------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``DatabaseClient``
|
||||
------------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``DoSBot``
|
||||
----------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``WebBrowser``
|
||||
--------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,12 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``system software``
|
||||
"""""""""""""""""""
|
||||
|
||||
Some |SOFTWARE_TYPES| are pre installed on nodes - this is similar to how some |SOFTWARE_TYPES| are included with the Operating System.
|
||||
|
||||
The |SOFTWARE_TYPE| may not be configured as needed, in which case, follow the steps above to configure them.
|
||||
|
||||
The list of |SOFTWARE_TYPES| that are considered system software are:
|
||||
@@ -2,9 +2,36 @@
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
.. _services_config:
|
||||
|
||||
``services``
|
||||
============
|
||||
------------
|
||||
|
||||
services
|
||||
List of available services that can be installed on a |NODE|:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
../software/services/database_service.rst
|
||||
../software/services/dns_client.rst
|
||||
../software/services/dns_server.rst
|
||||
../software/services/ftp_client.rst
|
||||
../software/services/ftp_server.rst
|
||||
../software/services/ntp_client.rst
|
||||
../software/services/ntp_server.rst
|
||||
../software/services/web_server.rst
|
||||
|
||||
More info :py:mod:`primaite.game.game.SERVICE_TYPES_MAPPING`
|
||||
|
||||
.. include:: ../software/common/system_software.rst
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
../software/services/dns_client.rst
|
||||
../software/services/ftp_client.rst
|
||||
../software/services/ntp_client.rst
|
||||
|
||||
More info :py:mod:`primaite.simulator.network.hardware.nodes.host.host_node.SYSTEM_SOFTWARE`
|
||||
|
||||
.. |SOFTWARE_TYPE| replace:: service
|
||||
.. |SOFTWARE_TYPES| replace:: services
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``DatabaseService``
|
||||
-------------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``DNSClient``
|
||||
-------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``DNSServer``
|
||||
-------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``FTPClient``
|
||||
-------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``FTPServer``
|
||||
-------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``NTPClient``
|
||||
-------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``NTPServer``
|
||||
-------------
|
||||
|
||||
test
|
||||
@@ -0,0 +1,8 @@
|
||||
.. only:: comment
|
||||
|
||||
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
||||
|
||||
``WebServer``
|
||||
-------------
|
||||
|
||||
test
|
||||
Reference in New Issue
Block a user