Skip to content

Commit b494c3f

Browse files
committed
addressed tom's review comments
1 parent 3de1362 commit b494c3f

5 files changed

+17
-15
lines changed

articles/api-management/api-management-gateways-overview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,8 @@ Managed and self-hosted gateways support all available [policies](api-management
109109

110110
<sup>1</sup> Configured policies that aren't supported by the self-hosted gateway are skipped during policy execution.<br/>
111111
<sup>2</sup> The rate limit by key and quota by key policies aren't available in the Consumption tier.<br/>
112-
<sup>3</sup> [!INCLUDE [api-management-self-hosted-gateway-rate-limit](../../includes/api-management-self-hosted-gateway-rate-limit.md)]
112+
<sup>3</sup> [!INCLUDE [api-management-self-hosted-gateway-rate-limit](../../includes/api-management-self-hosted-gateway-rate-limit.md)] [Learn more](how-to-self-hosted-gateway-on-kubernetes-in-production.md#request-throttling)
113+
113114

114115
### Monitoring
115116

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,16 @@ By default, a self-hosted gateway is deployed with a **RollingUpdate** deploymen
173173

174174
We recommend reducing container logs to warnings (`warn`) to improve for performance. Learn more in our [self-hosted gateway configuration reference](self-hosted-gateway-settings-reference.md).
175175

176+
## Request throttling
177+
178+
Request throttling in a self-hosted gateway can be enabled by using the API Management [rate-limit](rate-limit-policy.md) or [rate-limit-by-key](rate-limit-by-key-policy.md) policy. Configure rate limit counts to synchronize among gateway instances across cluster nodes by exposing the following ports in the Kubernetes deployment for instance discovery:
179+
180+
* Port 4290 (UDP), for the rate limiting synchronization
181+
* Port 4291 (UDP), for sending heartbeats to other instances
182+
183+
> [!NOTE]
184+
> [!INCLUDE [api-management-self-hosted-gateway-rate-limit](../../includes/api-management-self-hosted-gateway-rate-limit.md)]
185+
176186
## Security
177187
The self-hosted gateway is able to run as non-root in Kubernetes allowing customers to run the gateway securely.
178188

@@ -195,17 +205,6 @@ securityContext:
195205
> [!WARNING]
196206
> When using local CA certificates, the self-hosted gateway must run with user ID (UID) `1001` in order to manage the CA certificates otherwise the gateway will not start up.
197207

198-
## Request throttling
199-
200-
Request throttling in a self-hosted gateway can be enabled by using the API Management [rate-limit](rate-limit-policy.md) or [rate-limit-by-key](rate-limit-by-key-policy.md) policy. Configure rate limit counts to synchronize locally (among gateway instances across cluster nodes) by exposing the following ports in the Kubernetes deployment for instance discovery:
201-
202-
* Port 4290 (UDP), for the rate limiting synchronization
203-
* Port 4291 (UDP), for sending heartbeats to other instances
204-
205-
Configure these settings, for example, using the default [Helm chart deployment](how-to-deploy-self-hosted-gateway-kubernetes-helm.md) for Kubernetes or using the Azure portal [deployment templates](how-to-deploy-self-hosted-gateway-kubernetes.md).
206-
207-
> [!NOTE]
208-
> Rate limit counts don't synchronize with other gateways, including the managed gateway in the cloud.
209208

210209
## Next steps
211210

articles/api-management/rate-limit-by-key-policy.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ To understand the difference between rate limits and quotas, [see Rate limits an
5858

5959
### Usage notes
6060

61-
* [!INCLUDE [api-management-self-hosted-gateway-rate-limit](../../includes/api-management-self-hosted-gateway-rate-limit.md)]
61+
* [!INCLUDE [api-management-self-hosted-gateway-rate-limit](../../includes/api-management-self-hosted-gateway-rate-limit.md)] [Learn more](how-to-self-hosted-gateway-on-kubernetes-in-production.md#request-throttling)
62+
6263

6364
## Example
6465

articles/api-management/rate-limit-policy.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@ To understand the difference between rate limits and quotas, [see Rate limits an
8686
* This policy can be used only once per policy definition.
8787
* Except where noted, [policy expressions](api-management-policy-expressions.md) can't be used in attribute values for this policy.
8888
* This policy is only applied when an API is accessed using a subscription key.
89-
* [!INCLUDE [api-management-self-hosted-gateway-rate-limit](../../includes/api-management-self-hosted-gateway-rate-limit.md)]
89+
* [!INCLUDE [api-management-self-hosted-gateway-rate-limit](../../includes/api-management-self-hosted-gateway-rate-limit.md)] [Learn more](how-to-self-hosted-gateway-on-kubernetes-in-production.md#request-throttling)
90+
9091

9192
## Example
9293

includes/api-management-self-hosted-gateway-rate-limit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ ms.topic: include
55
ms.date: 01/17/2023
66
ms.author: danlep
77
---
8-
Rate limit counts in a self-hosted gateway can be configured to synchronize locally (among gateway instances across cluster nodes), for example, through Helm chart deployment for Kubernetes or using the Azure portal [deployment templates](../articles/api-management/how-to-deploy-self-hosted-gateway-kubernetes.md). However, rate limit counts don't synchronize with other gateways, including the managed gateway in the cloud. [Learn more](../articles/api-management/how-to-self-hosted-gateway-on-kubernetes-in-production.md#request-throttling)
8+
Rate limit counts in a self-hosted gateway can be configured to synchronize locally (among gateway instances across cluster nodes), for example, through Helm chart deployment for Kubernetes or using the Azure portal [deployment templates](../articles/api-management/how-to-deploy-self-hosted-gateway-kubernetes.md). However, rate limit counts don't synchronize with other gateway resources configured in the API Management instance, including the managed gateway in the cloud.

0 commit comments

Comments
 (0)