aeraki

README

Aeraki （中文）

---

Manage any layer-7 traffic in a service mesh!

Aeraki [Air-rah-ki] is the Greek word for 'breeze'. While service mesh becomes an important infrastructure for microservices, many(if not all) service mesh implementations mainly focus on HTTP protocols and treat other protocols as plain TCP traffic. Aeraki Mesh is created to provide a non-intrusive, highly extendable way to manage any layer-7 traffic in a service mesh.

Note: Aeraki only handles non-HTTP layer-7 traffic in a service mesh, and leaves the HTTP traffic to other existing service mesh projects. (As they have already done a very good job on it, and we don't want to reinvent the wheel! ) Aeraki currently can be integrated with Istio, and it may support other service mesh projects in the future.

Problems to solve

We are facing some challenges in service meshes:

• Istio and other popular service mesh implementations have very limited support for layer-7 protocols other than HTTP and gRPC.
• Envoy RDS(Route Discovery Service) is solely designed for HTTP. Other protocols such as Dubbo and Thrift can only use listener in-line routes for traffic management, which breaks existing connections when routes change.
• It takes a lot of effort to introduce a proprietary protocol into a service mesh. You’ll need to write an Envoy filter to handle the traffic in the data plane, and a control plane to manage those Envoy proxies.

Those obstacles make it very hard, if not impossible, for users to manage the traffic of other widely-used layer-7 protocols in microservices. For example, in a microservices application, we may have the below protocols:

• RPC: HTTP, gRPC, Thrift, Dubbo, Proprietary RPC Protocol …
• Messaging: Kafka, RabbitMQ …
• Cache: Redis, Memcached …
• Database: MySQL, PostgreSQL, MongoDB …

If you have already invested a lot of effort in migrating to a service mesh, of course, you want to get the most out of it — managing the traffic of all the protocols in your microservices.

Aeraki's approach

To address these problems, Aeraki Mesh provides a non-intrusive, extendable way to manage any layer-7 traffic in a service mesh.

As this diagram shows, Aeraki Mesh consists of the following components:

• Aeraki: Aeraki provides high-level, user-friendly traffic management rules to operations, translates the rules to envoy filter configurations, and leverages Istio’s EnvoyFilter API to push the configurations to the sidecar proxies. Aeraki also serves as the RDS server for MetaProtocol proxies in the data plane. Contrary to Envoy RDS, which focuses on HTTP, Aeraki RDS is aimed to provide a general dynamic route capability for all layer-7 protocols.
• MetaProtocol Proxy: MetaProtocol Proxy provides common capabilities for Layer-7 protocols, such as load balancing, circuit breaker, routing, rate limiting, fault injection, and auth. Layer-7 protocols can be built on top of MetaProtocol. To add a new protocol into the service mesh, the only thing you need to do is to implement the codec interface and a couple of lines of configuration. If you have special requirements which can’t be accommodated by the built-in capabilities, MetaProtocol Proxy also has an application-level filter chain mechanism, allowing users to write their own layer-7 filters to add custom logic into MetaProtocol Proxy.

Dubbo , Thrift , bRPC and a number of other protocols have been implemented based on MetaProtocol. More protocols are on the way. If you're using a close-source, proprietary protocol, you can also manage it in your service mesh simply by writing a MetaProtocol codec for it.

Most request/response style, stateless protocols can be built on top of the MetaProtocol Proxy. However, some protocols' routing policies are too "special" to be normalized in MetaProtocol. For example, the Redis proxy uses a slot number to map a client query to a specific Redis server node, and the slot number is computed by the key in the request. Aeraki can still manage those protocols as long as there's an available Envoy Filter in the Envoy proxy side. Currently, for protocols in this category, Redis and Kafka are supported in Aeraki.

Supported protocols:

Aeraki can manage the below protocols in a service mesh：

• Dubbo (Envoy native filter）
• Thrift (Envoy native filter)
• Kafka (Envoy native filter)
• Redis (Envoy native filter)
• MetaProtocol-Dubbo
• MetaProtocol-Thrift
• MetaProtocol-bRPC (A RPC protocol open-source by Baidu)
• MetaProtocol-tRPC (A proprietary RPC protocol used in Tencent）
• MetaProtocol-qza (A proprietary protocol used in Tencent Music)
• MetaProtocol-videoPacket (A proprietary protocol used in Tencent Media Data Platform)
• MetaProtocol-Others: Alauda, Tencent iGame...
• MetaProtocol-Private protocols: Have a private protocol? No problem, any layer-7 protocols built on top of the MetaProtocol can be managed by Aeraki

Supported Features:

• Traffic Management
  • Request Level Load Balancing/Locality Load Balancing (Supports Consistent Hash/Sticky Session)
  • Circuit breaking
  • Flexible Route Match Conditions (any properties can be exacted from layer-7 packets and used as match conditions)
  • Dynamic route update through Aeraki MetaRDS
  • Version Based Routing
  • Traffic Splitting
  • Local Rate Limit
  • Global Rate Limit
  • Message mutation
  • Traffic Mirroring
• Observability
  • Request level Metrics (Request latency, count, error, etc)
  • Distributed Tracing
  • Access log
• Security
  • Peer Authorization on Interface/Method
  • Request Authorization

Note: Protocols built on top of MetaProtocol support all the above features in Aeraki Mesh, Envoy native filters only support some of the above features, depending on the capacities of the native filters.

Demo

https://www.aeraki.net/docs/v1.x/quickstart/

Install

https://www.aeraki.net/docs/v1.x/install/

Build

Pre-requirements:

• Golang Version >= 1.16, and related golang tools installed like goimports, gofmt, etc.
• Docker and Docker-Compose installed

Build Aeraki Binary

# build aeraki binary on Linux
make build

# build aeraki binary on darwin
make build IMAGE_OS=darwin

Build Aeraki Image

# build aeraki docker image with the default latest tag
make docker-build

# build aeraki docker image with xxx tag
make docker-build IMAGE_TAG=xxx

# build aeraki e2e docker image
make docker-build-e2e

Contribute to Aeraki

If you're interested in contributing to this project, please read Contributing to Aeraki.

Talks

• IstioCon 2022: Tencent Music’s service mesh practice with Istio and Aeraki
• Istio meetup China(中文): 全栈服务网格 - Aeraki 助你在 Istio 服务网格中管理任何七层流量
• IstioCon 2021: How to Manage Any Layer-7 Traffic in an Istio Service Mesh?

Who is using Aeraki?

Sincerely thank everyone for choosing, contributing, and using Aeraki. We created this issue to collect the use cases so we can drive the Aeraki community to evolve in the right direction and better serve your real-world scenarios. We encourage you to submit a comment on this issue to include your use case：https://github.com/aeraki-mesh/aeraki/issues/105

Contact

• WeChat Group: Please contact Wechat ID: zhao_huabing to join the Aeraki Wechat group
• Slack Channel: Join our slack channel
• Community meetings: Meetings and recordings

License

This project is licensed under Apache 2.0 License

Conduct

We follow the CNCF Code of Conduct

Landscapes

  

Aeraki Mesh is a CNCF sandbox project.