Start and configuration

Start and configuration

Pixiu Startup Command

Pixiu has two forms: Gateway and Sidecar. The command for the Pixiu executable is as follows, where pixiu is the name of the executable file. Note that the path after -c is the absolute path of the local configuration file.

  1. pixiu gateway start -c /config/conf.yaml

Configuration Detailed Explanation

Pixiu accepts YAML formatted files as its main configuration file for configuring various components of Pixiu. Taking the configuration file from Quick Start as an example, we will explain its components in detail and list possible extensions.

  1. static_resources:
  2.   listeners:
  3.     - name: "net/http"
  4.       protocol_type: "HTTP"
  5.       address:
  6.         socket_address:
  7.           address: "0.0.0.0"
  8.           port: 8883
  9.       filter_chains:
  10.           filters:
  11.             - name: dgp.filter.httpconnectionmanager
  12.               config:
  13.                 route_config:
  14.                   routes:
  15.                     - match:
  16.                         prefix: "*"
  17.                 http_filters:
  18.                   - name: dgp.filter.http.dubboproxy
  19.                     config:
  20.                       dubboProxyConfig:
  21.                         auto_resolve: true
  22.                         registries:
  23.                           "zookeeper":
  24.                             protocol: "zookeeper"
  25.                             timeout: "3s"
  26.                             address: "127.0.0.1:2181"
  27.                             username: ""
  28.                             password: ""

First, similar to the envoy configuration, static_resources indicates that all the following configurations are static. This includes components such as Listener, NetworkFilter, Route, and HttpFilter, which are not completely independent of each other.

Listener

For example, the above configuration declares an HTTP type Listener listening on port 8883. More Listener configurations can be found in Listener.

  1.   listeners:
  2.     - name: "net/http"
  3.       protocol_type: "HTTP"
  4.       address:
  5.         socket_address:
  6.           address: "0.0.0.0"
  7.           port: 8883
  8.       filter_chains:

The configuration of listeners has protocol_type, indicating that it is an HTTP type Listener, and address, which configures the listening address and port, while filter_chains specifies which NetworkFilters should handle requests received by this Listener.

NetworkFilter

NetworkFilter is one of Pixiu’s key components, composed of Route and HttpFilter, responsible for receiving requests passed from Listener and processing them.

  1. filters:
  2.             - name: dgp.filter.httpconnectionmanager
  3.               config:
  4.                 route_config:
  5.                 http_filters:

The above configuration specifies using the dgp.filter.httpconnectionmanager NetworkFilter, which can process HTTP Request and Response and configure route information and use HttpFilters for chained processing of requests. More NetworkFilters can be found in the NetworkFilter documentation.

Route and Cluster

Route can be used for routing requests, as exemplified by the following configuration. For detailed configuration files, please see the configuration files in /samples/http/simple.

  1.             - name: dgp.filter.httpconnectionmanager
  2.               config:
  3.                 route_config:
  4.                   routes:
  5.                     - match:
  6.                         prefix: "/user"
  7.                       route:
  8.                         cluster: "user"

The above configuration specifies that for HTTP requests with a path prefix of /user, they will be forwarded to a cluster service group named user.

The specific definition of the cluster is shown below:

  1.   clusters:
  2.     - name: "user"
  3.       lb_policy: "RoundRobin"
  4.       endpoints:
  5.         - id: 1
  6.           socket_address:
  7.             address: 127.0.0.1
  8.             port: 1314

The above configuration defines a cluster named user with a load balancing policy of RoundRobin, which includes one endpoint instance with the address 127.0.0.1.

Currently, forwarding HTTP or gRPC requests requires using Route and Cluster. However, there is no need for both in scenarios involving forwarding Dubbo-related requests.

HttpFilter

When a NetworkFilter receives a request from a Listener, it needs to perform a series of operations, such as rate limiting and authorization, and finally forward the request to specific upstream services. These tasks are handled by the HttpFilter chain associated with the NetworkFilter.

  1.             - name: dgp.filter.httpconnectionmanager
  2.               config:
  3.                 http_filters:
  4.                   - name: dgp.filter.http.dubboproxy
  5.                     config:
  6.                       dubboProxyConfig:
  7.                         auto_resolve: true
  8.                         registries:
  9.                           "zookeeper":
  10.                             protocol: "zookeeper"
  11.                             timeout: "3s"
  12.                             address: "127.0.0.1:2181"
  13.                             username: ""
  14.                             password: ""

As shown in the configuration above, the httpconnectionmanager NetworkFilter has an HttpFilter chain, which includes the dgp.filter.http.dubboproxy HttpFilter. It is responsible for converting HTTP requests into Dubbo requests and forwarding them. It requires configuration of the address of a Dubbo cluster registration center, specified as middleware in Zookeeper. The auto_resolve specifies using the default HTTP to Dubbo conversion protocol for related data conversions, which can be referenced in Default Conversion Protocol.

More HttpFilters can be found in the HttpFilter documentation.

Adapter

Adapter represents the capability of Pixiu to interact with external metadata centers. Currently, there are two: dgp.adapter.dubboregistrycenter and dgp.adapter.springcloud, representing retrieval of service instance information from Dubbo cluster registration centers and Spring Cloud cluster registration centers respectively to build Pixiu forwarding HTTP request routing rules.

More Adapters can be found in the Adapter documentation。

Feedback

Was this page helpful?

Yes No

Last modified September 30, 2024: Update & Translate Overview Docs (#3040) (d37ebceaea7)