Skip to main content

Edge Gateway

EdgeGateway

Defines the high-level intent for an Edge Gateway deployment.

Translates into GCP Cloud Load Balancing components and unmanaged instance groups running Envoy proxies to handle egress traffic from the service mesh to external APIs.

PropertyTypeDescription
apiVersionstring
kindstring
metadatamap
specSpec

Spec

Houses user-defined egress configuration parameters. Exposes scale and routing definitions for the egress edge proxy tier.

PropertyTypeDescription
enabledboolIf true, the egress gateway will be provisioned. If false, it will be removed.
descriptionstringThis description is optional but will drastically improve the understand of the AI assistant about the structural elements of the organization
regionstringThe GCP region where the gateway's compute instances will be deployed. This determines the region for the managed instance group that runs the Envoy proxies for the gateway.
machineTypestringThe machine type (e.g., e2-medium) for the compute instances in the gateway's instance group. Dictates the execution sizing of the allocated VM nodes running the proxies.
clusterSizeint64The number of proxy instances to run for this gateway. This sets the target instance count for the underlying compute cluster, provisioning scaling bounds.
portslist of PortDefines the ports the gateway will listen on. This provisions listener and forwarding rules dynamically on edge proxies to intercept and bridge targeted outbound communication protocols.

Port

Maps egress listener configurations to external targets. Maps directly to Envoy listener protocols and target endpoints.

PropertyTypeDescription
namestringA unique name for the port configuration.
portint64The port number the gateway will listen on.
protocolstringThe protocol for traffic on this port.
targetstringThe target hostname for traffic routed through this port.
clientAuthboolIf true, client-side authentication is required for connections on this port.