Local Development with Tilt
lok8s integrates with Tilt for local development with live reload, port forwarding, and automatic rebuilds.
Looking for the full
services.yamlandlok8s.yamlschema, the small-vs-large project workflow, or how to mix local builds with CI-pulled registry images? See Services Configuration.
Quick Start
lo use lok8s.dev
lo upThis provisions a local kind cluster with registry mirrors, then starts Tilt in the background. The Tilt UI is available at http://localhost:10350.
To also open the Tilt UI automatically:
lo up --open-tiltHow It Works
The root Tiltfile loads the lok8s Tilt extension:
load('./.lok8s/tilt/Tiltfile', 'lok8s')
lok8s()The extension:
- Runs
lo env kustomizationto generatekustomization.yamland build artifacts - Runs
kustomize build clusters/<domain>/artifacts/to produce the full manifest (no repo-root pollution) - Filters system resources (
lok8s.dev/type: system) and applies them - Discovers services from
lo env services - For each enabled service with
build: true:- Filters Kubernetes artifacts by
lok8s.dev/namelabel - Reads the per-service
lok8s.yamlconfig - Sets up
docker_buildwithlive_update - Configures port forwarding and resource dependencies
- Filters Kubernetes artifacts by
Service Configuration
services.yaml
The committed base config defines which services exist and their registry settings:
registry:
prefix: lok8s.local
branch: builds
tag: latest
services:
my-api:
enabled: true
build: true
path: ./my-api
my-frontend:
enabled: true
build: true
path: ./my-frontendservices.<config>.yaml
Personal overrides (gitignored). Set LOK8S_SERVICE_CONFIG to select which override to merge:
export LOK8S_SERVICE_CONFIG=dev
# merges services.yaml + services.dev.yaml# services.dev.yaml
services:
my-frontend:
enabled: false # disable frontend locallyPer-Service lok8s.yaml
Each service directory contains a lok8s.yaml that defines how Tilt builds it:
# my-api/lok8s.yaml
build:
dockerfile: lok8s.Dockerfile
context: .
live_update:
fall_back_on:
files:
- package.json
sync:
- local_path: ./src
remote_path: /app/src
run:
cmd: npm run dev
ports:
- from: 3000
to: 3000
links:
- url: http://localhost:3000
name: API
tilt:
resource_deps:
- postgres
labels:
- backendDockerfile Convention
Each service should have two Dockerfiles:
| File | Purpose | Used by |
|---|---|---|
lok8s.Dockerfile | Development — hot-reload enabled | Tilt (via lok8s.yaml) |
Dockerfile | Production — optimized build | CI/CD, lo deploy |
The dev Dockerfile uses the runtime's native hot-reload mechanism. Tilt syncs files via live_update, and the process inside the container detects changes and reloads automatically — no container restarts needed.
Hot-reload by runtime
Bun:
CMD ["bun", "run", "--hot", "index.ts"]Node.js (nodemon):
CMD ["npx", "nodemon", "--watch", "src", "src/index.ts"]SvelteKit / Vite:
CMD ["bun", "run", "dev", "--host", "0.0.0.0", "--port", "3000"]Python (uvicorn):
CMD ["uvicorn", "server:app", "--host", "0.0.0.0", "--port", "8500", "--reload"]fall_back_on
Files listed in fall_back_on trigger a full Docker rebuild instead of a live sync:
fall_back_on:
files:
- package.json # dependency changes
- bun.lock # lockfile changes
- lok8s.Dockerfile # Dockerfile changesProvisioning Flow
When lo up runs, the Lo driver performs these steps:
- Read config from
cluster.lok8s.yaml(applying defaults for*.lok8s.devdomains — see Specs reference) - Validate IPs — all registry IPs and MetalLB pool must be within their subnets
- Create docker network with the configured CIDR
- Start registry containers — the framework always ships
buildandcacheon the project subnet, plus the configured pull-through mirrors on the shared network (default) or project subnet - Render kind config — nodes and containerd patches generated from spec
- Create kind cluster with rendered config
- Create registry ConfigMap (
lok8s-registriesinkube-system) - Apply CoreDNS config and patches — plus any
spec.corednsfrom the cluster spec (see Custom in-cluster DNS) - Apply bootstrap addons — framework runs
.lok8s/libs/bootstrapto applyspec.bootstrapaddons in order (default:[cilium]), waits for health between each - Generate TLS certs via mkcert
- Start Tilt for live development
Registry Mirrors
The framework always ships two private registries (build, cache) plus a default set of four public pull-through mirrors. All registries listen on port :80 and are reached via raw IP or their canonical hostname (via containerd's hosts.toml).
| Registry | Default IP (slot 125) | Hostname | Purpose |
|---|---|---|---|
build | 10.125.125.101 | lok8s.local | Local build images (Tilt push target) |
cache | 10.125.125.102 | lok8s.cache | build: false pre-pull target |
io-docker | 10.125.200.2 | docker.io | Docker Hub pull-through cache |
io-quay | 10.125.200.3 | quay.io | Quay pull-through cache |
io-k8s | 10.125.200.4 | registry.k8s.io | Kubernetes images cache |
io-ghcr | 10.125.200.5 | ghcr.io | GitHub Container Registry cache |
build and cache always live on the project subnet (10.125.<slot>.0/24) at fixed offsets. Pull-through mirrors live on the shared lok8s-registries network (10.125.200.0/24) by default, or on the project subnet (.103+) when spec.registries.shared.enabled: false.
See the Specs reference — Registries Configuration for the full schema.
A lok8s-registries ConfigMap in kube-system exposes registry IPs and URLs for in-cluster tooling.
Load Balancer
When spec.loadBalancer.pool is configured, MetalLB is installed to provide LoadBalancer service support inside the kind cluster. This enables services like CoreDNS external to get real IPs on the docker bridge network.
spec:
loadBalancer:
pool: "10.125.125.125-10.125.125.150" # 26 IPs from slot 125's MetalLB rangeCustom in-cluster DNS
Declare custom CoreDNS in the cluster spec; lo up renders it into a coredns-custom ConfigMap that the base Corefile imports from /etc/coredns/custom. Declarative and committed — it survives a recreate, unlike a runtime kubectl patch of the coredns ConfigMap (which lo up regenerates). A cluster with no spec.coredns is unaffected.
Common case — resolve a zone to the gateway LB
In dev, *.<domain> is not real public DNS reachable from inside the cluster, but operator-managed pods that can't take hostAliases (e.g. an API fetching an OIDC discovery doc from https://auth.<domain>/…) still need to resolve it. Declare the zone and a target; the driver writes the Corefile block for you (A → target, AAAA → NODATA so dual-stack clients fall back to A cleanly):
spec:
coredns:
hosts:
- name: kubehz.dev # the zone: its apex + every *.kubehz.dev
target: gateway # = the first loadBalancer.pool IP; or a literal IPtarget: gateway resolves to the first spec.loadBalancer.pool IP — where the Envoy gateway pins via metallb.universe.tf/loadBalancerIPs — so there is no IP to keep in sync by hand. Resolution is self-contained (no dependency on public DNS).
Raw escape hatches
For anything the structured form doesn't cover, supply raw CoreDNS — inline or from files. All inputs compose:
spec:
coredns:
servers: | # raw server block(s) — a *.server file
metrics.internal:53 { forward . 10.0.0.53 }
overrides: | # directives merged into the default .:53 block
hosts { 10.0.0.9 internal.svc ; fallthrough }
import: ./coredns # dir of raw *.server / *.override files
# (relative to the cluster dir; default ./coredns)| Input | Becomes | Use for |
|---|---|---|
hosts[] {name,target} | a generated name:53 { … } block | the friendly path — driver writes the template |
servers | a *.server file (own server blocks) | raw zones |
overrides | a *.override file (merged into .:53) | extra hosts/rewrite/forward |
import | raw *.server/*.override from a path | many/large snippets |
Don't define the same zone via both hosts and a raw servers/import block — CoreDNS rejects duplicate zone definitions.
Multi-Node Clusters
For testing HA setups locally, configure multiple nodes:
spec:
nodes:
controlPlane: 3
workers: 2The first control-plane node gets port mappings and the ingress-ready=true label. Additional nodes are plain kind nodes.
Tilt Commands
lo tilt up # start Tilt
lo tilt down # stop Tilt
lo tilt status # run tilt doctor
lo tilt restart # stop + startStopping
lo down # stops Tilt + deletes kind cluster