README.md

Easegress Documentation

• Easegress Documentation
  • 1. Cookbook / How-To Guide
  • 2. Development Guide
  • 3. Performance
  • 4. Reference Guide
    • 4.1 Controllers
      • 4.1.1 System Controllers
      • 4.1.2 Business Controllers
    • 4.2 Filters

1. Cookbook / How-To Guide

This is a cookbook that lists a number of useful and practical examples on how to use Easegress for different scenarios.

• API Aggregator - Aggregating many APIs into a single API.
• Cluster Deployment - How to deploy multiple Easegress cluster nodes.
• Distributed Tracing - How to do APM tracing - Zipkin.
• FaaS - Supporting Knative FaaS integration
• Flash Sale - How to do high concurrent promotion sales with Easegress
• Kubernetes Ingress Controller - How to integrated with Kubernetes as ingress controller, and K8s Ingress Controller for full manual.
• LoadBalancer - A number of strategy of load balancing
• MQTTProxy - An Example to MQTT proxy with Kafka backend.
• Performance - Performance optimization - compression, caching etc.
• Pipeline - How to orchestrate HTTP filters for requests/responses handling
• Resilience and Fault Tolerance - Circuit Breaker, Rate Limiter, Retryer, Time limiter, etc. (Porting from Java resilience4j)
• Security - How to do authentication by Header, JWT, HMAC, OAuth2, etc.
• Service Proxy - Supporting the Microservice registries - Zookeeper, Eureka, Consul, Nacos, etc.
• WebAssembly - Using AssemblyScript to extend the Easegress
• WebSocket - WebSocket proxy for Easegress
• Workflow - An Example to make a workflow for a number of APIs.

2. Development Guide

• Easegress Roadmap - The development roadmap of Easegress.
• Developer Guide - A guide help to develop the Easegress.
• Source Code Introduction - A slide introduces source code (Dec. 2021 - Easegress v1.4.0)

3. Performance

• Benchmark - Performance Test Report.
• Linux Kernel Tuning - Tuning the Linux Kernel to make the Easegress run faster.

4. Reference Guide

4.1 Controllers

The Easegress controller is the core entity to control kinds of working. There are two kinds of controllers - system and business.

For the full document, please check - Controller Reference

4.1.1 System Controllers

The following controllers are system level controllers. One and only one instance of them are created in every Easegress node and they can't be deleted.

• ServiceRegistry - The service hub for all service registries - Consul, Etcd, Eureka, Zookeeper, Nacos...
• TrafficController - TrafficController handles the lifecycle of HTTPServer and HTTPPipeline and their relationship.
• RawConfigTrafficController - RawConfigTrafficController maps all traffic static configurations to TrafficController in the namespace default.

4.1.2 Business Controllers

It could be created, updated, deleted by admin operation. They control various resources such as mesh traffic, service discovery, faas, and so on.

• EaseMonitorMetrics - Monitor metrics of Easegress and send them to Kafka.
• FaaSController - For Easegress and FaaS products integration purpose.
• IngressController - an implementation of Kubernetes ingress controller, it watches Kubernetes Ingress, Service, Endpoints, and Secrets then translates them to Easegress HTTP server and pipelines. The K8s Ingress Controller for full manual.
• MeshController - This is for EaseMesh project.
• ConsulServiceRegistry - supports service discovery for Consul as backend.
• EtcdServiceRegistry - support service discovery for Etcd as backend.
• EurekaServiceRegistry - supports service discovery for Eureka as backend.
• ZookeeperServiceRegistry - supports service discovery for Zookeeper as backend.
• NacosServiceRegistry - supports service discovery for Nacos as backend.
• AutoCertManager - automatically manage HTTPS certificates.

4.2 Filters

• API Aggregator - The API Aggregator forwards one request to multiple API HTTP Pipelines in the same namespace and aggregates responses.
• Proxy - The Proxy filter is a proxy of backend service.
• Bridge - The Bridge filter route requests from one pipeline to other pipelines or HTTP proxies under an HTTP server.
• CORSAdaptor - The CORSAdaptor handles the CORS preflight request for backend service.
• Fallback - The Fallback filter mocks a response as fallback action of other filters.
• Mock - The Mock filter mocks responses according to configured rules, mainly for testing purposes.
• RemoteFilter - The RemoteFilter is a filter making remote service acting as an internal filter.
• RequestAdaptor - The RequestAdaptor modifies the original request according to configuration.
• CircuitBreaker - The CircuitBreaker is a finite state machine with three states: CLOSED, OPEN, and HALF_OPEN.
• RateLimiter - The RateLimiter protects backend service for high availability and reliability by limiting the number of requests sent to the service in a configured duration.
• TimeLimiter - The TimeLimiter limits the time of requests, a request is canceled if it cannot get a response in configured duration.
• Retryer - The Retryer retries failed requests according to configured policy.
• ResponseAdaptor - The ResponseAdaptor modifies the original response according to the configuration before passing it back.
• Validator - The Validator filter validates requests, forwards valid ones, and rejects invalid ones.
• WasmHost - The WasmHost filter implements a host environment for user-developed WebAssembly code.