From dc3dc5d9c19bd555affd268a5ca92782db417a90 Mon Sep 17 00:00:00 2001 From: Nick Todd Date: Thu, 13 Mar 2025 11:36:24 +0000 Subject: [PATCH] #3110: Correct config YAML snippets. --- docs/source/configuration/agents.rst | 25 +- .../simulation/nodes/computer.rst | 25 +- .../simulation/nodes/firewall.rst | 233 +++++++++--------- .../configuration/simulation/nodes/router.rst | 41 ++- .../configuration/simulation/nodes/server.rst | 17 +- .../configuration/simulation/nodes/switch.rst | 11 +- .../how_to_guides/extensible_agents.rst | 17 +- docs/source/rewards.rst | 66 ++--- .../system/applications/database_client.rst | 20 +- .../system/applications/dos_bot.rst | 30 ++- .../system/applications/web_browser.rst | 18 +- .../system/services/database_service.rst | 18 +- .../system/services/dns_client.rst | 20 +- .../system/services/dns_server.rst | 22 +- .../system/services/ftp_client.rst | 16 +- .../system/services/ftp_server.rst | 18 +- .../system/services/ntp_client.rst | 20 +- .../system/services/ntp_server.rst | 16 +- .../system/services/web_server.rst | 16 +- 19 files changed, 314 insertions(+), 335 deletions(-) diff --git a/docs/source/configuration/agents.rst b/docs/source/configuration/agents.rst index c2674e31..aab60140 100644 --- a/docs/source/configuration/agents.rst +++ b/docs/source/configuration/agents.rst @@ -13,20 +13,19 @@ Agents can be scripted (deterministic and stochastic), or controlled by a reinfo .. code-block:: yaml agents: - - ref: red_agent_example - ... - - ref: blue_agent_example - ... - - ref: green_agent_example - team: GREEN - type: probabilistic-agent + - ref: red_agent_example + ... + - ref: blue_agent_example + ... + - ref: green_agent_example + team: GREEN + type: probabilistic-agent - agent_settings: - start_settings: - start_step: 5 - frequency: 4 - variance: 3 - flatten_obs: False + agent_settings: + start_step: 5 + frequency: 4 + variance: 3 + flatten_obs: False ``ref`` ------- diff --git a/docs/source/configuration/simulation/nodes/computer.rst b/docs/source/configuration/simulation/nodes/computer.rst index 456d11a2..476b6a81 100644 --- a/docs/source/configuration/simulation/nodes/computer.rst +++ b/docs/source/configuration/simulation/nodes/computer.rst @@ -17,19 +17,18 @@ example computer .. code-block:: yaml simulation: - network: - nodes: - - ref: client_1 - hostname: client_1 - type: computer - ip_address: 192.168.0.10 - subnet_mask: 255.255.255.0 - default_gateway: 192.168.0.1 - dns_server: 192.168.1.10 - applications: - ... - services: - ... + network: + nodes: + - hostname: client_1 + type: computer + ip_address: 192.168.0.10c + subnet_mask: 255.255.255.0 + default_gateway: 192.168.0.1 + dns_server: 192.168.1.10 + applications: + ... + services: + ... .. include:: common/common_node_attributes.rst diff --git a/docs/source/configuration/simulation/nodes/firewall.rst b/docs/source/configuration/simulation/nodes/firewall.rst index 84b5c99e..3e553d7b 100644 --- a/docs/source/configuration/simulation/nodes/firewall.rst +++ b/docs/source/configuration/simulation/nodes/firewall.rst @@ -19,38 +19,35 @@ example firewall .. code-block:: yaml simulation: - network: - nodes: - - ref: firewall - hostname: firewall - type: firewall - start_up_duration: 0 - shut_down_duration: 0 - ports: - external_port: # port 1 - ip_address: 192.168.20.1 - subnet_mask: 255.255.255.0 - internal_port: # port 2 - ip_address: 192.168.1.2 - subnet_mask: 255.255.255.0 - dmz_port: # port 3 - ip_address: 192.168.10.1 - subnet_mask: 255.255.255.0 - acl: - internal_inbound_acl: - ... - internal_outbound_acl: - ... - dmz_inbound_acl: - ... - dmz_outbound_acl: - ... - external_inbound_acl: - ... - external_outbound_acl: - ... - routes: - ... + network: + nodes: + - hostname: firewall + type: firewall + ports: + external_port: # port 1 + ip_address: 192.168.20.1 + subnet_mask: 255.255.255.0 + internal_port: # port 2 + ip_address: 192.168.1.2 + subnet_mask: 255.255.255.0 + dmz_port: # port 3 + ip_address: 192.168.10.1 + subnet_mask: 255.255.255.0 + acl: + internal_inbound_acl: + ... + internal_outbound_acl: + ... + dmz_inbound_acl: + ... + dmz_outbound_acl: + ... + external_inbound_acl: + ... + external_outbound_acl: + ... + routes: + ... .. include:: common/common_node_attributes.rst @@ -70,18 +67,18 @@ The ports should be defined with an ip address and subnet mask e.g. .. code-block:: yaml nodes: - - ref: firewall - ... + - hostname: firewall + ... ports: - external_port: # port 1 - ip_address: 192.168.20.1 - subnet_mask: 255.255.255.0 - internal_port: # port 2 - ip_address: 192.168.1.2 - subnet_mask: 255.255.255.0 - dmz_port: # port 3 - ip_address: 192.168.10.1 - subnet_mask: 255.255.255.0 + external_port: # port 1 + ip_address: 192.168.20.1 + subnet_mask: 255.255.255.0 + internal_port: # port 2 + ip_address: 192.168.1.2 + subnet_mask: 255.255.255.0 + dmz_port: # port 3 + ip_address: 192.168.10.1 + subnet_mask: 255.255.255.0 ``ip_address`` """""""""""""" @@ -129,21 +126,21 @@ example: .. code-block:: yaml nodes: - - ref: firewall + - hostname: firewall ... acl: - internal_inbound_acl: - 21: # position 21 on ACL list - action: PERMIT # allow packets that - src_port: POSTGRES_SERVER # are emitted from the POSTGRES_SERVER port - dst_port: POSTGRES_SERVER # are going towards an POSTGRES_SERVER port - 22: # position 22 on ACL list - action: PERMIT # allow packets that - src_port: ARP # are emitted from the ARP port - dst_port: ARP # are going towards an ARP port - 23: # position 23 on ACL list - action: PERMIT # allow packets that - protocol: ICMP # are ICMP + internal_inbound_acl: + 21: # position 21 on ACL list + action: PERMIT # allow packets that + src_port: POSTGRES_SERVER # are emitted from the POSTGRES_SERVER port + dst_port: POSTGRES_SERVER # are going towards an POSTGRES_SERVER port + 22: # position 22 on ACL list + action: PERMIT # allow packets that + src_port: ARP # are emitted from the ARP port + dst_port: ARP # are going towards an ARP port + 23: # position 23 on ACL list + action: PERMIT # allow packets that + protocol: ICMP # are ICMP ``internal_outbound_acl`` """"""""""""""""""""""""" @@ -155,21 +152,21 @@ example: .. code-block:: yaml nodes: - - ref: firewall - ... + - hostname: firewall + ... acl: - internal_outbound_acl: - 21: # position 21 on ACL list - action: PERMIT # allow packets that - src_port: POSTGRES_SERVER # are emitted from the POSTGRES_SERVER port - dst_port: POSTGRES_SERVER # are going towards an POSTGRES_SERVER port - 22: # position 22 on ACL list - action: PERMIT # allow packets that - src_port: ARP # are emitted from the ARP port - dst_port: ARP # are going towards an ARP port - 23: # position 23 on ACL list - action: PERMIT # allow packets that - protocol: ICMP # are ICMP + internal_outbound_acl: + 21: # position 21 on ACL list + action: PERMIT # allow packets that + src_port: POSTGRES_SERVER # are emitted from the POSTGRES_SERVER port + dst_port: POSTGRES_SERVER # are going towards an POSTGRES_SERVER port + 22: # position 22 on ACL list + action: PERMIT # allow packets that + src_port: ARP # are emitted from the ARP port + dst_port: ARP # are going towards an ARP port + 23: # position 23 on ACL list + action: PERMIT # allow packets that + protocol: ICMP # are ICMP ``dmz_inbound_acl`` @@ -216,29 +213,29 @@ example: .. code-block:: yaml nodes: - - ref: firewall - ... - acl: - dmz_outbound_acl: - 19: # position 19 on ACL list - action: PERMIT # allow packets that - src_port: POSTGRES_SERVER # are emitted from the POSTGRES_SERVER port - dst_port: POSTGRES_SERVER # are going towards an POSTGRES_SERVER port - 20: # position 20 on ACL list - action: PERMIT # allow packets that - src_port: HTTP # are emitted from the HTTP port - dst_port: HTTP # are going towards an HTTP port - 21: # position 21 on ACL list - action: PERMIT # allow packets that - src_port: HTTPS # are emitted from the HTTPS port - dst_port: HTTPS # are going towards an HTTPS port - 22: # position 22 on ACL list - action: PERMIT # allow packets that - src_port: ARP # are emitted from the ARP port - dst_port: ARP # are going towards an ARP port - 23: # position 23 on ACL list - action: PERMIT # allow packets that - protocol: ICMP # are ICMP + - hostname: firewall + ... + acl: + dmz_outbound_acl: + 19: # position 19 on ACL list + action: PERMIT # allow packets that + src_port: POSTGRES_SERVER # are emitted from the POSTGRES_SERVER port + dst_port: POSTGRES_SERVER # are going towards an POSTGRES_SERVER port + 20: # position 20 on ACL list + action: PERMIT # allow packets that + src_port: HTTP # are emitted from the HTTP port + dst_port: HTTP # are going towards an HTTP port + 21: # position 21 on ACL list + action: PERMIT # allow packets that + src_port: HTTPS # are emitted from the HTTPS port + dst_port: HTTPS # are going towards an HTTPS port + 22: # position 22 on ACL list + action: PERMIT # allow packets that + src_port: ARP # are emitted from the ARP port + dst_port: ARP # are going towards an ARP port + 23: # position 23 on ACL list + action: PERMIT # allow packets that + protocol: ICMP # are ICMP @@ -254,21 +251,21 @@ example: .. code-block:: yaml nodes: - - ref: firewall - ... - acl: - external_inbound_acl: - 21: # position 19 on ACL list - action: DENY # deny packets that - src_port: POSTGRES_SERVER # are emitted from the POSTGRES_SERVER port - dst_port: POSTGRES_SERVER # are going towards an POSTGRES_SERVER port - 22: # position 22 on ACL list - action: PERMIT # allow packets that - src_port: ARP # are emitted from the ARP port - dst_port: ARP # are going towards an ARP port - 23: # position 23 on ACL list - action: PERMIT # allow packets that - protocol: ICMP # are ICMP + - hostname: firewall + ... + acl: + external_inbound_acl: + 21: # position 19 on ACL list + action: DENY # deny packets that + src_port: POSTGRES_SERVER # are emitted from the POSTGRES_SERVER port + dst_port: POSTGRES_SERVER # are going towards an POSTGRES_SERVER port + 22: # position 22 on ACL list + action: PERMIT # allow packets that + src_port: ARP # are emitted from the ARP port + dst_port: ARP # are going towards an ARP port + 23: # position 23 on ACL list + action: PERMIT # allow packets that + protocol: ICMP # are ICMP ``external_outbound_acl`` """"""""""""""""""""""""" @@ -282,17 +279,17 @@ example: .. code-block:: yaml nodes: - - ref: firewall - ... + - hotsname: firewall + ... acl: - external_outbound_acl: - 22: # position 22 on ACL list - action: PERMIT # allow packets that - src_port: ARP # are emitted from the ARP port - dst_port: ARP # are going towards an ARP port - 23: # position 23 on ACL list - action: PERMIT # allow packets that - protocol: ICMP # are ICMP + external_outbound_acl: + 22: # position 22 on ACL list + action: PERMIT # allow packets that + src_port: ARP # are emitted from the ARP port + dst_port: ARP # are going towards an ARP port + 23: # position 23 on ACL list + action: PERMIT # allow packets that + protocol: ICMP # are ICMP .. include:: common/common_network_node_attributes.rst diff --git a/docs/source/configuration/simulation/nodes/router.rst b/docs/source/configuration/simulation/nodes/router.rst index ee278a98..50f40191 100644 --- a/docs/source/configuration/simulation/nodes/router.rst +++ b/docs/source/configuration/simulation/nodes/router.rst @@ -17,16 +17,15 @@ example router .. code-block:: yaml simulation: - network: - nodes: - - ref: router_1 - hostname: router_1 - type: router - num_ports: 5 - ports: - ... - acl: - ... + network: + nodes: + - hostname: router_1 + type: router + num_ports: 5 + ports: + ... + acl: + ... .. include:: common/common_node_attributes.rst @@ -49,15 +48,15 @@ Example of setting ports for a router with 2 ports: .. code-block:: yaml nodes: - - ref: router_1 + - hostname: router_1 ... ports: - 1: - ip_address: 192.168.1.1 - subnet_mask: 255.255.255.0 - 2: - ip_address: 192.168.10.1 - subnet_mask: 255.255.255.0 + 1: + ip_address: 192.168.1.1 + subnet_mask: 255.255.255.0 + 2: + ip_address: 192.168.10.1 + subnet_mask: 255.255.255.0 ``ip_address`` """""""""""""" @@ -81,12 +80,12 @@ e.g. .. code-block:: yaml nodes: - - ref: router_1 + - hostname: router_1 ... acl: - 1: - action: PERMIT - protocol: ICMP + 1: + action: PERMIT + protocol: ICMP See :py:mod:`primaite.simulator.network.hardware.nodes.network.router.AccessControlList` diff --git a/docs/source/configuration/simulation/nodes/server.rst b/docs/source/configuration/simulation/nodes/server.rst index 616efb38..a21ba778 100644 --- a/docs/source/configuration/simulation/nodes/server.rst +++ b/docs/source/configuration/simulation/nodes/server.rst @@ -19,16 +19,15 @@ example server simulation: network: nodes: - - ref: server_1 - hostname: server_1 - type: server - ip_address: 192.168.10.10 - subnet_mask: 255.255.255.0 - default_gateway: 192.168.10.1 - dns_server: 192.168.1.10 - applications: + - hostname: server_1 + type: server + ip_address: 192.168.10.10 + subnet_mask: 255.255.255.0 + default_gateway: 192.168.10.1 + dns_server: 192.168.1.10 + applications: ... - services: + services: ... .. include:: common/common_node_attributes.rst diff --git a/docs/source/configuration/simulation/nodes/switch.rst b/docs/source/configuration/simulation/nodes/switch.rst index d09f5ba7..af940eac 100644 --- a/docs/source/configuration/simulation/nodes/switch.rst +++ b/docs/source/configuration/simulation/nodes/switch.rst @@ -17,12 +17,11 @@ example switch .. code-block:: yaml simulation: - network: - nodes: - - ref: switch_1 - hostname: switch_1 - type: switch - num_ports: 8 + network: + nodes: + hostname: switch_1 + type: switch + num_ports: 8 .. include:: common/common_node_attributes.rst diff --git a/docs/source/how_to_guides/extensible_agents.rst b/docs/source/how_to_guides/extensible_agents.rst index e02bcfae..7713a554 100644 --- a/docs/source/how_to_guides/extensible_agents.rst +++ b/docs/source/how_to_guides/extensible_agents.rst @@ -45,20 +45,21 @@ Agent generation will fail pydantic checks if incorrect or invalid parameters ar .. code-block:: yaml - ref: example_green_agent - team: GREEN - type: example-agent + team: GREEN + type: example-agent - action_space: - action_map: - 0: - action: do-nothing - options: {} - agent_settings: + agent_settings: start_step: 25 frequency: 20 variance: 5 starting_host: "Server_1" + action_space: + action_map: + 0: + action: do-nothing + options: {} + **discriminators**: diff --git a/docs/source/rewards.rst b/docs/source/rewards.rst index 3fc464ea..b6bff41a 100644 --- a/docs/source/rewards.rst +++ b/docs/source/rewards.rst @@ -25,8 +25,8 @@ The following API pages describe the use of each reward component and the possib # ... reward_function: reward_components: - - type: dummy - weight: 1.0 + - type: dummy + weight: 1.0 :py:class:`primaite.game.agent.rewards.DatabaseFileIntegrity` @@ -38,12 +38,12 @@ The following API pages describe the use of each reward component and the possib # ... reward_function: reward_components: - - type: database-file-integrity - weight: 1.0 - options: - node_hostname: server_1 - folder_name: database - file_name: database.db + - type: database-file-integrity + weight: 1.0 + options: + node_hostname: server_1 + folder_name: database + file_name: database.db :py:class:`primaite.game.agent.rewards.WebServer404Penalty` @@ -55,12 +55,12 @@ The following API pages describe the use of each reward component and the possib # ... reward_function: reward_components: - - type: web-server-404-penalty - node_hostname: web_server - weight: 1.0 - options: - service_name: WebService - sticky: false + - type: web-server-404-penalty + node_hostname: web_server + weight: 1.0 + options: + service_name: WebService + sticky: false :py:class:`primaite.game.agent.rewards.WebpageUnavailablePenalty` @@ -72,11 +72,11 @@ The following API pages describe the use of each reward component and the possib # ... reward_function: reward_components: - - type: webpage-unavailable-penalty - node_hostname: computer_1 - weight: 1.0 - options: - sticky: false + - type: webpage-unavailable-penalty + node_hostname: computer_1 + weight: 1.0 + options: + sticky: false :py:class:`primaite.game.agent.rewards.GreenAdminDatabaseUnreachablePenalty` @@ -88,11 +88,11 @@ The following API pages describe the use of each reward component and the possib # ... reward_function: reward_components: - - type: green-admin-database-unreachable-penalty - weight: 1.0 - options: - node_hostname: admin_pc_1 - sticky: false + - type: green-admin-database-unreachable-penalty + weight: 1.0 + options: + node_hostname: admin_pc_1 + sticky: false :py:class:`primaite.game.agent.rewards.SharedReward` @@ -106,10 +106,10 @@ The following API pages describe the use of each reward component and the possib # ... reward_function: reward_components: - - type: shared-reward - weight: 1.0 - options: - agent_name: scripted_agent + - type: shared-reward + weight: 1.0 + options: + agent_name: scripted_agent :py:class:`primaite.game.agent.rewards.ActionPenalty` @@ -121,8 +121,8 @@ The following API pages describe the use of each reward component and the possib # ... reward_function: reward_components: - - type: action-penalty - weight: 1.0 - options: - action_penalty: -0.3 - do_nothing_penalty: 0.0 + - type: action-penalty + weight: 1.0 + options: + action_penalty: -0.3 + do_nothing_penalty: 0.0 diff --git a/docs/source/simulation_components/system/applications/database_client.rst b/docs/source/simulation_components/system/applications/database_client.rst index 324db17e..18f55efd 100644 --- a/docs/source/simulation_components/system/applications/database_client.rst +++ b/docs/source/simulation_components/system/applications/database_client.rst @@ -76,17 +76,15 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - ref: example_computer - hostname: example_computer - type: computer - ... - applications: - - ref: database_client - type: database-client - options: - db_server_ip: 192.168.0.1 + network: + nodes: + - hostname: example_computer + type: computer + ... + applications: + - type: database-client + options: + db_server_ip: 192.168.0.1 Configuration ============= diff --git a/docs/source/simulation_components/system/applications/dos_bot.rst b/docs/source/simulation_components/system/applications/dos_bot.rst index e6e03cfe..1ccf9500 100644 --- a/docs/source/simulation_components/system/applications/dos_bot.rst +++ b/docs/source/simulation_components/system/applications/dos_bot.rst @@ -79,22 +79,20 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - ref: example_computer - hostname: example_computer - type: computer - ... - applications: - - ref: dos_bot - type: dos-bot - options: - target_ip_address: 192.168.0.10 - payload: SPOOF DATA - repeat: False - port_scan_p_of_success: 0.8 - dos_intensity: 1.0 - max_sessions: 1000 + network: + nodes: + - hostname: example_computer + type: computer + ... + applications: + - type: dos-bot + options: + target_ip_address: 192.168.0.10 + payload: SPOOF DATA + repeat: False + port_scan_p_of_success: 0.8 + dos_intensity: 1.0 + max_sessions: 1000 Configuration ============= diff --git a/docs/source/simulation_components/system/applications/web_browser.rst b/docs/source/simulation_components/system/applications/web_browser.rst index 88527caf..d99feacd 100644 --- a/docs/source/simulation_components/system/applications/web_browser.rst +++ b/docs/source/simulation_components/system/applications/web_browser.rst @@ -78,15 +78,15 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - hostname: example_computer - type: computer - ... - applications: - - type: web-browser - options: - target_url: http://example.com/ + network: + nodes: + - hostname: example_computer + type: computer + ... + applications: + - type: web-browser + options: + target_url: http://example.com/ Configuration ============= diff --git a/docs/source/simulation_components/system/services/database_service.rst b/docs/source/simulation_components/system/services/database_service.rst index c89560a8..b85f33cc 100644 --- a/docs/source/simulation_components/system/services/database_service.rst +++ b/docs/source/simulation_components/system/services/database_service.rst @@ -80,15 +80,15 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - hostname: example_server - type: server - ... - services: - - type: database-service - options: - backup_server_ip: 192.168.0.10 + network: + nodes: + - hostname: example_server + type: server + ... + services: + - type: database-service + options: + backup_server_ip: 192.168.0.10 Configuration ============= diff --git a/docs/source/simulation_components/system/services/dns_client.rst b/docs/source/simulation_components/system/services/dns_client.rst index 9d131288..35353584 100644 --- a/docs/source/simulation_components/system/services/dns_client.rst +++ b/docs/source/simulation_components/system/services/dns_client.rst @@ -70,17 +70,15 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - ref: example_server - hostname: example_server - type: server - ... - services: - - ref: dns_client - type: dns-client - options: - dns_server: 192.168.0.10 + network: + nodes: + - hostname: example_server + type: server + ... + services: + - type: dns-client + options: + dns_server: 192.168.0.10 Configuration ============= diff --git a/docs/source/simulation_components/system/services/dns_server.rst b/docs/source/simulation_components/system/services/dns_server.rst index 53b47c54..aa28f329 100644 --- a/docs/source/simulation_components/system/services/dns_server.rst +++ b/docs/source/simulation_components/system/services/dns_server.rst @@ -67,17 +67,17 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - hostname: example_server - type: server - ... - services: - - type: dns-server - options: - domain_mapping: - example.com: 192.168.0.10 - another-example.com: 192.168.10.10 + network: + nodes: + - hostname: example_server + type: server + ... + services: + - type: dns-server + options: + domain_mapping: + example.com: 192.168.0.10 + another-example.com: 192.168.10.10 Configuration ============= diff --git a/docs/source/simulation_components/system/services/ftp_client.rst b/docs/source/simulation_components/system/services/ftp_client.rst index be4d73e4..b105ba8c 100644 --- a/docs/source/simulation_components/system/services/ftp_client.rst +++ b/docs/source/simulation_components/system/services/ftp_client.rst @@ -71,15 +71,13 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - ref: example_server - hostname: example_server - type: server - ... - services: - - ref: ftp_client - type: ftp-client + network: + nodes: + - hostname: example_server + type: server + ... + services: + - type: ftp-client Configuration ============= diff --git a/docs/source/simulation_components/system/services/ftp_server.rst b/docs/source/simulation_components/system/services/ftp_server.rst index 390e76ec..19b1b01b 100644 --- a/docs/source/simulation_components/system/services/ftp_server.rst +++ b/docs/source/simulation_components/system/services/ftp_server.rst @@ -67,15 +67,15 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - hostname: example_server - type: server - ... - services: - - type: ftp-server - options: - server_password: test + network: + nodes: + - hostname: example_server + type: server + ... + services: + - type: ftp-server + options: + server_password: test Configuration ============= diff --git a/docs/source/simulation_components/system/services/ntp_client.rst b/docs/source/simulation_components/system/services/ntp_client.rst index 29215a2d..e45064f9 100644 --- a/docs/source/simulation_components/system/services/ntp_client.rst +++ b/docs/source/simulation_components/system/services/ntp_client.rst @@ -66,17 +66,15 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - ref: example_server - hostname: example_server - type: server - ... - services: - - ref: ntp_client - type: ntp-client - options: - ntp_server_ip: 192.168.0.10 + network: + nodes: + - hostname: example_server + type: server + ... + services: + - type: ntp-client + options: + ntp_server_ip: 192.168.0.10 Configuration ============= diff --git a/docs/source/simulation_components/system/services/ntp_server.rst b/docs/source/simulation_components/system/services/ntp_server.rst index 57efab4d..440f6894 100644 --- a/docs/source/simulation_components/system/services/ntp_server.rst +++ b/docs/source/simulation_components/system/services/ntp_server.rst @@ -66,15 +66,13 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - ref: example_server - hostname: example_server - type: server - ... - services: - - ref: ntp_server - type: ntp-server + network: + nodes: + - hostname: example_server + type: server + ... + services: + - type: ntp-server ``Common Attributes`` diff --git a/docs/source/simulation_components/system/services/web_server.rst b/docs/source/simulation_components/system/services/web_server.rst index dece2251..55a99cfd 100644 --- a/docs/source/simulation_components/system/services/web_server.rst +++ b/docs/source/simulation_components/system/services/web_server.rst @@ -66,15 +66,13 @@ Via Configuration .. code-block:: yaml simulation: - network: - nodes: - - ref: example_server - hostname: example_server - type: server - ... - services: - - ref: web_server - type: web-server + network: + nodes: + - hostname: example_server + type: server + ... + services: + - type: web-server ``Common Attributes``