Skip to content
InfraKitchen
Esc
↑↓navigate↵open⌘Jpreview
On this page

Quick Start

Go from zero to your first provisioned resource in about 10 minutes.

In about 10 minutes, Part 1 will have you run InfraKitchen locally and provision your first resource from a dummy template. Part 2 then connects AWS and provisions a real VPC in about 18 more minutes.

Part 1 — Your First Resource, No Cloud

This part takes about 10 min

Prerequisites

  • Nix (preferred) or Podman — pick one in the tabs below
  • git, to clone the repository

1. Run InfraKitchen Locally

Clone the repository:

git clone https://github.com/electrolux-oss/infrakitchen.git
cd infrakitchen

Pick the option that matches your machine:

# If no Nix is installed, run the official installer first:
# curl -L https://nixos.org/nix/install | sh -s -- --daemon

nix --extra-experimental-features 'nix-command flakes' develop
cp docs/examples/podman/compose.yml ./compose.yml
podman compose up -d
cp docs/examples/podman/compose.yml ./compose.yml
podman-compose up -d

Open http://localhost:7777, click Log in as a Guest, and choose Guest Login (Super User) — this role has the admin permissions the walkthrough needs.

2. Add a Public Git Repository Integration

InfraKitchen imports templates from Git repositories. Both the dummy template and InfraKitchen itself are public, so no Git account or token is needed:

Create the integration

On the welcome page, click Connect Git and choose Public Git Repository. Give it a Name (e.g. PublicGit) — no credentials or URL are needed, it just tells InfraKitchen it may clone public repositories.

3. Import the Dummy Template

The example templates repository contains a dummy template that provisions only random, local resources — no cloud provider, no credentials, no cost:

Import the template

Go to Templates and click Import:

Field Value
Git Integration PublicGit
Repository URL https://github.com/electrolux-oss/infrakitchen-example-templates
Directory Path demo/00-dummy
Branch main (default)

Name it Dummy and click Import — InfraKitchen scans the module to extract its variables and outputs.

4. Add Local State Storage

Every resource stores its OpenTofu/Terraform state in a storage. Without a cloud, use the PostgreSQL instance InfraKitchen already runs locally:

Create the PostgreSQL integration

In InfraKitchen, go to Configurations > Integrations, click Connect Cloud, and choose PostgreSQL. Fill in the fields with the default values for the local PostgreSQL instance:

Field Value
Integration Name Any name, e.g. LocalPostgres
Host localhost if you run via Nix, postgres if you run via Docker/Podman
Port 5432
User dev_user
Password password
Database Any name, e.g. infrakitchen_states — created automatically if it does not already exist
Maintenance Database A different, already-existing database used only to create Database; defaults to postgres
SSL Mode disable — the local instance does not use TLS

Click Test Connection and save.

Create the storage

Go to Configurations > Storage and click Create. Choose the PostgreSQL provider and fill in the fields:

Field Value
Name Any name, e.g. LocalStorage
Integration The LocalPostgres integration you created above
Schema Name Any name, e.g. demo_states

Click Save, then click Apply to provision it, and wait until the status shows PROVISIONED [DONE]. You can open the Log Stream (terminal icon) to follow progress in real time.

5. Provision the Dummy Resource

Create the resource

Go to Templates, find the Dummy template, and click Create Resource. Give it a name (e.g. Dummy Resource), select the Template Version (main), and select the storage from step 4 — no integration is needed. The variables all have defaults, so leave them as they are.

Dry run, then provision

Save, click Plan to preview the changes, then click Review and Approve — new resources require approval before they can be applied. Click Apply to provision it. When the status turns PROVISIONED, check the resource’s Outputs (e.g. deployment_id and instance_names) — you have provisioned your first resource, entirely locally.

Destroy the resource

When you are done, go to the resource’s Settings tab, and in the Danger Zone, click Destroy, type the resource’s name to confirm, and click Destroy again. Click Review and Approve, then click Plan and Apply again to actually destroy it.

Part 2 — Connect AWS and Provision a VPC

This part takes about 18 min

Prerequisites

  • An AWS account where you can create an IAM user
  • InfraKitchen still running locally, with the PublicGit integration already set up

1. Connect AWS

InfraKitchen provisions through an IAM user in your AWS account.

Create an IAM user and access keys

In the AWS console, create a dedicated IAM user with programmatic access and generate an Access Key ID and Secret Access Key. For this walkthrough, attach AdministratorAccess — it keeps the proof of concept simple. Scope the permissions down for real use; see Cloud Providers.

Add the integration in InfraKitchen

In InfraKitchen, go to Configurations > Integrations, click Connect Cloud, and choose AWS:

Field Value
Integration Name e.g. AWSDemo
AWS Account ID Your AWS account ID
Access Key ID The generated Access Key ID
Secret Access Key The generated Secret Access Key
Automatically create S3 bucket for OpenTofu/Terraform remote state Checked — this creates the bucket that stores your infrastructure state

Test the connection

Click Test Connection and save once it passes.

2. Import the AWS Templates

The same example templates repository also contains ready-to-use AWS modules. Import two of them:

Import the account template

Go to Templates and click Import:

Field Value
Git Integration PublicGit
Repository URL https://github.com/electrolux-oss/infrakitchen-example-templates
Directory Path demo/01-aws-account
Branch main (default)

Name it AWS Account and click Import — InfraKitchen scans the module to extract its variables and outputs.

Import the VPC template

Repeat with Directory Path demo/02-aws-vpc, name it AWS VPC, and pick AWS Account under Select Parents.

The resulting template hierarchy is:

3. Provision the Account Resource

Provision the account resource before creating the VPC resource.

Create the AWS Account resource

Go to Templates, find the AWS Account template, and click Create Resource. Fill in the fields and variables:

Field Value
Name e.g. demo-account
AWS integration Select AWSDemo
Storage Select infrakitchen_AWSDemo
Template Version Select main
Variable: account Your AWS account ID
Variable: master_account_id Your AWS account ID
Variable: region e.g. eu-central-1

Dry run, then provision

Save, click Plan to preview the changes, then click Review and Approve. Click Apply to provision it. Wait until the status turns PROVISIONED.

4. Provision the VPC

Create the VPC resource

Create another resource from the AWS VPC template and fill in the fields and variables:

Field Value
Name e.g. demo-vpc
Parent Select demo-account
AWS integration Select AWSDemo
Storage Select infrakitchen_AWSDemo
Template Version Select main
Variable: account Your AWS account ID
Variable: name e.g. demo-vpc
Variable: cidr_block 10.20.0.0/16

Dry run, then provision

Save, click Plan to preview the changes, then click Review and Approve. Click Apply to provision it. When the status turns PROVISIONED, check the resource’s Outputs — your VPC is live in AWS, created entirely through InfraKitchen!

5. Clean Up

Go to the demo-account resource’s Settings tab, and in the Danger Zone, click Cascade Destroy, type the resource’s name to confirm, and click Cascade Destroy again — InfraKitchen creates a destroy workflow covering the account resource and the VPC beneath it, and opens it. Click Apply to run the workflow: both resources are destroyed in the right order (children first). See Cascade Actions for details.

Exit the Nix shell with Ctrl+D, or stop InfraKitchen with podman compose down.

Default Settings

For local development, InfraKitchen automatically configures the following on first run — no manual setup needed:

  • Encryption & signing keys — ENCRYPTION_KEY encrypts sensitive data at rest (e.g. stored integration credentials), and JWT_KEY signs auth tokens. Generated into server/.env_local.
  • Data storage (Nix only) — PostgreSQL data and other local state are stored in the ik_data/ directory. Delete this directory to start the project from scratch. (Docker/Podman store data in their own named volumes instead.)

Last updated on