Data streaming IP addressing scheme docs

doc/specific_iocs/datastreaming/Datastreaming-networking.md

@@ -0,0 +1,23 @@
+# Data streaming: networking
+
+The data streaming system requires several items to be on the same network:
+- `kafka_dae_control` (speaks UDP to streaming control board)
+- `event_udp_to_kafka` (receives UDP from detector modules, converts and forwards them to Kafka)
+- Streaming control board
+  - Control port which `kafka_dae_control` communicates with
+  - Status packet port which UDP headers come out of (which get processed by `event_udp_to_kafka`)
+- Monitors
+- Detectors
+
+The current standard for network addressing is:
+- `192.168.1.1` is the address of the streaming server, which will currently host both `kafka_dae_control` and `event_udp_to_kafka` processes
+  - It is possible, in future, that these two processes may run on different servers and therefore with different IPs
+- `192.168.1.250` to be the streaming control board's control port
+- `192.168.1.251` to be the streaming control board's status-packet port
+- `192.168.1.252` to be streaming monitors
+- The rest of the range to be streaming detectors
+
+:::{note}
+All of these IP addresses are on a private network which is **NOT** the same as the usual NDX/NDH private network.
+This is a private network only used by the streaming server and streaming hardware. It therefore does not conflict with IP addresses on the NDX/NDH instrument private network.
+:::

doc/specific_iocs/datastreaming/Datastreaming-vetos.md

@@ -1,4 +1,4 @@
-# Data streaming - Vetoes
+# Data streaming: Vetoes
 
 Vetoes are essentially a way of telling either the detector acquisition hardware (with a `hard` veto) or downstream consumers of event data (`soft` veto) to ignore a set of events in a frame conditionally based on a signal (whether that's an internal state, electrical signal or a software-based condition).
 

doc/specific_iocs/datastreaming/Datastreaming_hardware_requirements.md

@@ -1,4 +1,4 @@
-# Data streaming server hardware requirements
+# Data streaming: server hardware requirements
 
 This page aims to set a standard for the hardware requirements for the HRPD-X, SANDALS-II, WISH and VESUVIO instrument upgrades.
 

doc/specific_iocs/datastreaming/Datastreaming_udp_packet_formats.md

@@ -1,4 +1,4 @@
-# Datastreaming: UDP packet formats
+# Data streaming: UDP packet formats
 
 This page describes the UDP packet format for instruments which stream UDP from detectors (e.g. HRPD-X).