v0.3.0

FacilFlow Documentation

Data pipeline platform for manufacturing analytics — Version 0.3.0

FacilFlow is the central hub for collecting, processing, and delivering industrial data from plant floor systems to analytics applications. It bridges operational technology (OT) and information technology (IT), enabling engineers to build data pipelines without writing code.

Features by Section

Connect

  • Connectors: Airbyte (300+ sources), Telegraf plugins, public API repository, custom sources
  • Edge Agents: Deploy and manage FacilEdge agents at plant sites with Telegraf config generation
  • Data Sources: Browse, register, and test connections to OPC-UA, PI, Modbus, MQTT, databases

Infrastructure

  • Clusters: InfluxDB 3 cluster provisioning with Docker, multi-node topologies, container lifecycle, data explorer

Build

  • Pipelines: Visual drag-and-drop pipeline builder with 10+ node types, templates, test mode, undo/redo
  • ML Models: MLflow integration — experiments, model registry, staging workflows, feature engineering, inference
  • Schemas: Schema versioning with checksums, compatibility checking, rollback, diff comparison

Analyze

  • Dashboards: Widget-based dashboard builder (charts, tables, metrics), sharing with permissions
  • Data Quality: Rule-based quality evaluation (completeness, accuracy, consistency, validity, timeliness), scoring, alerts
  • Lineage: Data lineage graph with upstream/downstream tracking, impact analysis
  • Data Explorer: SQL queries against InfluxDB 3 with time range picker and visualizations

Operate

  • Alerts: Alert rules with conditions, multi-channel delivery (Slack, Email, PagerDuty, Webhook, Teams), escalation
  • Scheduler: Cron and event-based scheduling with execution history and visual cron builder
  • Storage: Multi-cloud object storage (MinIO, S3, Azure Blob, GCS), bucket/object management, presigned URLs
  • Governance: Data classification, resource tagging, audit logs, tenant isolation
  • Jarvis AI: AI assistant with MCP tools, artifact rendering, canvas panel

Platform

  • Authentication: Firebase Auth with email/password and Google SSO
  • RBAC: Admin, Operator, Viewer roles with route guards
Section Description
Quick Start Get running in 5 minutes
Installation Detailed installation options
User Guide All features organized by nav section
Pipelines Visual pipeline builder
Clusters InfluxDB 3 cluster management
ML Models MLflow model registry
Dashboards Dashboard builder
Alerts Alerting and notifications
API Reference REST API documentation

Architecture Overview

graph LR
    subgraph Plant["Plant Floor"]
        PLC[PLCs] --> Edge[FacilEdge Agent]
        SCADA[SCADA] --> Edge
        PI[Historians] --> Edge
    end

    subgraph Cloud["FacilFlow Platform"]
        Edge -->|gRPC/MQTT| API[REST API]
        API --> DB[(InfluxDB 3)]
        API --> PG[(PostgreSQL)]
        API --> Storage[(Object Storage)]
        API --> Redis[(Redis)]
        API --> MLflow[MLflow]
        API --> H2O[H2O AutoML]
        API --> UI[Web UI]
    end

    subgraph Connectors["Data Sources"]
        Airbyte[Airbyte 300+] --> API
        Telegraf[Telegraf] --> API
        CustomAPI[Custom APIs] --> API
    end

    subgraph Apps["Applications"]
        UI --> User[Engineers]
        API --> Jarvis[Jarvis AI]
    end

    style Plant fill:#22C55E,color:#fff
    style Cloud fill:#3B82F6,color:#fff
    style Connectors fill:#F59E0B,color:#fff
    style Apps fill:#8B5CF6,color:#fff

Getting Help

esc