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
| API | edge.etorm.com/v1alpha1 |
| Resource | publicendpoints (cluster-scoped inside its cluster) |
| Short names | pubep |
| Available in | the platform only |
| Status | written 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
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
hostname | string | yes | up to 253 characters | The public DNS name clients use (lower case), for example code.etorm.com. Informational for the station; it names the door. | |
port | integer | 443 | 1 to 65535 | The 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). | |
proxy | string (one of) | "fronted" | fronted, direct | What 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). | |
gatewayRef | reference to Gateway | The gateway whose host listens. It must have the ingress's VPC attached. | |||
ingressRef | object | yes | The ingress the door leads to. | ||
ingressRef.project | string | yes | length 1 to 63 | The project that owns the ingress. | |
ingressRef.name | string | yes | length 1 to 63 | Name of the ingress. | |
targetPort | integer | 1 to 65535 | The ingress listener port to relay to. Default is the port of its first https listener, else of its first listener. | ||
stationRef | object | The 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.project | string | yes | length 1 to 63 | The system project that holds the ExternalNode. | |
stationRef.name | string | yes | length 1 to 63 | Name of the ExternalNode. | |
relayRef | object | Deprecated spelling of stationRef: still read, and used when stationRef is not set. | |||
relayRef.project | string | yes | length 1 to 63 | The system project that holds the ExternalNode. | |
relayRef.name | string | yes | length 1 to 63 | Name of the ExternalNode. | |
dns | object | Public 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.zone | string | up to 253 characters | The DNS zone (with spec.stationRef). | ||
dns.secretName | string | length 1 to 63 | No longer used (the zone's credential is held by the DNS operator). | ||
dns.takeover | string (one of) | "refuse" | refuse, replace | What to do with records of the name that Etorm did not make (with zone). | |
dns.zoneId | string | length 1 to 64 | DNS zone identifier for the configured DNS provider. | ||
dns.externalNodeRef | object | ExternalNode whose external IPv6/IPv4 addresses are published as AAAA/A records. | |||
dns.externalNodeRef.project | string | yes | length 1 to 63 | Project holding the ExternalNode. | |
dns.externalNodeRef.name | string | yes | length 1 to 63 | Name of the ExternalNode. | |
dns.externalNodeRefs | list of object | Multiple ExternalNodes whose external IPv6/IPv4 addresses are published as AAAA/A records for active-active HA. | |||
dns.externalNodeRefs[].project | string | yes | length 1 to 63 | Project holding the ExternalNode. | |
dns.externalNodeRefs[].name | string | yes | length 1 to 63 | Name of the ExternalNode. | |
dns.addresses | list of string | up to 8 items | Explicit public IPv6/IPv4 addresses when externalNodeRef is omitted. | ||
dns.proxied | boolean | Override proxy status (defaults to false for proxy direct, true for proxy fronted). | |||
dns.ttl | integer | 1 | 1 to 86400 | Record TTL in seconds (1 = automatic). | |
dns.secretRef | object | Optional Secret holding the DNS API token. | |||
dns.secretRef.project | string | yes | length 1 to 63 | Project holding the Secret. | |
dns.secretRef.name | string | yes | length 1 to 63 | Name of the Secret. |
Status
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
phase | string | Pending (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). | |||
target | object | Where the gateway relays to. | |||
target.vni | integer | The VPC's segment (VNI) the address is on. | |||
target.address | string | The ingress's address in its VPC. | |||
target.port | integer | The listener port. | |||
target.addresses | list of string | The 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. | |||
capacity | object | What the controller remembers to tell saturation of the stations that relay this endpoint (condition Saturated) from one pass to the next. | |||
capacity.refusedFull | integer | Connections the stations dropped at their limit, summed, at the last pass. | |||
capacity.saturatedAt | integer | Unix time of the last pass in which a station showed saturation; the condition holds five minutes after it. | |||
station | object | The station's side (with spec.stationRef). | |||
station.addresses | list of string | The station's external addresses. | |||
station.listener | string | Installed once the running node reports the listener, else Pending. | |||
relay | object | Deprecated spelling of station (same content, written for one release). | |||
relay.addresses | list of string | The station's external addresses. | |||
relay.listener | string | Installed once the running node reports the listener, else Pending. | |||
dns | object | Operator-managed public DNS state for spec.hostname. | |||
dns.phase | string | Pending, Ready or Failed. | |||
dns.message | string | Status detail. | |||
dns.repaired | list of string | The 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.records | list of object | Reconciled DNS records. | |||
dns.records[].id | string | Provider record ID (empty until the zone operator has made or adopted it). | |||
dns.records[].type | string | AAAA or A. | |||
dns.records[].name | string | Hostname. | |||
dns.records[].content | string | Target IP address. | |||
dns.records[].proxied | boolean | Whether proxied at the edge. | |||
dns.records[].record | string | The DNSRecord object that declares it. | |||
dns.records[].phase | string | The state the zone operator reports for it (Synced when it is in step at the provider). | |||
conditions | list of object | Detailed state, one entry per aspect; Ready says whether the gateway can relay. | |||
conditions[].type | string | Aspect. | |||
conditions[].status | string | True or False. | |||
conditions[].reason | string | Machine-readable reason. | |||
conditions[].message | string | Human-readable detail. |
Columns in listings
| Column | From |
|---|---|
| Hostname | .spec.hostname |
| Port | .spec.port |
| Gateway | .spec.gatewayRef.name |
| Phase | .status.phase |