Skip to main content
Sim includes pre-built templates for common homelab scenarios. Templates define node configurations, networking, and initial setup.

Available Templates

Single Node

One Ubuntu server for simple testing

3-Node Cluster

Three nodes for HA testing

Development

Dev environment with multiple services

Hybrid

Mix of cloud and local nodes

Using Templates

Via API

curl -X POST http://localhost:5270/api/v1/simulations \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-cluster",
    "template": "3-node-cluster"
  }'

Via Dashboard

  1. Open http://localhost:5271
  2. Click New Simulation
  3. Select a template
  4. Customize if needed
  5. Click Create

Template: 3-Node Cluster

Perfect for testing high-availability setups: Nodes:
  • node-1: Ubuntu 22.04, 2 CPU, 2GB RAM
  • node-2: Ubuntu 22.04, 2 CPU, 2GB RAM
  • node-3: Ubuntu 22.04, 2 CPU, 2GB RAM
Network: 172.20.0.0/24

Creating Custom Templates

# my-template.yaml
name: my-custom-template
description: My custom homelab setup

nodes:
  - name: web-server
    os: ubuntu-22.04
    resources:
      cpu: 2
      memory: 2048Mi
    
  - name: db-server
    os: debian-12
    resources:
      cpu: 4
      memory: 4096Mi

network:
  subnet: 172.30.0.0/24
  
scripts:
  post_create:
    - apt-get update
    - apt-get install -y docker.io
Load your template:
curl -X POST http://localhost:5270/api/v1/templates \
  -H "Content-Type: application/json" \
  -d @my-template.yaml