Update docs and changelog.
This commit is contained in:
@@ -17,6 +17,8 @@ a Service/Application another machine.
|
|||||||
SessionManager.
|
SessionManager.
|
||||||
- Permission System - each action can define criteria that will be used to permit or deny agent actions.
|
- Permission System - each action can define criteria that will be used to permit or deny agent actions.
|
||||||
- File System - ability to emulate a node's file system during a simulation
|
- File System - ability to emulate a node's file system during a simulation
|
||||||
|
- Example notebooks - There is currently 1 jupyter notebook which walks through using PrimAITE
|
||||||
|
1. Creating a simulation - this notebook explains how to build up a simulation using the Python package. (WIP)
|
||||||
|
|
||||||
## [2.0.0] - 2023-07-26
|
## [2.0.0] - 2023-07-26
|
||||||
|
|
||||||
|
|||||||
BIN
docs/_static/component_relationship.png
vendored
Normal file
BIN
docs/_static/component_relationship.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 80 KiB |
@@ -7,11 +7,19 @@ Simulation Structure
|
|||||||
====================
|
====================
|
||||||
|
|
||||||
The simulation is made up of many smaller components which are related to each other in a tree-like structure. At the
|
The simulation is made up of many smaller components which are related to each other in a tree-like structure. At the
|
||||||
top level, there is an object called the ``SimulationController`` _(doesn't exist yet)_, which has a physical network
|
top level, there is the :py:meth:`primaite.simulator.sim_container.Simulation`, which keeps track of the physical network
|
||||||
and a software controller for managing software and users.
|
and a domain controller for managing software and users.
|
||||||
|
|
||||||
Each node of the simulation 'tree' has responsibility for creating, deleting, and updating its direct descendants.
|
Each node of the simulation 'tree' has responsibility for creating, deleting, and updating its direct descendants. Also,
|
||||||
|
when a component's ``describe_state()`` method is called, it will include the state of its descendants. The
|
||||||
|
``apply_action()`` method can be used to act on a component or one of its descendatnts. The diagram below shows the
|
||||||
|
relationship between components.
|
||||||
|
|
||||||
|
.. image:: _static/component_relationship.png
|
||||||
|
:width: 500
|
||||||
|
:alt: The top level simulation object owns a NetworkContainer and a DomainController. The DomainController has a
|
||||||
|
list of accounts. The network container has links and nodes. Nodes can own switchports, NICs, FileSystem,
|
||||||
|
Application, Service, and Process.
|
||||||
|
|
||||||
|
|
||||||
Actions
|
Actions
|
||||||
|
|||||||
Reference in New Issue
Block a user