Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/softonic/rate-limit-operator
Rate Limit operator for Envoy Proxy
https://github.com/softonic/rate-limit-operator
Last synced: 21 days ago
JSON representation
Rate Limit operator for Envoy Proxy
- Host: GitHub
- URL: https://github.com/softonic/rate-limit-operator
- Owner: softonic
- License: apache-2.0
- Created: 2020-08-05T10:06:53.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-15T17:21:05.000Z (8 months ago)
- Last Synced: 2024-04-15T09:21:21.666Z (2 months ago)
- Language: Go
- Size: 306 KB
- Stars: 24
- Watchers: 7
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - rate-limit-operator
README
[](https://goreportcard.com/report/softonic/rate-limit-operator)
[](https://github.com/softonic/rate-limit-operator/releases)
[](https://github.com/softonic/rate-limit-operator/blob/master/LICENSE)
[](https://hub.docker.com/r/softonic/rate-limit-operator)
# rate-limit-operator
Rate Limit operator for Envoy Proxy
# Quick Start
Steps to got Operator working
- Deploy the Operator ( kubectl or helm )
- Deploy RateLimit CR
## Deployment
### Requirements
In this example we assume you already have a k8s cluster running
### Deploy using kubectl
```bash
$ make deploy
```
You can find public image in the softonic/rate-limit-operator docker hub repository.
### Deploy using Helm
```bash
$ make helm-deploy
```
## Create a CR ratelimit
```bash
$ kubectl apply -f config/samples/networking_v1alpha1_ratelimit.yaml
```
# DEVEL ENVIRONMENT
Compile the code and deploy the needed resources
```bash
$ make generate
$ make run
```
# Motivation
The operator will help you configure the necessary resources to get to this
https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/rate_limit_filter#config-http-filters-rate-limit
from a CR that you will need to provide.
This operator will need this CR, and from this configuration will create the necessary envoyfilters resources in istio
control plane, and the necessary configs ratelimit system
https://github.com/envoyproxy/ratelimit
needs.
This is accomplished with a new CRD.
In this new CRD, you can set different configuration depending on your needs.
Here is an example you can start with
```
apiVersion: networking.softonic.io/v1alpha1
kind: RateLimit
metadata:
finalizers:
- ratelimit.networking.softonic.io
name: test
spec:
destinationCluster: outbound|80||server.nameSpaceTarget.svc.cluster.local
rate:
- dimensions:
- request_header:
descriptor_key: remote_address
header_name: x-custom-user-ip
requestPerUnit: 100
unit: second
targetRef:
apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
name: nameVS
namespace: nameSpaceTarget
```
* targetRef will point to a VS that will have the host field that you will need in your envoyfilter in order to apply the routing
* destinationCluster ( optional ) is the Cluster ( here cluster is referring to the concept of cluster in the envoy/istio language )
If you dont set this field, operator will try to find the destination cluster for your application looking at the Virtual Service http route destination
* following configuration refer to what to limit. In this case we are limiting 100 per second per x-custom-ip
# Diagram
