Quickstart

This page takes you from a token to a working private network: a project, a VPC with one member, and DNS. You need kubectl and an API token. Each project is its own logical cluster with its own hostname, so the first call goes to the platform API and the second to your project's.

1. Billing account and project

Create a billing account and a project billed to it. Creating the billing account makes you its owner.

export ETORM_TOKEN=etorm.root.you-cli.…

kubectl --server https://api.etorm.com --token "$ETORM_TOKEN" apply -f - <<'YAML'
apiVersion: billing.etorm.com/v1alpha1
kind: BillingAccount
metadata: {name: acme}
spec: {}
---
apiVersion: resourcemanager.etorm.com/v1alpha1
kind: Project
metadata: {name: acme-prod}
spec: {billingAccountRef: {name: acme}}
YAML

2. VPC, member, DNS

Now talk to the project's own API. This makes an IPv6-only VPC, an Account for one machine, and a DNS zone inside the VPC.

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: {}                       # IPv6-only; add cidr: 10.0.0.0/24 for dual-stack
---
apiVersion: network.etorm.com/v1alpha1
kind: Account
metadata: {name: laptop}
spec: {vpcRef: {name: lan}}
---
apiVersion: network.etorm.com/v1alpha1
kind: DNSService
metadata: {name: dns}
spec: {vpcRef: {name: lan}, zone: corp.test}
YAML
kubectl --server https://acme-prod-api.etorm.com --token "$ETORM_TOKEN" get vpcs,accounts,dns

Where tokens come from

Sign in at the console, then follow Sign in and get kubectl access to get a token or a kubeconfig. Once you have one, the guides show what to build next.

Check that it worked

kubectl --server https://acme-prod-api.etorm.com --token "$ETORM_TOKEN" wait --for=condition=Ready vpc/lan --timeout=60s
kubectl --server https://acme-prod-api.etorm.com --token "$ETORM_TOKEN" get vpc lan -o jsonpath='{.status.phase}{"\n"}'

The second command should print Ready. Every resource works this way: it is ready when its status.phase is Ready. If it stays Pending, Find out why something stays Pending shows where to look.

Clean up

kubectl --server https://acme-prod-api.etorm.com --token "$ETORM_TOKEN" delete dnsservice dns
kubectl --server https://acme-prod-api.etorm.com --token "$ETORM_TOKEN" delete account laptop
kubectl --server https://acme-prod-api.etorm.com --token "$ETORM_TOKEN" delete vpc lan

Delete members and services before the VPC they refer to. Delete things safely lists the order and what is protected.

Next