Resources / PublicEndpoint

PublicEndpoint

A public door onto an ingress, made by the platform team. The gateway named here listens on a TCP port of its own host and relays every connection to the ingress inside its VPC, which then routes it (TLS ends at the ingress, or in front of this door when the name is proxied). When spec.dns is set, the Edge operator reconciles the public DNS records for spec.hostname automatically. Only the platform team can create it.

Overview

APIedge.etorm.com/v1alpha1
Resourcepublicendpoints (cluster-scoped inside its cluster)
Short namespubep
Available inthe platform only
Statuswritten by a controller through /status

Minimal example

apiVersion: edge.etorm.com/v1alpha1
kind: PublicEndpoint
metadata:
  name: example
spec:
  hostname: "<hostname>"
  ingressRef:
    project: "<project>"
    name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
hostnamestringyesup to 253 charactersThe public DNS name clients use (lower case), for example code.etorm.com. Informational for the station; it names the door.
portinteger4431 to 65535The TCP port the gateway's host listens on (IPv6, and IPv4 where the host has it). With proxy fronted it is one of the ports the proxy can reach (443, 2053, 2083, 2087, 2096, 8443).
proxystring (one of)"fronted"fronted, directWhat stands in front of this door on the internet. fronted: a proxy that ends the clients' TLS with a public certificate and connects to this port over TLS without checking the ingress's own certificate. direct: clients connect here, so the ingress needs a certificate they trust (not built yet).
gatewayRefreference to GatewayThe gateway whose host listens. It must have the ingress's VPC attached.
ingressRefobjectyesThe ingress the door leads to.
ingressRef.projectstringyeslength 1 to 63The project that owns the ingress.
ingressRef.namestringyeslength 1 to 63Name of the ingress.
targetPortinteger1 to 65535The ingress listener port to relay to. Default is the port of its first https listener, else of its first listener.
stationRefobjectThe station (an ExternalNode) that also listens on spec.port on its public addresses and forwards to the gateway host's tunnel address. Its operator keeps the node's listeners current without recreating it.
stationRef.projectstringyeslength 1 to 63The system project that holds the ExternalNode.
stationRef.namestringyeslength 1 to 63Name of the ExternalNode.
relayRefobjectDeprecated spelling of stationRef: still read, and used when stationRef is not set.
relayRef.projectstringyeslength 1 to 63The system project that holds the ExternalNode.
relayRef.namestringyeslength 1 to 63Name of the ExternalNode.
dnsobjectPublic DNS for spec.hostname, in either of two forms. With zoneId the operator publishes the addresses of externalNodeRef(s) or addresses; with zone (and spec.stationRef) a PublicRecord is made from the station's addresses.
dns.zonestringup to 253 charactersThe DNS zone (with spec.stationRef).
dns.secretNamestringlength 1 to 63No longer used (the zone's credential is held by the DNS operator).
dns.takeoverstring (one of)"refuse"refuse, replaceWhat to do with records of the name that Etorm did not make (with zone).
dns.zoneIdstringlength 1 to 64DNS zone identifier for the configured DNS provider.
dns.externalNodeRefobjectExternalNode whose external IPv6/IPv4 addresses are published as AAAA/A records.
dns.externalNodeRef.projectstringyeslength 1 to 63Project holding the ExternalNode.
dns.externalNodeRef.namestringyeslength 1 to 63Name of the ExternalNode.
dns.externalNodeRefslist of objectMultiple ExternalNodes whose external IPv6/IPv4 addresses are published as AAAA/A records for active-active HA.
dns.externalNodeRefs[].projectstringyeslength 1 to 63Project holding the ExternalNode.
dns.externalNodeRefs[].namestringyeslength 1 to 63Name of the ExternalNode.
dns.addresseslist of stringup to 8 itemsExplicit public IPv6/IPv4 addresses when externalNodeRef is omitted.
dns.proxiedbooleanOverride proxy status (defaults to false for proxy direct, true for proxy fronted).
dns.ttlinteger11 to 86400Record TTL in seconds (1 = automatic).
dns.secretRefobjectOptional Secret holding the DNS API token.
dns.secretRef.projectstringyeslength 1 to 63Project holding the Secret.
dns.secretRef.namestringyeslength 1 to 63Name of the Secret.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending (the ingress or its address is not there yet), Ready (the gateway can relay) or Failed (the ingress does not exist or has no listener).
targetobjectWhere the gateway relays to.
target.vniintegerThe VPC's segment (VNI) the address is on.
target.addressstringThe ingress's address in its VPC.
target.portintegerThe listener port.
target.addresseslist of stringThe addresses of all the ingress's nodes when it has several (address is the first); a station spreads connections over them. Absent for one node.
capacityobjectWhat the controller remembers to tell saturation of the stations that relay this endpoint (condition Saturated) from one pass to the next.
capacity.refusedFullintegerConnections the stations dropped at their limit, summed, at the last pass.
capacity.saturatedAtintegerUnix time of the last pass in which a station showed saturation; the condition holds five minutes after it.
stationobjectThe station's side (with spec.stationRef).
station.addresseslist of stringThe station's external addresses.
station.listenerstringInstalled once the running node reports the listener, else Pending.
relayobjectDeprecated spelling of station (same content, written for one release).
relay.addresseslist of stringThe station's external addresses.
relay.listenerstringInstalled once the running node reports the listener, else Pending.
dnsobjectOperator-managed public DNS state for spec.hostname.
dns.phasestringPending, Ready or Failed.
dns.messagestringStatus detail.
dns.repairedlist of stringThe DNS records whose declared spec had been changed by someone else and was put back on the last pass, one line each (spec 0047 section 2.2). Absent when nothing was.
dns.recordslist of objectReconciled DNS records.
dns.records[].idstringProvider record ID (empty until the zone operator has made or adopted it).
dns.records[].typestringAAAA or A.
dns.records[].namestringHostname.
dns.records[].contentstringTarget IP address.
dns.records[].proxiedbooleanWhether proxied at the edge.
dns.records[].recordstringThe DNSRecord object that declares it.
dns.records[].phasestringThe state the zone operator reports for it (Synced when it is in step at the provider).
conditionslist of objectDetailed state, one entry per aspect; Ready says whether the gateway can relay.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Hostname.spec.hostname
Port.spec.port
Gateway.spec.gatewayRef.name
Phase.status.phase

All resources