Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/globocom/kong-plugin-proxy-cache
A Proxy Caching plugin for Kong makes it fast and easy to configure caching of responses and serving of those cached responses in Redis
https://github.com/globocom/kong-plugin-proxy-cache
Last synced: 3 months ago
JSON representation
A Proxy Caching plugin for Kong makes it fast and easy to configure caching of responses and serving of those cached responses in Redis
- Host: GitHub
- URL: https://github.com/globocom/kong-plugin-proxy-cache
- Owner: globocom
- License: mit
- Created: 2018-09-21T20:53:28.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-13T16:46:32.000Z (almost 6 years ago)
- Last Synced: 2024-06-22T23:50:56.246Z (5 months ago)
- Language: Lua
- Size: 130 KB
- Stars: 45
- Watchers: 39
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
kong-plugin-proxy-cache
A Proxy Caching plugin for Kong
A Proxy Caching plugin for Kong makes it fast and easy to configure caching of responses and serving of those cached responses in Redis. It caches responses bases on configurable response code and request headers with the request method.
This Kong plugin adds a non-standard `X-Cache-Status` header. There are several possible values for this header:
* `MISS`: The resource was not found in cache, and the request was proxied upstream.
* `HIT`: The request was satisfied and served from cache.
* `BYPASS`: The request could not be satisfied from cache based on plugin settings.
## Getting started
Configure this plugin on a Service by making the following request:
```shell
$ curl -X POST http://kong:8001/services/debug-upstream/plugins \
--data "name=proxy-cache" \
--data "config.cache_ttl=300" \
--data "config.redis.host=127.0.0.1"
```
* **service**: the id or name of the Service that this plugin configuration will target.
## Configuration
Here's a list of all the settings which can be used in this plugin:
> Note: The required fields are in bold.
| Field | Default | Description
|----------------|---------------|----------------------------------------------------
| **response_code** | 200, 301, 302 | Upstream response status code considered cacheable
| vary_headers | | Relevant headers considered for the cache key
| vary_nginx_variables | | Relevant nginx variables considered for the cache key
| **cache_ttl** | 300 | TTL, in seconds, of cache responses
| cache_control | true | Respect the Cache-Control behaviors
| **redis.host** | | Host to use for Redis connection
| **redis.port** | 6379 | Port to use for Redis connection
| **redis.timeout** | 2000 | Connection timeout to use for Redis connection
| redis.password | | Password to use for Redis connection
| **redis.database** | 0 | Database to use for Redis connection
| redis.sentinel_master_name | | Sentinel master name to use for Redis connection. Defining this value implies using Redis Sentinel
| redis.sentinel_role | | Sentinel role to use for Redis connection
| redis.sentinel_addresses | | Sentinel address to use for Redis connection
| **redis.max_idle_timeout** | 10000 | maximal idle timeout (in ms) for keep alive the Redis connection
| **redis.pool_size** | 1000 | maximal pool size by Redis connection
### Cache Control
When the `cache_control` is enabled by settings, Kong will respect request and response `Cache-Control` headers as defined by RFC7234, with a few notes:
* The behavior of no-cache is simplified to exclude the entity from being cached entirely.
* Secondary key calculation via Vary is not yet supported.
## Installing
### From LuaRocks
```shell
$ luarocks install kong-plugin-proxy-cache
```
### From GitHub
```shell
$ sh -c "git clone https://github.com/globocom/kong-plugin-proxy-cache /tmp/kong-plugin-proxy-cache && cd /tmp/kong-plugin-proxy-cache && luarocks make *.rockspec"
```
## Contributing
Please, read the contribute guide [CONTRIBUTING](./CONTRIBUTING.md).
## License
kong-plugin-proxy-cache is [MIT licensed](./LICENSE).