Repository navigation
DOC-7317 Add Kong, Envoy, APISIX, and OpenResty integration pages - #4605
Conversation
… correct three gateway Ecosystem bullets Adds content/integrate/kong, envoy, apisix, and openresty, one page per gateway, and links them from the rate-limiter, cache-aside, and session-store Ecosystem sections. Stock NGINX has no Redis module (the nginx.org modules index lists none), so the NGINX page documents OpenResty, which bundles NGINX with Lua and the lua-resty-redis client. Each page was run in Docker against Redis 8.0 with two gateway instances sharing one Redis server: Kong 3.9.4 (open source image, DB-less), Envoy 1.34 with envoyproxy/ratelimit, APISIX 3.13 in standalone mode, and OpenResty 1.31.8.1. All four returned 200, 200, 200, 429, 429 for a 3 per minute limit across both instances. The counters differ: Kong stores a string per route, service, client, and window; the ratelimit service stores demo_generic_key_api_ <window-start> with a TTL of 91 s for a 60 s window; APISIX stores the remaining quota (-2 after 5 requests against 3); OpenResty uses whatever key the Lua code chooses. When Redis is down Kong fails open but each request waits about 2 s (default timeout 2000 ms), Envoy and OpenResty fail open (Envoy with no added delay, with failure_mode_deny false), and APISIX returns 500 unless allow_degradation is true, which then returns 200. Three existing bullets were wrong or unsupported, per the vendors' own docs. Kong's proxy-cache-advanced, linked from cache-aside as "Kong Redis response caching", is Enterprise-only; the open source proxy-cache is memory-only. In session-store, Kong's session plugin stores sessions in a cookie or Kong's database only, and nothing in Envoy's docs supports Redis session or token storage. The session-store bullet now names APISIX, whose openid-connect plugin documents Redis session storage (not run). The prefetch-cache Kong bullet and the pub-sub "Kong and NGINX event hooks" bullet could not be tied to any documented feature and are unchanged. Learned: Kong proxy-cache-advanced and Redis sessions are Enterprise or absent; Envoy reaches Redis only through the ratelimit service; stock NGINX has no Redis module; gateways differ on whether they fail open when Redis is down Constraint: Gateway behavior comes from two-instance runs against the versions named; recheck when Kong, Envoy, APISIX, or OpenResty ship a major version Directive: Do not describe Kong Redis response caching or session storage without saying it is Enterprise or unavailable; do not claim Envoy stores sessions in Redis Gaps: Kong Enterprise plugins, Envoy redis_proxy filter, APISIX limit-req and limit-conn and openid-connect Redis sessions, APISIX Sentinel (needs 3.18), and Redis Cluster for any gateway not run; prefetch-cache Kong bullet and pub-sub Kong and NGINX bullet unverified and unchanged; upstream links point at vendor docs Recheck: when Kong 4, Envoy 2, or APISIX 4 ships Ticket: DOC-7317 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 3bb3eaa |
dwdougherty
left a comment
There was a problem hiding this comment.
LGTM. Lots of great stuff I've never heard of.
|
Thanks @dwdougherty ! Yeah, when I saw some of these, I figured they might be worth exploring further. I'll also start a thread in our just-opened Discussions section to see if anyone has more suggestions or feedback about this stuff (I doubt we'll get much response, but worth a try eh?) |
Summary
content/integrate/, one per API gateway: Kong Gateway, Envoy, Apache APISIX, and OpenResty (the page for NGINX; stock NGINX has no Redis module).Verification
Each page was run in Docker against Redis 8.0 with two gateway instances sharing one Redis server, using a 3 per minute limit: Kong 3.9.4 (open source image), Envoy 1.34 with
envoyproxy/ratelimit, APISIX 3.13 (standalone), and OpenResty 1.31.8.1. All four returned200,200,200,429,429across both instances. The pages record the counter keys and what happens when Redis is down:failure_mode_deny: false)500by default;allow_degradation: truefails openFor review: corrections to existing bullets
These come from the vendors' docs, read through a fetch agent. Please check them.
proxy-cache-advancedis Enterprise-only (tier: enterprise), and the open sourceproxy-cacheis memory-only. The bullet now says "Kong Gateway Enterprise only".sessionplugin stores sessions in a cookie or Kong's database, with no Redis option, and nothing in Envoy's docs supports Redis session or token storage. Both are removed. The bullet now names APISIX, whoseopenid-connectplugin documentssession.storage: redis(not run).Left unchanged because I couldn't tie them to a documented feature: the prefetch-cache bullet about Kong plugins routing reads to Redis, and the pub-sub "Kong and NGINX event hooks" bullet. Should those be reworded or dropped?
Not run, and not claimed
Kong Enterprise plugins, Envoy's
redis_proxyfilter, APISIXlimit-req,limit-conn, andopenid-connectRedis sessions, APISIX Sentinel (needs 3.18), and Redis Cluster for any gateway.🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes with corrected external links and new markdown pages; no application code or runtime behavior.
Overview
Adds four new integration docs under
content/integrate/for Kong Gateway, Envoy, Apache APISIX, and OpenResty, each with tested Redis-backed rate limiting (and OpenResty cache-aside), including sample config, Redis key shapes, and behavior when Redis is unavailable.Ecosystem sections on the cache-aside, rate-limiter, and session-store use cases now link to these pages instead of scattered vendor URLs. Copy fixes align bullets with vendor docs: Kong Proxy Cache Advanced is called out as Enterprise-only; Kong/Envoy are dropped from gateway session-store lists (no documented Redis session storage); OpenResty is added for gateway rate limiting/caching; APISIX
openid-connectRedis sessions are noted for session-store.Reviewed by Cursor Bugbot for commit 3bb3eaa. Bugbot is set up for automated code reviews on this repo. Configure here.