Resources / VPC
VPC
A private Ethernet segment. IPv6 /64 always, IPv4 optional; members attach through accounts.
Overview
| API | network.etorm.com/v1alpha1 |
| Resource | vpcs (cluster-scoped inside its cluster) |
| Short names | none |
| Available in | project clusters only |
| Status | written by a controller through /status |
Minimal example
apiVersion: network.etorm.com/v1alpha1
kind: VPC
metadata:
name: example
spec: {}
Spec
| Field | Type | Required | Default | Allowed | Description |
cidr | string | | | up to 18 characters | Optional IPv4 compatibility network of the segment, /16 to /29. Omit for an IPv6-only VPC. Immutable. |
encapsulation | string (one of) | | "vxlan" | vxlan, geneve | L2 tunnel protocol carried inside WireGuard. Immutable. |
ipv6Prefix | string | | | up to 45 characters | Optional IPv6 /64 of the segment. Allocated automatically (unique-local) when omitted. Immutable. |
monitoringRef | reference to MonitoringWorkspace | | | | Optional MonitoringWorkspace to send VPC L3/L4/L7 flow telemetry to. |
mtu | integer | | 1370 | 576 to 1370 | Requested overlay MTU, 576 to 1370; the effective value is lower on an IPv6 underlay and is shown in status.mtu. |
gatewayRef | reference to Gateway | | | | Optional gateway (WireGuard/VXLAN/Geneve attachment point). Immutable. |
Status
| Field | Type | Required | Default | Allowed | Description |
phase | string | | | | Pending, Ready or Failed. |
vni | integer | | | | The tunnel network id allocated to this VPC. |
gatewayAddress | string | | | | The VPC's IPv4 service address (first host of the cidr). |
mtu | integer | | | | Effective overlay MTU: spec.mtu capped by what the gateway's tunnel network carries (1350 on an IPv6 underlay). |
ipv6Prefix | string | | | | The VPC's IPv6 /64. |
ipv6Address | string | | | | The VPC's IPv6 service address (<prefix>::1). |
accountCount | integer | | | | Number of accounts attached. |
conditions | list of object | | | | |
conditions[].type | string | | | | |
conditions[].status | string | | | | |
conditions[].reason | string | | | | |
conditions[].message | string | | | | |
Columns in listings
| Column | From |
|---|
| CIDR | .spec.cidr |
| IPv6 | .status.ipv6Prefix |
| Encap | .spec.encapsulation |
| VNI | .status.vni |
| Accounts | .status.accountCount |
| Phase | .status.phase |
Related guides
All resources