Google Git
Sign in
apache / dubbo-go-pixiu / refs/heads/master
commit2651a778787d189d27ea552026cf8eaa5183239f[log] [tgz]
authorzhangxun <18721825717@163.com>Sat Mar 06 20:59:19 2021 +0800
committerGitHub <noreply@github.com>Sat Mar 06 20:59:19 2021 +0800
tree30958aee0cf1bbab68aa5bbf6f94bfca1fc07d2f
parent75f738dd84ccd5cdcc86dec523b49379aa137df1 [diff]
parentae40d8d35e35cf7adc06faa9229434cd6bd6f853 [diff]
Merge pull request #132 from xiaoliu10/rename_pic

Rename pic

Former-commit-id: 7ce707c340e05c545e87da33afeff17022c31ccc [formerly c71fe2aabfa5440566302a21e0f6645c2a257fec [formerly 63cd4ddba8e461595c7db9954ba5abd7fd0c7de3]]
Former-commit-id: c71fe2aabfa5440566302a21e0f6645c2a257fec
Former-commit-id: 4548f01c3d02cb91dc29dbccc1d9a8d070de71bb [formerly b9ab31a20cbff766d1a89adb058716f8a134ef62]
Former-commit-id: f0d04813daa57951cce8a6936ce6e3cae8bafb54
tree: 30958aee0cf1bbab68aa5bbf6f94bfca1fc07d2f
  1. .github/
  2. cmd/
  3. configs/
  4. docs/
  5. pkg/
  6. samples/
  7. .gitignore
  8. .travis.yml
  9. before_ut.sh
  10. before_validate_license.sh
  11. CHANGE.md
  12. go.mod
  13. go.sum
  14. LICENSE
  15. Makefile
  16. README.md
  17. README_CN.md
  18. start.sh
README.md

Build Status

中文

Introduction

dubbo-go-pixiu is a gateway that mainly focuses on providing gateway solution to your Dubbo and RESTful services.

It supports HTTP-to-Dubbo and HTTP-to-HTTP proxy and more protocols will be supported in the near future.

Get Start

Start Pixiu

  1. Build the binary with make build
  2. Start the pixiu with make start

Quick Guide

dubbo-go-pixiu supports to invoke 2 protocols:

  1. Http
  2. Dubbo

Features

  1. You can customize your own dubbo-go-pixiu with plugin.
  2. Multiple default filters to manage your APIs.
  3. Dubbo and HTTP proxies.
  4. Customizable request parameters mapping.
  5. Automatically recognizes RPC services from service registration center and exposes it in HTTP protocol.
  6. Sidecar or centralized deployment（Planning）
  7. Dubbo protocol's rate-limiting in Istio environment（Planning）

Architecture Diagram

image

Flow Diagram

image

Teams

Components

Pixiu

Data panel

Admin

Control Panel

Concepts

Downstream

Downstream is the requester who sends request to and expecting the response from dubbo-go-pixiu. (Eg.Postman client, Browser)

Upstream

The service that receive requests and send responses to dubbo-go-pixiu. (Eg. Dubbo server)

Listener

The way that the dubbo-go-pixiu exposes services to upstream clients. It could be configured to multiple listeners for one dubbo-go-pixiu.

Cluster

Cluster is a set of upstream services that logically similar, such as dubbo cluster. pixiu can identifies the cluster members through service discovery and proactively probes their healthiness so that the pixiu can route the requests to proper cluster member base on load balancing strategies.

Api

API is the core concept of the dubbo-go-pixiu, all the upstream services will be configured and exposed through API.

Client

The actual caller of the upstream services.

Router

Router routes the HTTP request to proper upstream services according to the API configs.

Context

The context of a request in dubbo-go-pixiu includes almost all information to get response from upstream services. It will be used in almost all process in the dubbo-go-pixiu, especially the filter chain.

Filter

Filter manipulate the incoming requests. It is extensible for the users.

Contact Us

The project is under intensively iteration, you are more than welcome to use, suggest and contribute codes. DingDing Group: 31363295

License

Apache License, Version 2.0