Resources / Account

Account

One member's attachment to a VPC: its key, addresses and the configuration to join.

Overview

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

Minimal example

apiVersion: network.etorm.com/v1alpha1
kind: Account
metadata:
  name: example
spec:
  vpcRef:
    name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
vpcRefreference to VPCyesThe VPC to attach to. Cannot be changed.
publicKeystringlength 44 to 44The member's WireGuard public key (base64 of 32 bytes). Required when the VPC has a gateway. In a VPC without a gateway a key makes the member's tunnel end on the platform's stations, which attach it to the VPC's segment (spec 0038 section 28); without one the member joins only through the switch (spec 0014). The private key never leaves the member.
ipAddressstringup to 15 charactersRequested IPv4 overlay address inside the VPC CIDR (VPCs with an IPv4 CIDR only). Allocated automatically when omitted.
accessstring (one of)"direct"direct, relay, stationdirect (default): the member's tunnel ends on the gateway. station: the member is somewhere on the internet and its tunnel ends on the gateway's access point (a station with a public address, spec 0040); relay is the old spelling of station, still accepted and stored as written; it is still an ordinary L2 member of the VPC's VXLAN segment, with broadcast, multicast and unknown-unicast traffic. Needs a gateway, a VPC with encapsulation vxlan and an MTU of at most 1310 (1280 recommended). In a VPC without a gateway the value does not matter: a member with a public key ends on a station (spec 0038 section 28). Cannot be changed (relay to station or back is not a change).

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending, Ready or Failed.
ipAddressstringIPv4 address with prefix length, when the VPC has IPv4.
ipv6AddressstringIPv6 address with /64 (the address SLAAC would pick).
macAddressstringMAC address of the member's L2 device.
switchobject
switch.pathstring
underlayAddressstringThe member's tunnel address: inside the gateway's tunnel network, or (a station member, spec 0038 section 28) inside the stations' member range fd00:e8::/64. Stable.
vniintegerThe tunnel network id of the VPC.
encapsulationstringvxlan or geneve.
mtuintegerEffective overlay MTU.
gatewayobject
gateway.endpointstring
gateway.publicKeystring
gateway.underlayAddressstring
accessPointobjectWhere the member's tunnel ends: the gateway's access point (access station, spec 0040) or, in a VPC without a gateway, the station it is attached to now (spec 0038 section 28). A station's key changes when it is replaced: a member re-reads this and the config when its tunnel stops answering.
accessPoint.endpointstringhost:port, UDP: the IPv4 address when the station has one (a member's network may have no IPv6), else the IPv6 one in brackets.
accessPoint.endpoint6stringThe station's IPv6 endpoint, [address]:port, when it has one.
accessPoint.publicKeystringThe station's (or access point's) WireGuard public key.
accessPoint.peerstringThe GatewayPeer that is the access point (gateway VPCs).
accessPoint.namestringThe AccessPoint the member is attached to (VPCs without a gateway).
accessPoint.vtepstringThe tunnel address the member's VXLAN goes to (fd00:e8::1 on every station).
configobject
config.wireguardstringThe tunnel as a wg-quick file without any command: one interface, one peer (the gateway, the access point or the station). The private key is a placeholder; the member makes its own.
config.wireguardQuickstringFor access station and station members: the same with the VXLAN device and addresses as PostUp lines, for wg-quick on a Linux host.
config.scriptstringThe ip commands that make the member's VXLAN or Geneve device and give it its MAC, MTU and addresses on Linux.
endpointPingMsnumberAverage round-trip ping time in milliseconds to the WireGuard endpoint, reported by the member device.
endpointPingSamplesintegerNumber of round-trip ping samples measured by the member device.
endpointPingAtstringRFC 3339 UTC timestamp of the last reported endpoint ping.
firmwareNamestringName and version of the firmware running on the member device.
firmwareHashstringSHA-256 content hash of the firmware image running on the member device.
firmwareReleasedAtstringRFC 3339 UTC build/release timestamp of the firmware running on the member device.
firmwareWrittenAtstringRFC 3339 UTC timestamp when this firmware was written to the member device.
temperatureCnumberInternal chip temperature in degrees Celsius reported by the member device.
systemLoadPercentnumberRolling system load percentage (0-100) reported by the member device.
memoryFreeBytesintegerFree heap memory in bytes reported by the member device.
memoryUsedBytesintegerUsed heap memory in bytes reported by the member device.
conditionslist of object
conditions[].typestring
conditions[].statusstring
conditions[].reasonstring
conditions[].messagestring

Columns in listings

ColumnFrom
VPC.spec.vpcRef.name
IP.status.ipAddress
IPv6.status.ipv6Address
MAC.status.macAddress
Underlay.status.underlayAddress
Phase.status.phase
Access.spec.access
Ping.status.endpointPingMs

Related guides

All resources