Crate mz_balancerd 

The balancerd service is a horizontally scalable, stateless, multi-tenant ingress router for pgwire and HTTPS connections.

It listens on pgwire and HTTPS ports. When a new pgwire connection starts, the requested user is authenticated with frontegg from which a tenant id is returned. From that a target internal hostname is resolved to an IP address, and the connection is proxied to that address which has a running environmentd’s pgwire port. When a new HTTPS connection starts, its SNI hostname is used to generate an internal hostname that is resolved to an IP address, which is similarly proxied.

Modules

codec 🔒

dyncfgs 🔒

Dyncfgs used by the balancer.

Structs

BalancerConfig

BalancerMetrics

Prometheus monitoring metrics.

BalancerService

CountingConn 🔒

FronteggResolver

GaugeGuard 🔒

Wraps an IntGauge and automatically incs on init and drops on drop. Callers should not call inc().. Useful for handling multiple task exit points, for example in the case of a panic.

HttpsBalancer 🔒

InternalHttpServer 🔒

PgwireBalancer 🔒

ResolvedAddr 🔒

ServerMetrics 🔒

ServerMetricsConfig 🔒

SniTemplate

Template for constructing the destination hostname from a TLS SNI servername. {} is replaced with the first label of the servername.

TenantDnsResolver

Resolves tenant hostnames for pgwire and HTTPS routing.

Enums

BalancerResolver

CancellationResolver

ResolveError 🔒

An error resolving a connection’s destination.

Constants

BUILD_INFO

Balancer build information.

Traits

ClientStream 🔒

Functions

cancel_request 🔒

Broadcasts cancellation to all matching environmentds. conn_id’s bits [31..20] are the lower 12 bits of a UUID for an environmentd/organization. Using that and the template in cancellation_resolver we generate a hostname. That hostname resolves to all IPs of envds that match the UUID (cloud k8s infrastructure maintains that mapping). This function creates a new task for each envd and relays the cancellation message to it, broadcasting it to any envd that might match the connection.

create_resolver 🔒

Creates a resolver from the system DNS configuration.

extract_tenant_from_cname 🔒

Extracts the tenant ID from an environmentd CNAME target.

handle_readiness_check 🔒

strip_ipv6_brackets 🔒

Strips the surrounding brackets from an IPv6 host literal, e.g. [::1] becomes ::1. Leaves other hosts unchanged. This lets a bracketed IPv6 literal in an address template parse as an IpAddr and resolve, matching what tokio::net::lookup_host accepts.