Resources / VPC

VPC

A private Ethernet segment. IPv6 /64 always, IPv4 optional; members attach through accounts.

Overview

APInetwork.etorm.com/v1alpha1
Resourcevpcs (cluster-scoped inside its cluster)
Short namesnone
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: network.etorm.com/v1alpha1
kind: VPC
metadata:
  name: example
spec: {}

Spec

FieldTypeRequiredDefaultAllowedDescription
cidrstringup to 18 charactersOptional IPv4 compatibility network of the segment, /16 to /29. Omit for an IPv6-only VPC. Immutable.
encapsulationstring (one of)"vxlan"vxlan, geneveL2 tunnel protocol carried inside WireGuard. Immutable.
ipv6Prefixstringup to 45 charactersOptional IPv6 /64 of the segment. Allocated automatically (unique-local) when omitted. Immutable.
monitoringRefreference to MonitoringWorkspaceOptional MonitoringWorkspace to send VPC L3/L4/L7 flow telemetry to.
mtuinteger1370576 to 1370Requested overlay MTU, 576 to 1370; the effective value is lower on an IPv6 underlay and is shown in status.mtu.
gatewayRefreference to GatewayOptional gateway (WireGuard/VXLAN/Geneve attachment point). Immutable.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending, Ready or Failed.
vniintegerThe tunnel network id allocated to this VPC.
gatewayAddressstringThe VPC's IPv4 service address (first host of the cidr).
mtuintegerEffective overlay MTU: spec.mtu capped by what the gateway's tunnel network carries (1350 on an IPv6 underlay).
ipv6PrefixstringThe VPC's IPv6 /64.
ipv6AddressstringThe VPC's IPv6 service address (<prefix>::1).
accountCountintegerNumber of accounts attached.
conditionslist of object
conditions[].typestring
conditions[].statusstring
conditions[].reasonstring
conditions[].messagestring

Columns in listings

ColumnFrom
CIDR.spec.cidr
IPv6.status.ipv6Prefix
Encap.spec.encapsulation
VNI.status.vni
Accounts.status.accountCount
Phase.status.phase

Related guides

All resources