85f03570f7
## Summary This PR removes the hardcoding of Link bandwidth, and makes it possible to be configured via the network yaml definitions. Link bandwidth will still default to 100 if this is not present, to prevent breaking all previous defined networks. ## Test process All tests continue to pass. `basic_network_config.yaml` now provides a non-default link bandwidth which is confirmed within unit tests. ## Checklist - [X] PR is linked to a **work item** - [X] **acceptance criteria** of linked ticket are met - [X] performed **self-review** of the code - [X] written **tests** for any new functionality added with this PR - [X] updated the **documentation** if this PR changes or adds functionality - [ ] written/updated **design docs** if this PR implements new functionality - [] updated the **change log** - [X] ran **pre-commit** checks for code style - [X] attended to any **TO-DOs** left in the code Related work items: #2457
104 lines
2.8 KiB
ReStructuredText
104 lines
2.8 KiB
ReStructuredText
.. only:: comment
|
|
|
|
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
|
|
|
|
|
|
``simulation``
|
|
==============
|
|
In this section the network layout is defined. This part of the config follows a hierarchical structure. Almost every component defines a ``ref`` field which acts as a human-readable unique identifier, used by other parts of the config, such as agents.
|
|
|
|
At the top level of the network are ``nodes`` and ``links``.
|
|
|
|
e.g.
|
|
|
|
.. code-block:: yaml
|
|
|
|
simulation:
|
|
network:
|
|
nodes:
|
|
...
|
|
links:
|
|
...
|
|
|
|
``nodes``
|
|
---------
|
|
|
|
This is where the list of nodes are defined. Some items will differ according to the node type, however, there will be common items such as a node's reference (which is used by the agent), the node's ``type`` and ``hostname``
|
|
|
|
To see the configuration for these nodes, refer to the following:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
simulation/nodes/computer
|
|
simulation/nodes/firewall
|
|
simulation/nodes/router
|
|
simulation/nodes/server
|
|
simulation/nodes/switch
|
|
simulation/nodes/wireless_router
|
|
simulation/nodes/network_examples
|
|
|
|
``links``
|
|
---------
|
|
|
|
This is where the links between the nodes are formed.
|
|
|
|
e.g.
|
|
|
|
In order to recreate the network below, we will need to create 2 links:
|
|
|
|
- a link from computer_1 to the switch
|
|
- a link from computer_2 to the switch
|
|
|
|
.. image:: ../../_static/switched_p2p_network.png
|
|
:width: 500
|
|
:align: center
|
|
|
|
this results in:
|
|
|
|
.. code-block:: yaml
|
|
|
|
links:
|
|
- endpoint_a_hostname: computer_1
|
|
endpoint_a_port: 1 # port 1 on computer_1
|
|
endpoint_b_hostname: switch
|
|
endpoint_b_port: 1 # port 1 on switch
|
|
bandwidth: 100
|
|
- endpoint_a_hostname: computer_2
|
|
endpoint_a_port: 1 # port 1 on computer_2
|
|
endpoint_b_hostname: switch
|
|
endpoint_b_port: 2 # port 2 on switch
|
|
bandwidth: 100
|
|
|
|
``ref``
|
|
^^^^^^^
|
|
|
|
The human readable name for the link. Not used in code, however is useful for a human to understand what the link is for.
|
|
|
|
``endpoint_a_hostname``
|
|
^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
The ``hostname`` of the node which must be connected.
|
|
|
|
``endpoint_a_port``
|
|
^^^^^^^^^^^^^^^^^^^
|
|
|
|
The port on ``endpoint_a_hostname`` which is to be connected to ``endpoint_b_port``.
|
|
This accepts an integer value e.g. if port 1 is to be connected, the configuration should be ``endpoint_a_port: 1``
|
|
|
|
``endpoint_b_hostname``
|
|
^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
The ``hostname`` of the node which must be connected.
|
|
|
|
``endpoint_b_port``
|
|
^^^^^^^^^^^^^^^^^^^
|
|
|
|
The port on ``endpoint_b_hostname`` which is to be connected to ``endpoint_a_port``.
|
|
This accepts an integer value e.g. if port 1 is to be connected, the configuration should be ``endpoint_b_port: 1``
|
|
|
|
``bandwidth``
|
|
|
|
This is an integer value specifying the allowed bandwidth across the connection. Units are in Mbps.
|