Resources / Gateway

Gateway

The attachment point of members to the platform's switch: WireGuard endpoint and tunnel network. Platform-managed.

Overview

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

Minimal example

apiVersion: network.etorm.com/v1alpha1
kind: Gateway
metadata:
  name: example
spec:
  endpoint: "<endpoint>"
  publicKey: "<publicKey>"

Spec

FieldTypeRequiredDefaultAllowedDescription
endpointstringyeslength 3 to 260WireGuard endpoint, host:port (UDP).
publicKeystringyeslength 44 to 44WireGuard public key (base64 of 32 bytes).
underlayCIDRstringTunnel network inside WireGuard (spec 0015). Default (set by admission): a unique-local IPv6 /64 derived from the name, gateway ::1. An IPv6 value must be a /64; an IPv4 CIDR (/8../24, first host is the gateway) remains for older gateways. Immutable.
regionstringup to 63 charactersWhere the gateway runs (informational).

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringLifecycle phase.
underlayAddressstringThe gateway's own address in its tunnel network.
vpcCountintegerVPCs attached.
accountCountintegerAccounts attached.
peerslist of objectDesired peer table for the gateway dataplane agent.
peers[].clusterstring
peers[].accountstring
peers[].publicKeystring
peers[].underlayAddressstring
peers[].vniinteger
peers[].encapsulationstring
peers[].macAddressstring
peers[].ipAddressstring
peers[].ipv6Addressstring
peers[].kindstringAbsent for an Account's member (L2). `l3` for a GatewayPeer: a plain WireGuard peer with its tunnel address and nothing bridged. Members behind an access point carry `via` (the access point's GatewayPeer) and have no WireGuard peer of their own: their VXLAN comes through the access point's tunnel like any member's (spec 0040).
peers[].viastringFor a member behind an access point: the GatewayPeer that carries it.
peers[].endpointstringFor an access point (kind l3): its public endpoint, which the gateway dials out to.
peers[].allowedIpslist of stringAddresses routed to this peer besides its tunnel address (for an access point: the tunnel addresses of the members behind it).
l3PeerCountintegerGatewayPeers attached (WireGuard peers without a VPC).
networkslist of objectOne entry per attached VPC (VNI, IPv6 /64, MTU) for services the agent runs on the bridge (SLAAC, spec 0015).
networks[].clusterstring
networks[].vpcstring
networks[].vniinteger
networks[].ipv6Prefixstring
networks[].cidrstringThe VPC's IPv4 network, when it has one (the gateway forwards devices to it).
networks[].mtuinteger
networks[].encapsulationstring
conditionslist of object
conditions[].typestring
conditions[].statusstring
conditions[].reasonstring
conditions[].messagestring

Columns in listings

ColumnFrom
Endpoint.spec.endpoint
Underlay.spec.underlayCIDR
VPCs.status.vpcCount
Accounts.status.accountCount
Phase.status.phase

Related guides

All resources