Skip to content

Latest commit

 

History

History
125 lines (91 loc) · 2.49 KB

deployment.md

File metadata and controls

125 lines (91 loc) · 2.49 KB

SCADA Topology Discovery - Deployment Guide

Prerequisites

  • Node.js 18+
  • AWS CLI configured with appropriate credentials
  • Terraform 1.5+
  • PostgreSQL 13+ (or AWS RDS)
  • Docker (for local Grafana)

Quick Start

1. Clone and Install

git clone https://github.com/yourusername/scada-topology-discovery.git
cd scada-topology-discovery
npm install

2. Configure Environment

cp .env.example .env
# Edit .env with your configuration

3. Deploy Infrastructure

# Initialize and deploy AWS infrastructure
./scripts/deploy-infrastructure.sh dev apply

# Get outputs (IoT endpoint, RDS endpoint, etc.)
./scripts/deploy-infrastructure.sh dev output

4. Generate Certificates

./scripts/generate-certs.sh scada-collector-01

5. Run Database Migrations

./scripts/run-migrations.sh --seed

6. Start Local Development

# Start Grafana and PostgreSQL
cd grafana && docker-compose up -d

# Start collectors
npm run collector:start

Production Deployment

AWS Infrastructure

  1. Configure Variables

    # infrastructure/terraform.tfvars
environment = "prod"
db_instance_class = "db.r6g.large"
enable_deletion_protection = true
alert_email = "security@example.com"

  2. Deploy

    ./scripts/deploy-infrastructure.sh prod apply

  3. Deploy Lambda Functions

    npm run build
./scripts/deploy-lambda.sh prod

Edge Collector Deployment

  1. Install on edge server in OT network
  2. Configure MQTT endpoint from Terraform outputs
  3. Copy certificates to ./certs/
  4. Configure SNMP credentials for devices
  5. Start collector service

Grafana Setup

  1. Access Grafana at configured URL
  2. Import dashboards from grafana/dashboards/
  3. Configure PostgreSQL data source
  4. Set up alert notification channels

Environment Variables

Variable Description Required
IOT_ENDPOINT AWS IoT Core endpoint Yes
DB_HOST PostgreSQL host Yes
DB_PASSWORD Database password Yes
ENCRYPTION_KEY 32-char encryption key Yes
SNMP_AUTH_KEY SNMPv3 auth key Yes
SNMP_PRIV_KEY SNMPv3 priv key Yes

Verification

# Run tests
npm test

# Check collector status
curl http://localhost:8080/health

# Verify database
psql -h $DB_HOST -U $DB_USER -d scada_topology -c "SELECT COUNT(*) FROM devices"

Troubleshooting

See troubleshooting.md for common issues.