mirror of
https://github.com/cloudflare/pingora.git
synced 2024-09-19 18:21:34 +02:00
586781a685
Includes-commit: ba75f36b39
Replicated-from: https://github.com/cloudflare/pingora/pull/7
76 lines
3.4 KiB
Markdown
76 lines
3.4 KiB
Markdown
# Pingora
|
|
|
|
|
|
|
|
## What is Pingora
|
|
Pingora is a Rust framework to [build fast, reliable and programmable networked systems](https://blog.cloudflare.com/pingora-open-source).
|
|
|
|
Pingora is battle tested as it has been serving more than 40 million Internet requests per second for [more than a few years](https://blog.cloudflare.com/how-we-built-pingora-the-proxy-that-connects-cloudflare-to-the-internet).
|
|
|
|
## Feature highlights
|
|
* Async Rust: fast and reliable
|
|
* HTTP 1/2 end to end proxy
|
|
* TLS over OpenSSL or BoringSSL
|
|
* gRPC and websocket proxying
|
|
* Graceful reload
|
|
* Customizable load balancing and failover strategies
|
|
* Support for a variety of observability tools
|
|
|
|
## Reasons to use Pingora
|
|
* **Security** is your top priority: Pingora is a more memory safe alternative for services that are written in C/C++
|
|
* Your service is **performance-sensitive**: Pingora is fast and efficient
|
|
* Your service requires extensive **customization**: The APIs Pingora proxy framework provides are highly programmable
|
|
|
|
# Getting started
|
|
|
|
See our [quick starting guide](./docs/quick_start.md) to see how easy it is to build a load balancer.
|
|
|
|
Our [user guide](./docs/user_guide/index.md) covers more topics such as how to configure and run Pingora servers, as well as how to build custom HTTP servers and proxy logic on top of Pingora's framework.
|
|
|
|
API docs are also available for all the crates.
|
|
|
|
# Notable crates in this workspace
|
|
* Pingora: the "public facing" crate to build networked systems and proxies
|
|
* Pingora-core: this crate defines the protocols, functionalities and basic traits
|
|
* Pingora-proxy: the logic and APIs to build HTTP proxies
|
|
* Pingora-error: the common error type used across Pingora crates
|
|
* Pingora-http: the HTTP header definitions and APIs
|
|
* Pingora-openssl & pingora-boringssl: SSL related extensions and APIs
|
|
* Pingora-ketama: the [Ketama](https://github.com/RJ/ketama) consistent algorithm
|
|
* Pingora-limits: efficient counting algorithms
|
|
* Pingora-load-balancing: load balancing algorithm extensions for pingora-proxy
|
|
* Pingora-memory-cache: Async in-memory caching with cache lock to prevent cache stampede
|
|
* Pingora-timeout: A more efficient async timer system
|
|
* TinyUfo: The caching algorithm behind pingora-memory-cache
|
|
|
|
# System requirements
|
|
|
|
## Systems
|
|
Linux is our tier 1 environment and main focus.
|
|
|
|
We will try our best for most code to compile for Unix environments. This is for developers and users to have an easier time developing with Pingora in Unix-like environments like macOS (though some features might be missing)
|
|
|
|
Both x86_64 and aarch64 architectures will be supported.
|
|
|
|
## Rust version
|
|
|
|
Pingora keeps a rolling MSRV (minimum supported Rust version) policy of 6 months. This means we will accept PRs that upgrade the MSRV as long as the new Rust version used is at least 6 months old.
|
|
|
|
Our current MSRV is 1.72.
|
|
|
|
## Build Requirements
|
|
|
|
Some of the crates in this repository have dependencies on additional tools and
|
|
libraries that must be satisfied in order to build them:
|
|
|
|
* Make sure that [Clang] is installed on your system (for boringssl)
|
|
* Make sure that [Perl 5] is installed on your system (for openssl)
|
|
|
|
[Clang]:https://clang.llvm.org/
|
|
[Perl 5]:https://www.perl.org/
|
|
|
|
# Contributing
|
|
Please see our [contribution guidelines](./.github/CONTRIBUTING.md).
|
|
|
|
# License
|
|
This project is Licensed under [Apache License, Version 2.0](./LICENSE).
|