Skip to content

Commit 7d67b2c

Browse files
Merge pull request #213551 from tomkerkhove/http-proxy-guidance
docs(shgw): Provide production guidance around HTTP(S) proxy in Kubernetes (API Management)
2 parents acfae42 + 10d40e5 commit 7d67b2c

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,20 @@ The self-hosted gateway sends telemetry to [Azure Monitor](api-management-howto-
126126
When [connectivity to Azure](self-hosted-gateway-overview.md#connectivity-to-azure) is temporarily lost, the flow of telemetry to Azure is interrupted and the data is lost for the duration of the outage.
127127
Consider [setting up local monitoring](how-to-configure-local-metrics-logs.md) to ensure the ability to observe API traffic and prevent telemetry loss during Azure connectivity outages.
128128

129+
## HTTP(S) proxy
130+
131+
The self-hosted gateway provides support for HTTP(S) proxy by using the traditional `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables.
132+
133+
Once configured, the self-hosted gateway will automatically use the proxy for all outbound HTTP(S) requests to the backend services.
134+
135+
Starting with version 2.1.5 or above, the self-hosted gateway provides observability related to request proxying:
136+
137+
- [API Inspector](api-management-howto-api-inspector.md) will show additional steps when HTTP(S) proxy is being used and its related interactions.
138+
- Verbose logs are provided to provide indication of the request proxy behavior.
139+
140+
> [!Warning]
141+
> Ensure that the [infrastructure requirements](self-hosted-gateway-overview.md#fqdn-dependencies) have been met and that the self-hosted gateway can still connect to them or certain functionality will not work properly.
142+
129143
## High availability
130144
The self-hosted gateway is a crucial component in the infrastructure and has to be highly available. However, failure will and can happen.
131145

0 commit comments

Comments
 (0)