Merged PR 604: #3060 - Adding version to YAML files within PrimAITE

## Summary Configuration YAML's updated to include the version of PrimAITE for which they were written for ## Checklist - [ ] PR is linked to a **work item** - [ ] **acceptance criteria** of linked ticket are met - [ ] performed **self-review** of the code - [ ] written **tests** for any new functionality added with this PR - [ ] updated the **documentation** if this PR changes or adds functionality - [ ] written/updated **design docs** if this PR implements new functionality - [ ] updated the **change log** - [ ] ran **pre-commit** checks for code style - [ ] attended to any **TO-DOs** left in the code Related work items: #3060
2025-02-17 10:22:49 +00:00
parent e288572e0b bf30b70bd2
commit 4f0e612608
35 changed files with 102 additions and 1 deletions
--- a/docs/source/how_to_guides/extensible_nodes.rst
+++ b/docs/source/how_to_guides/extensible_nodes.rst
@@ -52,4 +52,4 @@ class Router(NetworkNode, identifier="router"):
 Changes to YAML file.
 =====================

-While effort has been made to ensure that nodes defined within configuration YAML files for use with PrimAITE 3.X remain compatible with PrimAITE v4+, it is encouraged to review for minor changes needed. 
+While effort has been made to ensure that nodes defined within configuration YAML files for use with PrimAITE 3.X remain compatible with PrimAITE v4+, it is encouraged to review for minor changes needed.
--- a/src/primaite/config/_package_data/basic_lan_network_example.yaml
+++ b/src/primaite/config/_package_data/basic_lan_network_example.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 game:
  ports:
  - ARP
--- a/src/primaite/config/_package_data/client_server_p2p_network_example.yaml
+++ b/src/primaite/config/_package_data/client_server_p2p_network_example.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 game:
  ports:
  - ARP
--- a/src/primaite/config/_package_data/data_manipulation.yaml
+++ b/src/primaite/config/_package_data/data_manipulation.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: true
  save_step_metadata: false
--- a/src/primaite/config/_package_data/data_manipulation_marl.yaml
+++ b/src/primaite/config/_package_data/data_manipulation_marl.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: true
  save_step_metadata: false
--- a/src/primaite/config/_package_data/mini_scenario_with_simulation_variation/base_scenario.yaml
+++ b/src/primaite/config/_package_data/mini_scenario_with_simulation_variation/base_scenario.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 game:
  max_episode_length: 128
  ports: []
--- a/src/primaite/config/_package_data/multi_lan_internet_network_example.yaml
+++ b/src/primaite/config/_package_data/multi_lan_internet_network_example.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 game:
  ports:
  - ARP
--- a/src/primaite/config/_package_data/scenario_with_placeholders/scenario.yaml
+++ b/src/primaite/config/_package_data/scenario_with_placeholders/scenario.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: true
  save_step_metadata: false
--- a/tests/assets/configs/action_penalty.yaml
+++ b/tests/assets/configs/action_penalty.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: false
  save_step_metadata: false
--- a/tests/assets/configs/bad_primaite_session.yaml
+++ b/tests/assets/configs/bad_primaite_session.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 game:
  ports:
  - ARP
--- a/tests/assets/configs/basic_c2_setup.yaml
+++ b/tests/assets/configs/basic_c2_setup.yaml
@@ -4,6 +4,9 @@
 #  |  node_a  |------|  switch_1  |------|  node_b  |
 #  --------------      --------------      --------------
 #
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/basic_firewall.yaml
+++ b/tests/assets/configs/basic_firewall.yaml
@@ -4,6 +4,8 @@
 #  |  client_1  |------|  switch_1  |------|  client_2  |
 #  --------------      --------------      --------------
 #
+metadata:
+    version: 3.0

 io_settings:
  save_step_metadata: false
--- a/tests/assets/configs/basic_node_with_software_listening_ports.yaml
+++ b/tests/assets/configs/basic_node_with_software_listening_ports.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/basic_node_with_users.yaml
+++ b/tests/assets/configs/basic_node_with_users.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/basic_switched_network.yaml
+++ b/tests/assets/configs/basic_switched_network.yaml
@@ -4,6 +4,9 @@
 #  |  client_1  |------|  switch_1  |------|  client_2  |
 #  --------------      --------------      --------------
 #
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/data_manipulation.yaml
+++ b/tests/assets/configs/data_manipulation.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: true
  save_step_metadata: false
--- a/tests/assets/configs/dmz_network.yaml
+++ b/tests/assets/configs/dmz_network.yaml
@@ -30,6 +30,9 @@
 #                        |  external_computer  |------|  switch_3  |------|  external_server  |
 #                        -----------------------      --------------      ---------------------
 #
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/eval_only_primaite_session.yaml
+++ b/tests/assets/configs/eval_only_primaite_session.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 game:
  ports:
  - ARP
--- a/tests/assets/configs/extended_config.yaml
+++ b/tests/assets/configs/extended_config.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: true
  save_step_metadata: false
--- a/tests/assets/configs/firewall_actions_network.yaml
+++ b/tests/assets/configs/firewall_actions_network.yaml
@@ -30,6 +30,9 @@
 #                        |  external_computer  |------|  switch_3  |------|  external_server  |
 #                        -----------------------      --------------      ---------------------
 #
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/fixing_duration_one_item.yaml
+++ b/tests/assets/configs/fixing_duration_one_item.yaml
@@ -4,6 +4,9 @@
 #  |  client_1  |------|  switch_1  |------|  client_2  |
 #  --------------      --------------      --------------
 #
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/install_and_configure_apps.yaml
+++ b/tests/assets/configs/install_and_configure_apps.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: false
--- a/tests/assets/configs/multi_agent_session.yaml
+++ b/tests/assets/configs/multi_agent_session.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: false
  save_step_metadata: false
--- a/tests/assets/configs/nmap_network_service_recon_red_agent_config.yaml
+++ b/tests/assets/configs/nmap_network_service_recon_red_agent_config.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/nmap_ping_scan_red_agent_config.yaml
+++ b/tests/assets/configs/nmap_ping_scan_red_agent_config.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/nmap_port_scan_red_agent_config.yaml
+++ b/tests/assets/configs/nmap_port_scan_red_agent_config.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/no_nodes_links_agents_network.yaml
+++ b/tests/assets/configs/no_nodes_links_agents_network.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/scenario_with_placeholders/scenario.yaml
+++ b/tests/assets/configs/scenario_with_placeholders/scenario.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: true
  save_step_metadata: false
--- a/tests/assets/configs/shared_rewards.yaml
+++ b/tests/assets/configs/shared_rewards.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: false
  save_step_metadata: false
--- a/tests/assets/configs/software_fixing_duration.yaml
+++ b/tests/assets/configs/software_fixing_duration.yaml
@@ -4,6 +4,9 @@
 #  |  client_1  |------|  switch_1  |------|  client_2  |
 #  --------------      --------------      --------------
 #
+metadata:
+    version: 3.0
+
 io_settings:
  save_step_metadata: false
  save_pcap_logs: true
--- a/tests/assets/configs/test_application_install.yaml
+++ b/tests/assets/configs/test_application_install.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: true
  save_step_metadata: false
--- a/tests/assets/configs/test_primaite_session.yaml
+++ b/tests/assets/configs/test_primaite_session.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 io_settings:
  save_agent_actions: true
  save_step_metadata: true
--- a/tests/assets/configs/wireless_wan_network_config.yaml
+++ b/tests/assets/configs/wireless_wan_network_config.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 game:
  max_episode_length: 256
  ports:
--- a/tests/assets/configs/wireless_wan_network_config_freq_max_override.yaml
+++ b/tests/assets/configs/wireless_wan_network_config_freq_max_override.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 game:
  max_episode_length: 256
  ports:
--- a/tests/assets/configs/wireless_wan_network_config_freq_max_override_blocked.yaml
+++ b/tests/assets/configs/wireless_wan_network_config_freq_max_override_blocked.yaml
@@ -1,3 +1,6 @@
+metadata:
+    version: 3.0
+
 game:
  max_episode_length: 256
  ports: