Welcome to HEAT
HEAT is a scalable platform for ingestion, storage, analytics, and visualization. You define session templates (processing graphs), push data through ingests or integrator APIs, and view results in the dashboard.
This documentation is for system administrators, integrators, and developers configuring and extending a HEAT environment.
Getting Started
1. Understand core concepts
HEAT turns raw data into insights through four steps:
- Capture: Ingest from simulators, capture clients, or HTTP uploads.
- Store: Persist data in configured data sources (blob store, databases).
- Analyze: Run runners defined by session templates.
- Visualize: View results in the Next dashboard.
See Core concepts for projects, sessions, session templates, node templates, and runners.
2. Explore services and tools
| Area | Doc |
|---|---|
| Cluster Manager | Admin UI: users, projects, templates, monitoring |
| HEAT v2 API | External HTTP API for sessions, uploads, dashboard |
| HEAT Auth offline tokens | Long-lived tokens for automation |
| HEAT.Common client | .NET client for uploads and sessions |
| Runners | Built-in processing node templates |
| Bulk analytics | Large-scale CSV ingest, SQL analytics, optional Arbex dashboards |
| Next dashboard components | v2 layout and dataservice widgets |
Authentication and login flows are hosted through Cluster Manager. The analytics dashboard uses the v2 API and HEAT Auth.
3. Environment setup
HEAT runs on Kubernetes (Azure, on-premises, or local lab clusters). This guide set does not cover installing a new HEAT instance.
See Deployment introduction and Environment requirements for profiles, URLs, and prerequisites.
4. Ingest your first data
Typical setup:
- A simulation or integration that POSTs to HEAT.
- A data source for stored artifacts.
- A session template (processing DAG).
- An ingest endpoint tied to that template and a project.
- Dashboard layout and dataservice output from a
dashboard-v2(or legacy) node.
Configure ingests and templates in Cluster Manager, or via the v2 API and HEAT.Common.
See Ingests for ingest endpoints and options.
5. Go further
- Session management: review runs and outputs.
- Building node templates: custom runners.
- Dashboard customization: v2 widgets and dataservice.
- Data service guide: realms, channels, layout binding.
- Security: TLS and access patterns.