Developers
Build on Etorm
These are the docs for building on Etorm: private networks, the programs that run on them, encrypted object storage and the access rules around all of it. It is all one Kubernetes-compatible API, so you can drive it with kubectl, OpenTofu, plain HTTP or the console.
kubectl --server https://acme-prod-api.etorm.com \
--token "$ETORM_TOKEN" apply -f - <<'YAML'
apiVersion: network.etorm.com/v1alpha1
kind: VPC
metadata: {name: lan}
spec: {}
---
apiVersion: network.etorm.com/v1alpha1
kind: Account
metadata: {name: laptop}
spec: {vpcRef: {name: lan}}
YAMLServices
We give teams access by invitation, service by service. If you want to try one, ask us for access and tell us what you plan to build.
Networking
Each VPC is an Ethernet segment. Members join over WireGuard and get DHCP and DNS from the VPC.
Control plane
The one Kubernetes-compatible API behind every service, with its paths, verbs, selectors and errors.
Compute
WebAssembly programs that run as processes on your VPCs when events arrive.
Workflows
Durable execution, built on Compute and Storage.
Graph database
openCypher databases whose regions are kept in Storage.
Database
PostgreSQL-compatible databases, run on Compute with their data in Storage.
Diagrams
Describe resources as blocks and links on the canvas or in YAML, then watch their live status.
Storage
Buckets of encrypted objects that you read and write over HTTPS.
Load balancing
Load balancers and ingress at L3, L4 and L7.
Queues
A message broker for MQTT clients that keeps its state in Storage.
Start here
Quickstart
Make a project, a VPC, a member and DNS with two kubectl calls.
Concepts
How projects, resources, controllers, identities and the network fit together.
Guides
Step-by-step how-tos for networks, compute, storage, access and day-to-day operations.
Reference
Every resource and field, the HTTP API, the storage API, the program interface and the command-line tool.
Know what you can use
Service access
How to get each service, and the limits that apply to it.
What's new
Dated changes to the platform and these docs.
Security model
How we authenticate requests, check access, encrypt data and keep the audit log.
FAQ
Answers to the questions people tend to ask first.
Glossary
The terms these docs use, each with a link to more.
Popular guides
Sign in and get kubectl access
Get a token with etorm login or the console, and revoke it when you are done.
Connect a Linux machine
WireGuard plus an L2 device, from making keys to a working ping.
Add IPv4, DHCP and DNS
Turn on dual-stack addressing, with leases and names.
Run a program as a process
Register it, give it an interface and read back its addresses.
Store objects in a bucket
Write, read, list and delete objects with curl.
Give a teammate access
Send an invitation link, pick a role, and check the audit log.
Manage Etorm with OpenTofu
Plan changes, detect drift and import what already exists.
Find out why something stays Pending
Read phases, conditions and error codes.
Cheat sheet
| You want | Do |
|---|---|
| Platform API | https://api.etorm.com (billing accounts, projects, identity) |
| A project's API | https://<project>-api.etorm.com |
| Authenticate | Authorization: Bearer etorm.<cluster>.<name>.<secret> |
| Get a token | etorm login, or kubectl access in the console |
| See everything | kubectl get vpcs,accounts,dnsservices,dhcpservices,programs,processes,buckets |
| Objects in a bucket | https://storage.etorm.com/v1/<project>/<bucket>/<key> with the same token |
| Usage and costs | kubectl get usage in a project; see Read your usage and costs |
| Wait for ready | kubectl wait --for=condition=Ready vpc/lan |
| Field help | kubectl explain vpc.spec, or the resource reference |