Skip to content

Commit

Permalink
Clear up supported deployments and info about how to use multiple RL …
Browse files Browse the repository at this point in the history
…plugins

Signed-off-by: Diana <[email protected]>
  • Loading branch information
cloudjumpercat committed Nov 22, 2024
1 parent 99feaa7 commit 4c27100
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
5 changes: 2 additions & 3 deletions app/_hub/kong-inc/service-protection/_metadata/_index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,10 @@ free: false
enterprise: true

konnect: true
# verify this, just setting to render

network_config_opts: traditional, and db-less
network_config_opts: all

notes: The plugin supports local/redis policies, not cluster policies, so it doesn't work in hybrid mode.
notes: This plugin doesn't support cluster policies. If you want to use this plugin in hybrid mode, you must use Redis for storage.

dbless_compatible: yes
# verify this, just setting to render
Expand Down
14 changes: 12 additions & 2 deletions app/_hub/kong-inc/service-protection/overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ No. The Service Protection plugin only rate limits services. You can still use t
<details><summary>Can I use the Service Protection plugin with other rate limiting plugins?</summary>

{% capture rl_plugins_compatibility %}
Yes. You can rate limit a service with the Service Protection plugin and rate limit a different service or a consumer with the other rate limiting plugins.
Yes. You can rate limit a service with the Service Protection plugin and rate limit a route or a consumer with the other rate limiting plugins. We don't recommend rate limiting the same services with the Service Protection plugin and another rate limiting plugin.
{% endcapture %}

{{ rl_plugins_compatibility | markdownify }}
Expand All @@ -33,13 +33,23 @@ Yes. You can rate limit a service with the Service Protection plugin and rate li
<details><summary>When would I use the Service Protection plugin with other rate limiting plugins?</summary>

{% capture rl_plugins_use_cases %}
You could use the Rate Limiting Advanced plugin to apply global rate limits and then use the Service Protection plugin to apply rate limits to a specific service. Because the Service Protection plugin executes before the Rate Limiting Advanced plugin because of [plugin priority order](), you can apply more granual rate limits to the specific service than you do globally.
You should use the Service Protection plugin to rate limit your services and use the other rate limiting plugins to limit other entities, like consumers or routes, or to apply global rate limits.
{% endcapture %}

{{ rl_plugins_use_cases | markdownify }}

</details>

<details><summary>If I'm currently using a different rate limiting plugin to rate limit my services, should I migrate to the Service Protection plugin? And if so, how do I migrate?</summary>

{% capture rl_plugins_migrate %}
IDK
{% endcapture %}

{{ rl_plugins_use_migrate | markdownify }}

</details>

## How it works

The following diagram shows how the Service Protection plugin rate limits services:
Expand Down

0 comments on commit 4c27100

Please sign in to comment.