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
| API | network.etorm.com/v1alpha1 |
| Resource | gatewaypeers (cluster-scoped inside its cluster) |
| Short names | gwp |
| Available in | the platform only |
| Status | written by a controller through /status |
Minimal example
apiVersion: network.etorm.com/v1alpha1
kind: GatewayPeer
metadata:
name: example
spec:
gatewayRef:
name: "<name>"
Spec
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
gatewayRef | reference to Gateway | yes | The gateway the peer attaches to. Immutable. | ||
publicKey | string | up to 44 characters | The peer's WireGuard public key (base64 of 32 bytes). Empty until the peer has made its key; the address is reserved meanwhile. | ||
description | string | up to 200 characters | Who the peer is | ||
access | object | Makes 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.endpoint | string | yes | up to 260 characters | The peer's public WireGuard endpoint, host:port (UDP). |
Status
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
members | list of object | For 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[].cluster | string | ||||
members[].account | string | ||||
members[].publicKey | string | ||||
members[].allowedIps | list of string | The member's tunnel (underlay) address as a /128 (/32 on an IPv4 underlay). | |||
members[].vpcPrefixes | list of string | The only destinations the access point forwards the member's packets to: the gateway's tunnel address (/128), where the member's VXLAN ends. | |||
vpcPrefixes | list of string | For 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. | |||
phase | string | Pending (no gateway, or no address yet), Reserved (address allocated, no key yet), Ready (in the gateway's peer table) or Failed. | |||
underlayAddress | string | The peer's address in the gateway's tunnel network (a /128 on an IPv6 underlay, /32 on IPv4). Stable. | |||
gateway | object | What the peer needs to reach the gateway. | |||
gateway.endpoint | string | The gateway's WireGuard endpoint, host:port. | |||
gateway.publicKey | string | The gateway's WireGuard public key. | |||
gateway.underlayAddress | string | The gateway's own address in the tunnel network. | |||
gateway.underlayCIDR | string | The tunnel network. | |||
conditions | list of object | ||||
conditions[].type | string | ||||
conditions[].status | string | ||||
conditions[].reason | string | ||||
conditions[].message | string |
Columns in listings
| Column | From |
|---|---|
| Gateway | .spec.gatewayRef.name |
| Address | .status.underlayAddress |
| Phase | .status.phase |