Resources / Device

Device

A device on a VPC as its gateway sees it: an account's member, a Compute process interface, or any other MAC address with a neighbor entry. Created, updated and removed by the gateway agent; informational.

Overview

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

Minimal example

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

Spec

FieldTypeRequiredDefaultAllowedDescription
vpcRefreference to VPCyesThe VPC the device is on.
macAddressstringyeslength 17 to 17The device's MAC address, lower case. Unique inside a VPC; the object is named <vpc>-<mac without colons>.

Status

FieldTypeRequiredDefaultAllowedDescription
gatewaystringThe gateway that reported this device.
kindstring (one of)member, other, processmember: the device of an Account; process: an interface of a Compute process; other: a MAC address the bridge has a neighbor entry for (a device behind a member, or a host that talked to the gateway).
accountstringThe Account, for a member.
ownerobjectFor a process of the platform that serves one of your resources on this VPC (for example a database engine): the resource it works for. The platform's own project and process names are never shown.
owner.kindstringKind of your resource, for example Database or MessageBroker.
owner.namestringName of your resource.
processstringThe Compute process, for a process interface of your own project.
interfacestringThe interface name inside the process, for a process interface.
statestring (one of)connected, idle, never, seen, running, suspended, stoppedconnected: tunnel handshake within three minutes; idle: older; never: no handshake yet; seen: a non-member known from the neighbor table; running, suspended, stopped: the desired state of the process, for a process interface.
ipAddressstringThe Account's IPv4 address with prefix length, when the VPC has IPv4.
ipv6AddressstringThe Account's IPv6 address with /64.
publicKeystringThe member's WireGuard public key.
underlayAddressstringThe member's address in the gateway's tunnel network.
endpointstringWhere the gateway last received the member's tunnel packets from.
lastHandshakestringLast WireGuard handshake (RFC 3339, UTC); absent if it never connected.
rxBytesintegerBytes received from the member through the tunnel.
txBytesintegerBytes sent to the member through the tunnel.
observedAtstringWhen the gateway looked (RFC 3339, UTC). Refreshed about every 30 seconds.
addresseslist of objectThe device's entries in the neighbor table of the VPC's bridge: ARP for IPv4, NDP for IPv6.
addresses[].addressstringThe IP address.
addresses[].familystring (one of)IPv4, IPv6ARP for IPv4, NDP for IPv6.
addresses[].statestringKernel state: REACHABLE, STALE, DELAY, PROBE, PERMANENT.

Columns in listings

ColumnFrom
VPC.spec.vpcRef.name
MAC.spec.macAddress
Account.status.account
State.status.state
Observed.status.observedAt

All resources