Core ConceptsΒΆ
InfraKitchen introduces several key concepts that work together to enable self-service infrastructure provisioning. This page explains each concept and how they relate to each other.
π IntegrationΒΆ
An Integration stores the credentials and configuration needed to connect to external systems.
Types of IntegrationsΒΆ
-
Cloud Providers: AWS, Azure, Google Cloud, MongoDB Atlas, Datadog
-
Git Providers: GitHub, Bitbucket, Azure DevOps
-
Auth Providers: GitHub OAuth, Microsoft OAuth, Backstage integration, Service Accounts
Learn more: Integrations Documentation
π TemplateΒΆ
A Template defines a logical unit of infrastructure. Templates are organized hierarchically and represent components like AWS Accounts, VPCs, EKS Clusters, or RDS databases.
Template Hierarchy ExampleΒΆ
AWS Account (abstract)
βββ AWS Region (abstract)
β βββ VPC (concrete)
β β βββ EKS Cluster (concrete)
β β βββ RDS Database (concrete)
β β βββ Application Load Balancer (concrete)
β βββ S3 Bucket (concrete)
Learn more: Templates Documentation
ποΈ ProjectΒΆ
A Project groups related resources under shared ownership, access rules, inherited defaults, and an optional shared workspace.
Projects are useful when you want to organize infrastructure by team, product, or environment without creating an abstract resource just for governance. They can provide shared dependency tags, dependency config defaults, and a common workspace boundary for resources in the project.
Learn more: Projects Documentation
π¦ Source CodeΒΆ
InfraKitchen embraces Infrastructure-as-Code (IaC). Source Code refers to a Git repository containing Terraform/OpenTofu modules.
Source Code ComponentsΒΆ
- Repository URL - Where the IaC code is stored
- Git Provider Integration - Credentials to access the repository
- Multiple Modules - One repository can contain multiple infrastructure modules
Example:
Repository: github.com/myorg/terraform-modules
βββ aws-vpc/
βββ aws-eks/
βββ aws-rds/
βοΈ ExecutorΒΆ
An Executor is a specialized component for running infrastructure modules that perform specific, non-reusable tasks.
Use CasesΒΆ
Unlike Templates that define reusable infrastructure patterns, Executors are designed for:
- One-time operations - Database migrations, data imports, cleanup tasks
- Specialized workflows - Custom scripts that don't fit the template model
- Utility tasks - Infrastructure operations that aren't meant to be templated
Executor PropertiesΒΆ
ID: exec-xyz789
Name: database-migration-v2
Runtime: opentofu
Command: -var-file=environments/dev/eu-west-1.tfvars
Source Code: github.com/myorg/utility-scripts
Version: v2.1.0
Module Path: migrations/database-v2/
Integrations:
- AWS Production Account
- Database Credentials
State: provisioned
Status: done
Key Differences from ResourcesΒΆ
- Not templated - Executors run specific modules directly
- Task-oriented - Designed for single-purpose operations
- No hierarchy - Executors don't follow parent-child relationships
Learn more: Executors Documentation
οΏ½ BlueprintΒΆ
A Blueprint is a reusable definition that combines multiple Templates into a single, executable plan. Blueprints define which infrastructure components to provision and how their outputs wire together β turning a multi-resource stack into a one-click operation.
What a Blueprint ContainsΒΆ
- Templates β ordered list of infrastructure components to provision
- Wiring Rules β output β input mappings between templates
- Default Variables β pre-configured values per template
- Configuration β general blueprint settings
- Labels β tags for organizing and filtering
How Blueprints WorkΒΆ
- Select templates that make up your infrastructure stack
- Define wiring rules to connect outputs to inputs across templates
- Set default variables for consistent values across executions
- Execute the blueprint β a Workflow is created with steps in topological order
- Each step provisions a resource, passing outputs from completed steps to downstream steps
Key FeaturesΒΆ
- Multi-resource orchestration β provision entire environments in one click
- Automatic dependency resolution β wiring rules define the execution graph
- Reusable definitions β execute the same blueprint for dev, staging, and production
- Variable overrides β customize each execution without modifying the blueprint
Learn more: Blueprints Documentation
οΏ½π WorkflowΒΆ
A Workflow is an automated execution plan that orchestrates the provisioning of multiple resources in dependency order. Workflows are created from Blueprints.
How Workflows WorkΒΆ
- A Blueprint defines templates and wiring rules (output β input mappings)
- When executed, a Workflow is created with steps sorted in topological order
- Each step provisions a resource, passing outputs from completed steps to downstream steps
Workflow ExampleΒΆ
Blueprint: Production Environment
Wiring:
- VPC.vpc_id β EKS Cluster.vpc_id
- VPC.private_subnet_ids β EKS Cluster.subnet_ids
- VPC.vpc_id β RDS Database.vpc_id
Execution Order:
Level 0: VPC (no dependencies)
Level 1: EKS Cluster, RDS Database (parallel, both depend on VPC)
Key FeaturesΒΆ
- Automatic dependency resolution via topological sort
- Output wiring β upstream outputs feed into downstream inputs
- Parallel execution β independent steps run simultaneously
- Step-level tracking β monitor progress per resource
Learn more: Workflows Documentation
π¦ ResourceΒΆ
A Resource is an actual instance of infrastructure, created from a Template and Source Code Version.
Resource PropertiesΒΆ
ID: res-abc123
Name: production-vpc-us-east-1
Template: Production VPC
Parent Resource: aws-account-prod
Source Code Version: v1.2.0
State: provisioned
Status: done
Variables:
vpc_name: 'production-vpc'
cidr_block: '10.0.0.0/16'
Outputs:
vpc_id: 'vpc-0123456789'
availability_zones: ['us-east-1a', 'us-east-1b']
Learn more: Resources Documentation
πΌ WorkspaceΒΆ
A Workspace is a Git repository where InfraKitchen can automatically sync generated Terraform code.
StructureΒΆ
workspace-repo/
βββ production-vpc/
β βββ main.tf
β βββ variables.tf
β βββ outputs.tf
βββ production-eks/
β βββ main.tf
β βββ variables.tf
β βββ outputs.tf
Learn more: Workspaces Documentation