monitoringRef | reference to MonitoringWorkspace | | | | Optional MonitoringWorkspace to send L3/L4/L7 flow and latency telemetry to. |
vpcRef | reference to VPC | yes | | | The VPC the nodes and the backends are on. Cannot be changed. |
level | string (one of) | | "l7" | l3, l4, l7 | l3 forwards every IP packet to target; l4 forwards TCP and UDP listeners; l7 routes HTTP and HTTPS requests by host, path and headers. Cannot be changed. |
target | object | | | | l3: where every packet goes. Exactly one of loadBalancerRef, processRef, accountRef or address. |
target.loadBalancerRef | object | | | | A load balancer of this project: traffic goes to its node addresses. |
target.loadBalancerRef.name | string | yes | | length 1 to 63 | Name of the load balancer. |
target.processRef | object | | | | A Compute process: traffic goes to its first interface on the VPC. |
target.processRef.name | string | yes | | length 1 to 63 | Name of the process. |
target.accountRef | object | | | | A VPC member (Account). |
target.accountRef.name | string | yes | | length 1 to 63 | Name of the account. |
target.address | string | | | up to 45 characters | An IPv6 or IPv4 address literal. IPv4 only when the VPC has an IPv4 network. |
target.port | integer | | | 1 to 65535 | Port to connect to. Defaults to the load balancer's first listener port; required otherwise. |
target.databaseRef | object | | | | A Database of this project: traffic goes to the node that has the role now (so it follows a failover). The port defaults to the database port. |
target.databaseRef.name | string | yes | | length 1 to 63 | Name of the database. |
target.databaseRef.role | string (one of) | yes | | primary, replicas | primary (the node that accepts writes) or replicas (the read-only nodes, else the primary). |
target.brokerRef | object | | | | A MessageBroker of this project: traffic goes to the node(s) that serve now. The port defaults to the first protocol port the node offers. |
target.brokerRef.name | string | yes | | length 1 to 63 | Name of the message broker. |
target.brokerRef.role | string (one of) | yes | | serving, endpoints | serving (the node that serves now) or endpoints (every node). |
listeners | list of object | | | up to 8 items | l4 and l7: the ports the ingress accepts on. |
listeners[].name | string | | | up to 63 characters | Name of the listener, unique; defaults to <protocol>-<port>. |
listeners[].protocol | string (one of) | yes | | tcp, udp, http, https | Protocol the listener accepts. |
listeners[].port | integer | yes | | 1 to 65535 | Port the listener accepts on. |
listeners[].target | object | | | | Where this listener's traffic goes. Exactly one of loadBalancerRef, processRef, accountRef or address. |
listeners[].target.loadBalancerRef | object | | | | A load balancer of this project: traffic goes to its node addresses. |
listeners[].target.loadBalancerRef.name | string | yes | | length 1 to 63 | Name of the load balancer. |
listeners[].target.processRef | object | | | | A Compute process: traffic goes to its first interface on the VPC. |
listeners[].target.processRef.name | string | yes | | length 1 to 63 | Name of the process. |
listeners[].target.accountRef | object | | | | A VPC member (Account). |
listeners[].target.accountRef.name | string | yes | | length 1 to 63 | Name of the account. |
listeners[].target.address | string | | | up to 45 characters | An IPv6 or IPv4 address literal. IPv4 only when the VPC has an IPv4 network. |
listeners[].target.port | integer | | | 1 to 65535 | Port to connect to. Defaults to the load balancer's first listener port; required otherwise. |
listeners[].target.databaseRef | object | | | | A Database of this project: traffic goes to the node that has the role now (so it follows a failover). The port defaults to the database port. |
listeners[].target.databaseRef.name | string | yes | | length 1 to 63 | Name of the database. |
listeners[].target.databaseRef.role | string (one of) | yes | | primary, replicas | primary (the node that accepts writes) or replicas (the read-only nodes, else the primary). |
listeners[].target.brokerRef | object | | | | A MessageBroker of this project: traffic goes to the node(s) that serve now. The port defaults to the first protocol port the node offers. |
listeners[].target.brokerRef.name | string | yes | | length 1 to 63 | Name of the message broker. |
listeners[].target.brokerRef.role | string (one of) | yes | | serving, endpoints | serving (the node that serves now) or endpoints (every node). |
listeners[].tls | object | | | | TLS termination (https listeners). |
listeners[].tls.certificateRef | object | yes | | | The certificate the listener presents. |
listeners[].tls.certificateRef.name | string | yes | | length 1 to 63 | Name of the Certificate. |
listeners[].tls.minVersion | string (one of) | | "1.2" | 1.2, 1.3 | Lowest TLS version accepted. |
rules | list of object | | | up to 32 items | l7: the first rule that matches decides; none matches means defaultTarget, else 404. |
rules[].host | string | | | up to 253 characters | Host name, or *.name for any subdomain. Empty matches any host. |
rules[].path | string | | | up to 512 characters | Exact path. |
rules[].pathPrefix | string | | | up to 512 characters | Path prefix on a segment boundary: /api matches /api and /api/x, not /apix. |
rules[].headers | list of object | | | up to 8 items | Headers that must all be present with exactly this value. |
rules[].headers[].name | string | yes | | up to 64 characters | Header name. |
rules[].headers[].value | string | yes | | up to 256 characters | Header value. |
rules[].listener | string | | | up to 63 characters | Only requests that arrived on this listener. |
rules[].target | object | yes | | | Where matching requests go. |
rules[].target.loadBalancerRef | object | | | | A load balancer of this project: traffic goes to its node addresses. |
rules[].target.loadBalancerRef.name | string | yes | | length 1 to 63 | Name of the load balancer. |
rules[].target.processRef | object | | | | A Compute process: traffic goes to its first interface on the VPC. |
rules[].target.processRef.name | string | yes | | length 1 to 63 | Name of the process. |
rules[].target.accountRef | object | | | | A VPC member (Account). |
rules[].target.accountRef.name | string | yes | | length 1 to 63 | Name of the account. |
rules[].target.address | string | | | up to 45 characters | An IPv6 or IPv4 address literal. IPv4 only when the VPC has an IPv4 network. |
rules[].target.port | integer | | | 1 to 65535 | Port to connect to. Defaults to the load balancer's first listener port; required otherwise. |
rules[].target.databaseRef | object | | | | A Database of this project: traffic goes to the node that has the role now (so it follows a failover). The port defaults to the database port. |
rules[].target.databaseRef.name | string | yes | | length 1 to 63 | Name of the database. |
rules[].target.databaseRef.role | string (one of) | yes | | primary, replicas | primary (the node that accepts writes) or replicas (the read-only nodes, else the primary). |
rules[].target.brokerRef | object | | | | A MessageBroker of this project: traffic goes to the node(s) that serve now. The port defaults to the first protocol port the node offers. |
rules[].target.brokerRef.name | string | yes | | length 1 to 63 | Name of the message broker. |
rules[].target.brokerRef.role | string (one of) | yes | | serving, endpoints | serving (the node that serves now) or endpoints (every node). |
defaultTarget | object | | | | l7: where requests go when no rule matches. |
defaultTarget.loadBalancerRef | object | | | | A load balancer of this project: traffic goes to its node addresses. |
defaultTarget.loadBalancerRef.name | string | yes | | length 1 to 63 | Name of the load balancer. |
defaultTarget.processRef | object | | | | A Compute process: traffic goes to its first interface on the VPC. |
defaultTarget.processRef.name | string | yes | | length 1 to 63 | Name of the process. |
defaultTarget.accountRef | object | | | | A VPC member (Account). |
defaultTarget.accountRef.name | string | yes | | length 1 to 63 | Name of the account. |
defaultTarget.address | string | | | up to 45 characters | An IPv6 or IPv4 address literal. IPv4 only when the VPC has an IPv4 network. |
defaultTarget.port | integer | | | 1 to 65535 | Port to connect to. Defaults to the load balancer's first listener port; required otherwise. |
defaultTarget.databaseRef | object | | | | A Database of this project: traffic goes to the node that has the role now (so it follows a failover). The port defaults to the database port. |
defaultTarget.databaseRef.name | string | yes | | length 1 to 63 | Name of the database. |
defaultTarget.databaseRef.role | string (one of) | yes | | primary, replicas | primary (the node that accepts writes) or replicas (the read-only nodes, else the primary). |
defaultTarget.brokerRef | object | | | | A MessageBroker of this project: traffic goes to the node(s) that serve now. The port defaults to the first protocol port the node offers. |
defaultTarget.brokerRef.name | string | yes | | length 1 to 63 | Name of the message broker. |
defaultTarget.brokerRef.role | string (one of) | yes | | serving, endpoints | serving (the node that serves now) or endpoints (every node). |
nodes | integer | | 1 | 1 to 5 | How many nodes run the data plane. Each has its own address; any node accepts any traffic and they agree on every choice. |
affinityGroup | string | | | up to 63 characters | Run the nodes on the same host as every other process of the project with this affinity group (for example the backends the balancer reaches while no path joins two hosts). Without it the nodes are spread over different hosts. |
maxNodes | integer | | | 1 to 5 | The most nodes the platform may run by itself. When the nodes refuse connections (condition Saturated) the platform raises spec.nodes by one, with a cooldown, up to this number. Unset, it never changes spec.nodes. |
resources | object | | {} | | What each node may use. |
resources.memoryPower | integer | | 6 | 0 to 10 | Memory per node: 64 KiB times two to this power (6 is 4 MiB). |
resources.cpuMillicores | integer | | 250 | 1 to 1000 | Processor time per node on average, in thousandths of a core. |
public | object | | | | Publishes the ingress under a public name from the internet (spec 0026, "Public names"). Only in system projects. The platform makes everything else: a PublicEndpoint (the door on the gateway host), the listener on the station, the DNS records, and shows the result in status.public. Deleting the ingress removes all of it. |
public.hostname | string | yes | | up to 253 characters | The public DNS name (lower case), for example code.etorm.com. |
public.port | integer | | 443 | 1 to 65535 | The TCP port clients connect to (and on the station and the gateway host). |
public.proxy | string (one of) | | "fronted" | fronted, direct | fronted: a proxy in front of the station ends the clients' TLS with a public certificate and connects over TLS without checking the ingress's own certificate (the ingress then needs a generated certificate). direct: clients connect to the relay itself, which then needs a certificate they trust; use fronted. |
public.gatewayRef | object | yes | | | The gateway whose host relays to the ingress (it must have the ingress's VPC attached). |
public.gatewayRef.name | string | yes | | length 1 to 63 | Name of the gateway. |
public.stationRef | object | | | | The station (an ExternalNode) that publishes the port on its public addresses. Without it only the gateway host listens. |
public.stationRef.project | string | yes | | length 1 to 63 | The system project that holds the ExternalNode. |
public.stationRef.name | string | yes | | length 1 to 63 | Name of the ExternalNode. |
public.relayRef | object | | | | Deprecated spelling of stationRef: still read, and used when stationRef is not set. |
public.relayRef.project | string | yes | | length 1 to 63 | The system project that holds the ExternalNode. |
public.relayRef.name | string | yes | | length 1 to 63 | Name of the ExternalNode. |
public.dns | object | | | | Where the public name is published in DNS. Without it no record is made (the name is set outside the platform). |
public.dns.zone | string | yes | | up to 253 characters | The DNS zone that holds the name, for example etorm.com. |
public.dns.secretName | string | | | length 1 to 63 | No longer used. The platform's DNS operator holds the zone's credential (a DNSZone names it); the records are declared as DNSRecord objects. |
public.dns.takeover | string (one of) | | "refuse" | refuse, replace | What to do when the name already has records of its own that Etorm did not make. Kept for compatibility: the zone operator adopts a record with the same type, name and content and repairs one of the same type and name (the zone policy decides), so it no longer refuses; the old records are not put back when the name is removed). |