Skip to content

Latest commit

 

History

History

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Easegress Documentation

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.

2. Development Guide

3. Performance

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 TrafficGates(HTTPServer and etc.) and Pipeline 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.

4.2 Filters

  • Proxy - The Proxy filter is a proxy of backend service.
  • 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.
  • 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.
  • RequestBuilder - The RequestBuilder build a new request from existing requests/responses.
  • ResponseBuilder - The ResponseBuilder build a new response from existing requests/responses.
  • RequestAdaptor - The RequestAdaptor modifies the original request according to configuration.
  • 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.

4.3 Custom Data