Merge pull request #119 from xiaoliu10/add_chanage_list

add change list

Former-commit-id: e39f075530b98dc67efa01c2fafbbe38bf14b50c [formerly 26b1eeea9e17d74628e3dba548a4d495a780955c [formerly 7638bd7329a3bfc95297b3e0098023f13d44a8f5]]
Former-commit-id: c97f363e152800cb58d0f28f125dd00ef61eab2b [formerly 26b1eeea9e17d74628e3dba548a4d495a780955c]
Former-commit-id: 2de813615d7a74ef79bde33941bd750d81088ae8 [formerly ee1f78ba1baa1c55b988e0dfc4c795125067d425]
Former-commit-id: 96459cdddf002ef996c36b83fb9fa4b100497714
tree: 33444476448f7fe2b749029d10828172be5dbc3c
  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-proxy 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 proxy

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

Quick Guide

dubbo-go-proxy supports to invoke 2 protocols:

  1. Http
  2. Dubbo

Features

  1. You can customize your own dubbo-go-proxy 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

Proxy

Data panel

Admin

Control Panel

Concepts

Downstream

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

Upstream

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

Listener

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

Cluster

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

Api

API is the core concept of the dubbo-go-proxy, 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-proxy includes almost all information to get response from upstream services. It will be used in almost all process in the dubbo-go-proxy, 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