Ignition Guides
Unofficial guides for modern Ignition SCADA infrastructure and workflows.
What Is in Here
Getting Started
Tools and setup required across all guides - set up once, referenced everywhere.
- Workstation Setup - VS Code, Git, GitHub CLI, Docker Desktop, kubectl, helm, terraform, kind
- Traefik Reverse Proxy - Named local URLs for Docker-based guides
- Local Kubernetes Setup - Docker Desktop Kubernetes or kind, with the Ignition Helm chart repo configured
Guides
Step-by-step reference guides for working with Ignition in a professional development environment.
- Docker - Compose architecture, volume strategy, licensing, and day-two operations for the project-template.
- Kubernetes - Running Ignition on a cluster: StatefulSets, PVCs, external secrets, module distribution, and GitOps config sync.
- Observability - Gateway telemetry via the OTel Java agent, and the metrics and log stack that collects and visualizes those signals.
- Version Control - Git workflows for Ignition projects: workstation setup, branching, pull requests, and more.
Labs
Hands-on labs that walk through real Ignition workflows end to end.
- Docker Lab - Start an Ignition gateway from the project-template, watch each service boot, and practice day-two operations.
- Helm Lab - Deploy Ignition to a local Kubernetes cluster using the official Inductive Automation Helm chart, verify persistence across pod restarts, and customize with your own values.
- Version Control Lab - Set up version control for an Ignition project from scratch using Docker and GitHub.
Reference
Quick-reference pages for conventions and standards used across guides.
- Architecture Index - Platform paths ordered start to finish: Kubernetes and Docker Compose.
- Git Style Guide - Naming conventions for repositories, branches, commits, and pull requests.
- Kubernetes Sizing - CPU, memory, JVM heap, PVC, and probe sizing tables for Ignition gateways on Kubernetes.
- OTel Properties Reference - Every OpenTelemetry Java agent property used in the observability guides with descriptions.
- Helm Values Layering - How chart defaults, common, environment, and region values compose in a multi-environment platform.
- Gateway Resource Collections - How Ignition organizes config and project resources on disk, and which paths to track in Git.
- Docker Command Reference - Common Docker and Docker Compose commands for running and operating Ignition gateways.
Tools
Reference pages for community tools built around Ignition.
- Stoker Operator - Git-driven configuration sync for Ignition gateways on Kubernetes.
- ignition-lint - Linter for Ignition project resources.