Resources / GatewayPeer

GatewayPeer

A plain WireGuard peer of a Gateway: a host that is not a VPC member (an external node, spec 0038) and needs a tunnel address on the gateway's network and a place in the gateway's peer table, with no L2 device. The address is allocated at once and never changes; the peer joins the table when its public key is set. Created by the platform's operators.

Overview

APInetwork.etorm.com/v1alpha1
Resourcegatewaypeers (cluster-scoped inside its cluster)
Short namesgwp
Available inthe platform only
Statuswritten by a controller through /status

Minimal example

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

Spec

FieldTypeRequiredDefaultAllowedDescription
gatewayRefreference to GatewayyesThe gateway the peer attaches to. Immutable.
publicKeystringup to 44 charactersThe peer's WireGuard public key (base64 of 32 bytes). Empty until the peer has made its key; the address is reserved meanwhile.
descriptionstringup to 200 charactersWho the peer is
accessobjectMakes the peer the gateway's access point for member devices (spec 0040): members whose Account has access station (or the old spelling relay) connect to this endpoint. The gateway dials out to the same endpoint (so it needs no inbound port), and the peer carries the members' tunnel addresses to it.
access.endpointstringyesup to 260 charactersThe peer's public WireGuard endpoint, host:port (UDP).

Status

FieldTypeRequiredDefaultAllowedDescription
memberslist of objectFor an access point: the members it must accept (public key and the tunnel address each may use), from the Accounts with access station or relay on this gateway's VPCs. Removing an Account removes it here at the next pass.
members[].clusterstring
members[].accountstring
members[].publicKeystring
members[].allowedIpslist of stringThe member's tunnel (underlay) address as a /128 (/32 on an IPv4 underlay).
members[].vpcPrefixeslist of stringThe only destinations the access point forwards the member's packets to: the gateway's tunnel address (/128), where the member's VXLAN ends.
vpcPrefixeslist of stringFor an access point: the union of its members' vpcPrefixes, which the access point's gateway peer is allowed to carry: for L2 members only the gateway's tunnel address.
phasestringPending (no gateway, or no address yet), Reserved (address allocated, no key yet), Ready (in the gateway's peer table) or Failed.
underlayAddressstringThe peer's address in the gateway's tunnel network (a /128 on an IPv6 underlay, /32 on IPv4). Stable.
gatewayobjectWhat the peer needs to reach the gateway.
gateway.endpointstringThe gateway's WireGuard endpoint, host:port.
gateway.publicKeystringThe gateway's WireGuard public key.
gateway.underlayAddressstringThe gateway's own address in the tunnel network.
gateway.underlayCIDRstringThe tunnel network.
conditionslist of object
conditions[].typestring
conditions[].statusstring
conditions[].reasonstring
conditions[].messagestring

Columns in listings

ColumnFrom
Gateway.spec.gatewayRef.name
Address.status.underlayAddress
Phase.status.phase

All resources