From 4c271007eba2dac7b4f2c3c7cab3dbc19269a1b6 Mon Sep 17 00:00:00 2001 From: Diana <75819066+cloudjumpercat@users.noreply.github.com> Date: Fri, 22 Nov 2024 08:59:24 -0600 Subject: [PATCH] Clear up supported deployments and info about how to use multiple RL plugins Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --- .../service-protection/_metadata/_index.yml | 5 ++--- .../kong-inc/service-protection/overview/_index.md | 14 ++++++++++++-- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/app/_hub/kong-inc/service-protection/_metadata/_index.yml b/app/_hub/kong-inc/service-protection/_metadata/_index.yml index ed1f9072f736..cbb6c6ea2544 100644 --- a/app/_hub/kong-inc/service-protection/_metadata/_index.yml +++ b/app/_hub/kong-inc/service-protection/_metadata/_index.yml @@ -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 diff --git a/app/_hub/kong-inc/service-protection/overview/_index.md b/app/_hub/kong-inc/service-protection/overview/_index.md index dc55ae1397ea..d32b09151f14 100644 --- a/app/_hub/kong-inc/service-protection/overview/_index.md +++ b/app/_hub/kong-inc/service-protection/overview/_index.md @@ -23,7 +23,7 @@ No. The Service Protection plugin only rate limits services. You can still use t
Can I use the Service Protection plugin with other rate limiting plugins? {% 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 }} @@ -33,13 +33,23 @@ Yes. You can rate limit a service with the Service Protection plugin and rate li
When would I use the Service Protection plugin with other rate limiting plugins? {% 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 }}
+
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? + +{% capture rl_plugins_migrate %} +IDK +{% endcapture %} + +{{ rl_plugins_use_migrate | markdownify }} + +
+ ## How it works The following diagram shows how the Service Protection plugin rate limits services: