Skip to main content

Gateway Templates

A Gateway template is a reusable Gateway infrastructure profile. It defines the settings that domains and streams inherit, so Gateways stay consistent across your API infrastructure. Each template generates a GatewayClass and EnvoyProxy that back the Gateways created from it.

Gateway templates are managed under the Gateway Templates section. Earlier versions called them Domain Templates, and the API path is still /domain-templates.

Capabilities​

A template is enabled for domains, streams, or both. At least one capability is required.

CapabilityCoversDefault
Enable for DomainsDomains (HTTP, HTTPS, gRPC routes) can use this templateOn
Enable for StreamsStreams (TCP, UDP routes) can use this templateOff

The Domain create form lists templates that have Domains enabled, and the Stream create form lists templates that have Streams enabled. A template with both enabled appears in both. The HTTP, HTTPS, and TLS settings below are domain listener defaults, so they apply only when Domains is enabled.

Template Properties​

PropertyDescriptionOptions
Exposure TypeService type for the GatewayLoadBalancer (internet-facing), ClusterIP (cluster-only)
HTTP PortHTTP listener port (domains)Default 80
HTTPS PortHTTPS listener port (domains)Default 443
TLS ModeWhich listeners to create (domains)tls_only, no_tls, both
TLS PolicyCertificate handling (domains)terminate, passthrough
AnnotationsCustom metadataKey-value pairs for load balancer configuration
Controller NameGatewayClass controllerDefault Envoy Gateway controller
Merge GatewaysShare a single Envoy deployment across Gatewaystrue, false
ObservabilityAccess logs, tracing, and metricsOptional telemetry configuration

How Templates Work​

Common Template Patterns​

Template NameUse Case
Public HTTPSInternet APIs with TLS termination (Domains)
Internal HTTPCluster-internal services (Domains)
Public PassthroughmTLS or custom certificate handling (Domains)
TCP/UDP StreamsExpose databases or other Layer-4 services (Streams)

Benefits​

  • Consistency: All domains and streams using a template share the same baseline configuration
  • Efficiency: Update the template to change all associated Gateways
  • Compliance: Enforce organizational standards through template policies

Templates reduce configuration drift and simplify Gateway management at scale.