https://github.com/Kuadrant/limitador
Rate limiter
https://github.com/Kuadrant/limitador
envoy kubernetes rate-limiting rust
Last synced: 5 months ago
JSON representation
Rate limiter
- Host: GitHub
- URL: https://github.com/Kuadrant/limitador
- Owner: Kuadrant
- License: apache-2.0
- Created: 2020-05-20T08:51:56.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-16T16:07:51.000Z (about 1 year ago)
- Last Synced: 2024-04-17T19:16:30.515Z (about 1 year ago)
- Topics: envoy, kubernetes, rate-limiting, rust
- Language: Rust
- Homepage:
- Size: 4.58 MB
- Stars: 48
- Watchers: 7
- Forks: 18
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-grpc - limitador - Generic rate-limiter written in Rust exposing a gRPC service that implements the Envoy Rate Limit protocol (v3). (Tools / Other)
README
# Limitador
[](https://github.com/Kuadrant/limitador/actions/workflows/rust.yml)
[](https://docs.rs/limitador)
[](https://crates.io/crates/limitador)
[](https://quay.io/repository/kuadrant/limitador)
[](https://codecov.io/gh/Kuadrant/limitador)
[](https://app.fossa.com/projects/custom%2B162%2Fgit%2Bgithub.com%2FKuadrant%2Flimitador?ref=badge_shield&issueType=license)
Limitador is a generic rate-limiter written in Rust. It can be used as a
library, or as a service. The service exposes HTTP endpoints to apply and observe
limits. Limitador can be used with Envoy because it also exposes a grpc service, on a different
port, that implements the Envoy Rate Limit protocol (v3).
- [**Getting started**](#getting-started)
- [**How it works**](doc/how-it-works.md)
- [**Configuration**](doc/server/configuration.md)
- [**Development**](#development)
- [**Testing Environment**](limitador-server/sandbox/README.md)
- [**Kubernetes**](limitador-server/kubernetes/README.md)
- [**Contributing**](#contributing)
- [**License**](#license)
Limitador is under active development, and its API has not been stabilized yet.
## Getting started
- [Rust library](#rust-library)
- [Server](#server)
### Rust library
Add this to your `Cargo.toml`:
```toml
[dependencies]
limitador = { version = "0.3.0" }
```
For more information, see the [`README` of the crate](limitador/README.md)
### Server
Run with Docker (replace `latest` with the version you want):
```bash
docker run --rm --net=host -it quay.io/kuadrant/limitador:v1.0.0
```
Run locally:
```bash
cargo run --release --bin limitador-server -- --help
```
Refer to the help message on how to start up the server. More information are available
in the [server's `README.md`](limitador-server/README.md)
## Development
### Build
```bash
cargo build
```
### Run the tests
Some tests need a redis deployed in `localhost:6379`. You can run it in Docker with:
```bash
docker run --rm -p 6379:6379 -it redis
```
Then, run the tests:
```bash
cargo test --all-features
```
or you can run tests disabling the "redis storage" feature:
```bash
cd limitador; cargo test --no-default-features
```
## Contributing
Join us on the [#kuadrant](https://kubernetes.slack.com/archives/C05J0D0V525) channel in the Kubernetes Slack workspace,
for live discussions about the roadmap and more.
## License
[Apache 2.0 License](LICENSE)
[](https://app.fossa.com/projects/custom%2B162%2Fgit%2Bgithub.com%2FKuadrant%2Flimitador?ref=badge_large&issueType=license)