Skip to content

IronShep POC documentation

Deployment and technology reference for the IronShep proof-of-concept — the two-binary OT monitoring stack:

  • ironshep-core — gRPC/mTLS ingest server, TimescaleDB writer, and the embedded web console.
  • ironshep-edge — site-local protocol collector (syslog, SNMP traps + v2c polling, MQTT, Modbus, OPC-UA, BACnet) that forwards to core.

The shipping artefact is two static binaries — no runtime, no container required.

Start here

  • :material-server-network: 3-host RHEL 9 deployment

    The full walkthrough: database host, core host, edge host — in order, with the ports and placeholders spelled out.

  • :material-laptop: All-in-one on a Mac

    Run the whole stack on one machine for dev or a demo, with captured output from a real run.

  • :material-rocket-launch-outline: Deploy from a release bundle

    The no-toolchain path: download a CI-built release, verify, drop in place, restart.

  • :material-cog-refresh: Redeploy after a code change

    Swap the binary and restart on an already-installed host; schema and proto-contract notes included.

  • :material-package-variant: Technology inventory

    Exact versions of every dependency, toolchain, and service, read from the resolved graph rather than the manifest ranges.

How releases work

Both ironshep-core and ironshep-edge build on GitLab CI. Pushing a semver tag (git tag v0.2.0 && git push origin v0.2.0) builds a RHEL 9-compatible binary and publishes a GitLab Release with a ready-to-deploy bundle — see Deploy from a release bundle for the install/upgrade steps.

Source

Repo Purpose
ironshep-core ingest server + console + DB
ironshep-edge protocol collector
ironshep-docs this documentation