Blueprint
A Blueprint is a deployment template for an entire environment. While Modules define reusable capabilities, a Blueprint defines how an environment should be composed and deployed as a whole.
What is a Blueprint?
Blueprints allow you to capture:
- The complete set of Modules that make up an environment
- Their configuration
- Their relationships
- Their coordinated lifecycle
In essence, a Blueprint answers: "What should this environment look like?"
What a Blueprint Contains
A Blueprint can define:
- A collection of Modules and their versions
- Environment-specific configuration
- Deployment topology
- Upgrade coordination rules
Rather than manually installing and configuring Modules one by one, a Blueprint allows you to deploy a fully defined environment in a single step.
Why Blueprints Matter
Blueprints are particularly useful when:
- You want every developer to run the same system locally
- You want staging to mirror production
- You need repeatable environment creation
- You want to distribute a standard application stack across teams
For example, you might define a Production Blueprint that includes an Authentication Module, API Gateway Module, Core Application Module, Observability Module, and Database Module. Any team member can then deploy this Blueprint into their local developer environment, a cloud-based dev environment, or a staging environment — ensuring architectural consistency and eliminating configuration drift.
Versioning and Distribution
Blueprints are versioned, shareable, and upgradeable. You can release a new version of a Blueprint, and users can choose to upgrade their environments to match the updated deployment template. This makes Blueprints the mechanism for distributing and evolving entire environment topologies over time.
Blueprints Are Optional
Blueprints are not required. Users can:
- Install Modules directly into environments
- Manage environments manually
- Or use Blueprints for structured, repeatable deployments
Blueprints are an organisational and distribution tool — not a mandatory layer. They provide consistency and repeatability without restricting flexibility.