#2257: rearrange software pages + creating a list of applications and services which is hopefully a single point that should be referred to

This commit is contained in:
Czar Echavez
2024-02-23 08:55:32 +00:00
parent 98fb28cbbc
commit 5836ea68e3
42 changed files with 329 additions and 351 deletions

View File

@@ -49,6 +49,8 @@ In order to recreate the network below, we will need to create 2 links:
- a link from computer_2 to the switch
.. image:: ../../_static/switched_p2p_network.png
:width: 500
:align: center
this results in:

View File

@@ -106,9 +106,13 @@ There are 6 ACLs that can be defined for a firewall
- ``external_outbound_acl`` for traffic going towards the external network
.. image:: ../../../../_static/firewall_acl.png
:width: 500
:align: center
By default, ``external_inbound_acl`` and ``external_outbound_acl`` will permit any traffic through.
``internal_inbound_acl``, ``internal_outbound_acl``, ``dmz_inbound_acl`` and ``dmz_outbound_acl`` will deny any traffic by default, so must be configured to allow defined ``src_port`` and ``dst_port`` or ``protocol``.
See :py:mod:`primaite.simulator.network.hardware.nodes.network.router.AccessControlList`
See :ref:`List of Ports <List of Ports>` for a list of ports.

View File

@@ -5,27 +5,21 @@
``applications``
----------------
List of available applications that can be installed on a |NODE|:
List of available applications that can be installed on a |NODE| can be found in :ref:`List of Applications <List of Applications>`
.. toctree::
:maxdepth: 1
application in configuration
""""""""""""""""""""""""""""
../software/applications/data_manipulation_bot.rst
../software/applications/database_client.rst
../software/applications/dos_bot.rst
../software/applications/web_browser.rst
Applications takes a list of applications as shown in the example below.
More info :py:mod:`primaite.game.game.APPLICATION_TYPES_MAPPING`
.. code-block:: yaml
.. 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
- ref: client_1
hostname: client_1
type: computer
...
applications:
- ref: example_application
type: example_application_type
options:
# this section is different for each application

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``DataManipulationBot``
-----------------------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``DatabaseClient``
------------------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``DoSBot``
----------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``WebBrowser``
--------------
test

View File

@@ -1,12 +0,0 @@
.. 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:

View File

@@ -5,33 +5,21 @@
``services``
------------
List of available services that can be installed on a |NODE|:
List of available services that can be installed on a |NODE| can be found in :ref:`List of Services <List of Services>`
.. toctree::
:maxdepth: 1
services in configuration
"""""""""""""""""""""""""
../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
Services takes a list of services as shown in the example below.
More info :py:mod:`primaite.game.game.SERVICE_TYPES_MAPPING`
.. code-block:: yaml
.. 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
- ref: client_1
hostname: client_1
type: computer
...
applications:
- ref: example_service
type: example_service_type
options:
# this section is different for each service

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``DatabaseService``
-------------------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``DNSClient``
-------------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``DNSServer``
-------------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``FTPClient``
-------------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``FTPServer``
-------------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``NTPClient``
-------------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``NTPServer``
-------------
test

View File

@@ -1,8 +0,0 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
``WebServer``
-------------
test