#3110 - Amend Documentation pages that have out of date material following updates
This commit is contained in:
@@ -14,7 +14,6 @@ This section configures how PrimAITE saves data during simulation and training.
|
|||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
io_settings:
|
io_settings:
|
||||||
# save_logs: True
|
|
||||||
save_agent_actions: True
|
save_agent_actions: True
|
||||||
save_step_metadata: False
|
save_step_metadata: False
|
||||||
save_pcap_logs: False
|
save_pcap_logs: False
|
||||||
@@ -26,11 +25,6 @@ This section configures how PrimAITE saves data during simulation and training.
|
|||||||
agent_log_level: INFO
|
agent_log_level: INFO
|
||||||
|
|
||||||
|
|
||||||
``save_logs``
|
|
||||||
-------------
|
|
||||||
|
|
||||||
*currently unused*.
|
|
||||||
|
|
||||||
``save_agent_actions``
|
``save_agent_actions``
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
|
|||||||
@@ -4,11 +4,6 @@
|
|||||||
|
|
||||||
.. _common_node_attributes:
|
.. _common_node_attributes:
|
||||||
|
|
||||||
``ref``
|
|
||||||
-------
|
|
||||||
|
|
||||||
Human readable name used as reference for the |NODE|. Not used in code.
|
|
||||||
|
|
||||||
``hostname``
|
``hostname``
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ Available options are:
|
|||||||
- ``computer``
|
- ``computer``
|
||||||
- ``firewall``
|
- ``firewall``
|
||||||
- ``router``
|
- ``router``
|
||||||
|
- ``wireless_router``
|
||||||
- ``server``
|
- ``server``
|
||||||
- ``switch``
|
- ``switch``
|
||||||
|
|
||||||
|
|||||||
@@ -14,12 +14,10 @@ Applications takes a list of applications as shown in the example below.
|
|||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
- ref: client_1
|
- hostname: client_1
|
||||||
hostname: client_1
|
type: computer
|
||||||
type: computer
|
|
||||||
...
|
...
|
||||||
applications:
|
applications:
|
||||||
- ref: example_application
|
|
||||||
type: example_application_type
|
type: example_application_type
|
||||||
options:
|
options:
|
||||||
# this section is different for each application
|
# this section is different for each application
|
||||||
|
|||||||
@@ -14,12 +14,10 @@ Services takes a list of services as shown in the example below.
|
|||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
- ref: client_1
|
|
||||||
hostname: client_1
|
hostname: client_1
|
||||||
type: computer
|
type: computer
|
||||||
...
|
...
|
||||||
applications:
|
applications:
|
||||||
- ref: example_service
|
|
||||||
type: example_service_type
|
type: example_service_type
|
||||||
options:
|
options:
|
||||||
# this section is different for each service
|
# this section is different for each service
|
||||||
|
|||||||
Reference in New Issue
Block a user