Edge Deployment Validation Checklist

{"Title":"Edge Deployment Validation Checklist","IntroductionHtml":"

This interactive validation playbook helps site engineers and integrators confirm that an edge stack reliably delivers contextual OT data to IT systems. Use it during commissioning, after configuration changes, and as part of routine verification. Mark each check, attach notes or references to logs, and save the result so your team preserves evidence and can compare runs over time.

Suggested use: run the connectivity and buffering scenarios under normal and simulated-failure conditions, validate schema and units with sample payloads, exercise fallback and retry logic, confirm rollback readiness, and verify monitoring & alerting. If a check fails, record immediate mitigations and a follow-up owner.

","SubmitLabel":"Save Validation","SuccessMessage":"Validation saved. You can re-run this checklist, export results, or link them to a change request.","DataType":"edge-deployment-validation","SchemaVersion":1,"Fields":[{"Key":"connectivity_reachability","Type":"yesno","Label":"Network reachability (ping/connect to broker) - Pass?","HelpText":"Can the gateway reach the intended brokers, endpoints, and IT ingress URLs from its production network?"},{"Key":"connectivity_latency_ms","Type":"number","Label":"Measured round-trip latency (ms)","HelpText":"Average latency measured during test window. Leave blank if not measured.","Required":false},{"Key":"connectivity_packet_loss_pct","Type":"number","Label":"Packet loss (%)","HelpText":"Measured packet loss to destination during test window.","Required":false},{"Key":"timesync_verified","Type":"yesno","Label":"Time synchronization verified","HelpText":"Is NTP/PTP configured and verified?"},{"Key":"timesync_source","Type":"text","Label":"Time source (NTP/PTP/other)","HelpText":"Record the authoritative time source and server(s).","Required":false},{"Key":"timezone_normalization","Type":"yesno","Label":"Timestamps and timezone normalization confirmed","HelpText":"Have you confirmed all timestamps are normalized to the agreed canonical format (e.g., UTC ISO-8601) and timezone handling is documented?"},{"Key":"buffering_configured","Type":"yesno","Label":"Local buffering configured","HelpText":"Is local buffering enabled to handle transient network loss?"},{"Key":"buffer_retention_hours","Type":"number","Label":"Buffer retention duration (hours)","HelpText":"How long can the gateway retain events when offline?","Required":false},{"Key":"buffer_max_events","Type":"number","Label":"Max events queued","HelpText":"Configured upper limit of queued events before overflow behavior triggers.","Required":false},{"Key":"buffer_overflow_behavior","Type":"select","Label":"Behavior on full buffer","HelpText":"What happens when buffer capacity is exhausted?","ValueOptions":[{"Value":"drop_oldest","Label":"Drop oldest"},{"Value":"reject_new","Label":"Reject new events"},{"Value":"persist_to_disk","Label":"Persist to disk"},{"Value":"block_production","Label":"Block production (backpressure)"},{"Value":"other","Label":"Other - see notes"}]},{"Key":"buffer_offline_test_minutes","Type":"number","Label":"Test: simulate network outage (minutes)","HelpText":"Duration used for offline simulation.","Required":false},{"Key":"buffer_offline_result","Type":"yesno","Label":"Offline simulation result - Pass?","HelpText":"Did buffering behave as expected during the simulated outage?"},{"Key":"buffer_offline_evidence","Type":"textarea","Label":"Evidence / where logs are stored","HelpText":"Record log file names, timestamps, or sample messages proving correct buffering behavior."},{"Key":"schema_mapping_applied","Type":"yesno","Label":"Schema and mapping applied","HelpText":"Does the gateway apply the documented schema, field tags, and metadata mapping?"},{"Key":"units_normalized","Type":"yesno","Label":"Units normalized and documented","HelpText":"Were measurement units normalized (e.g., °C vs °F, PSI vs kPa) and documented in mapping?"},{"Key":"timestamp_format_iso","Type":"yesno","Label":"Timestamp format is ISO/UTC","HelpText":"Are timestamps encoded in the canonical agreed format and timezone?"},{"Key":"field_validation_rules","Type":"checkbox","Label":"Field-level validation rules active","HelpText":"Which validation checks are applied on ingress?","ValueOptions":[{"Value":"required_fields","Label":"Required field presence"},{"Value":"range_checks","Label":"Range checks (min/max)"},{"Value":"regex_checks","Label":"Regex/type checks"},{"Value":"dead_sensor_detection","Label":"Dead-sensor / stale-value detection"},{"Value":"unit_checks","Label":"Unit conformance"}]},{"Key":"sample_payload_reference","Type":"textarea","Label":"Sample payload(s) and locations","HelpText":"Reference file paths, packet captures, or dashboard links for sample validated payloads."},{"Key":"message_sequencing","Type":"select","Label":"Message sequencing & deduplication","HelpText":"Does the gateway ensure ordering or provide sequence IDs to suppress duplicates?","ValueOptions":[{"Value":"none","Label":"None"},{"Value":"per_stream","Label":"Per-stream ordering"},{"Value":"global","Label":"Global ordering"},{"Value":"idempotent","Label":"Idempotent messages / dedupe"}]},{"Key":"retry_backoff_configured","Type":"yesno","Label":"Retry and backoff configured","HelpText":"Is an exponential backoff and retry policy defined and tested?"},{"Key":"max_retries","Type":"number","Label":"Max retries configured","HelpText":"Configured maximum retry attempts before giving up.","Required":false},{"Key":"fallback_endpoints","Type":"yesno","Label":"Fallback / alternate endpoints configured","HelpText":"Are alternate ingestion endpoints or store-and-forward destinations configured?"},{"Key":"fallback_behavior_notes","Type":"textarea","Label":"Fallback behavior details","HelpText":"Describe how failover routing or alternate stores are selected."},{"Key":"rollback_plan_tested","Type":"yesno","Label":"Rollback plan tested","HelpText":"Has a rollback been executed in a non-production or controlled window?"},{"Key":"rollback_documented","Type":"yesno","Label":"Rollback steps documented and accessible","HelpText":"Are rollback steps stored in the approved runbook or CMDB?"},{"Key":"rollback_location","Type":"text","Label":"Location of rollback documentation (URL/path)","Required":false},{"Key":"remote_revert_capability","Type":"yesno","Label":"Can configurations be reverted remotely","HelpText":"Can ops revert configuration remotely and safely?"},{"Key":"monitor_alert_buffer_overflow","Type":"yesno","Label":"Alert: buffer overflow","HelpText":"Is an alert configured when buffer depth exceeds threshold?"},{"Key":"monitor_time_drift","Type":"yesno","Label":"Alert: significant time drift","HelpText":"Alert if time sync drifts beyond acceptable window."},{"Key":"monitor_metrics","Type":"checkbox","Label":"Telemetry metrics to collect","HelpText":"Select the metrics configured for health monitoring.","ValueOptions":[{"Value":"connectivity_up","Label":"Connectivity up/down"},{"Value":"buffer_depth","Label":"Buffer depth"},{"Value":"event_rate","Label":"Event in/out rate"},{"Value":"processing_errors","Label":"Processing / validation errors"},{"Value":"last_successful_sync","Label":"Last successful sync timestamp"},{"Value":"disk_usage","Label":"Local storage/disk usage"}]},{"Key":"monitoring_dashboard_location","Type":"text","Label":"Monitoring dashboard or alert URL/location","Required":false},{"Key":"post_validation_actions","Type":"textarea","Label":"Immediate mitigations / actions required","HelpText":"If any checks failed, list triage steps, owners, and due dates."},{"Key":"overall_status","Type":"select","Label":"Overall validation outcome","ValueOptions":[{"Value":"pass","Label":"Pass"},{"Value":"pass_with_minor_issues","Label":"Pass with minor issues"},{"Value":"fail","Label":"Fail - remediation required"}]},{"Key":"validation_notes","Type":"textarea","Label":"Validation summary and notes","HelpText":"High-level summary for stakeholders."},{"Key":"validation_lead","Type":"text","Label":"Validation lead / engineer","HelpText":"Person responsible for this validation run."},{"Key":"validation_date","Type":"text","Label":"Validation date (YYYY-MM-DD)","HelpText":"ISO date when validation was performed."}]}