Skip to content

Commit 364fd62

Browse files
authored
Merge pull request #299917 from tomkerkhove/patch-30
docs: Add guidance for health probes in Azure API Management's self-hosted gateway
2 parents c211553 + ddc90c8 commit 364fd62

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

articles/api-management/how-to-self-hosted-gateway-on-kubernetes-in-production.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,14 @@ To learn about name resolution in Kubernetes, see the [Kubernetes website](https
112112
## External traffic policy
113113
The YAML file provided in the Azure portal sets `externalTrafficPolicy` field on the [Service](https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/) object to `Local`. This preserves caller IP address (accessible in the [request context](api-management-policy-expressions.md#ContextVariables)) and disables cross node load balancing, eliminating network hops caused by it. Be aware, that this setting might cause asymmetric distribution of traffic in deployments with unequal number of gateway pods per node.
114114

115+
## Health Probing
116+
Use HTTP probes `/status-0123456789abcdef` endpoint for your readiness and liveness probes on your gateway deployments. This helps you only route traffic to gateway deployments that have successfully started up and ready to serve traffic, or are known to be still responsive.
117+
118+
Without health probes, your gateway deployments may start up faster but the configuration may not be fully loaded yet resulting in 503s in your data-plane traffic.
119+
120+
> [!TIP]
121+
> When installing with Helm, health probes are enabled for you by default.
122+
115123
## High availability
116124
The self-hosted gateway is a crucial component in the infrastructure and has to be highly available. However, failure will and can happen.
117125

0 commit comments

Comments
 (0)