User Documentation on Apache Dubbo

Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

Let’s quickly demonstrate Pixiu’s capabilities by converting an HTTP request to a Dubbo2 request.

Use Case

Pixiu converts the Client’s HTTP request into a Dubbo2 request, which is then forwarded to the Dubbo Server. It then converts the Dubbo Server’s response back into an HTTP response, finally returning it to the Client.

Architecture Diagram

Example

The example path can be found at /samples/http/simple/http-http.

Dubbo Server Implementation and Startup

The Dubbo Server provides interfaces for adding, deleting, modifying, and querying users. The specific code implementations can be found in the server directory under the example path.

Start the dubbo-go-pixiu

Mon, 01 Jan 0001 00:00:00 +0000

Start

How to start the dubbo-go-pixiu

1 cd samples dir

cd samples/dubbo/simple

we can use start.sh to run samples quickly. for more info, execute command as below for more help

./start.sh [action] [project]
./start.sh help

we run body samples below step

2 prepare config file and docker

prepare command will prepare dubbo-server and pixiu config file and start docker container needed

./start.sh prepare body

if prepare config file manually, notice:

API Model Introduction

Mon, 01 Jan 0001 00:00:00 +0000

Api

Introduction to API model, recommended reading before customizing API for api_config.yaml.

Api Gateway

API is the key feature of the dubbo-go-pixiu. With this feature, you can expose your dubbo service as an HTTP service.

Configuration

Sample:

name: api name
description: api description
resources:
 - path: '/'
 type: restful
 description: resource documentation
 methods:
 - httpVerb: GET
 enable: true
 inboundRequest:
 requestType: http
 queryStrings:
 - name: id
 required: false
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: queryStrings.id
 mapTo: 1
 applicationName: "BDTService"
 interface: "com.ikurento.user.UserProvider"
 method: "GetUser"
 clusterName: "test_dubbo"

definitions:
 - name: modelDefinition
 schema: >-
 {
 "type" : "object",
 "properties" : {
 "id" : {
 "type" : "integer"
 },
 "type" : {
 "type" : "string"
 },
 "price" : {
 "type" : "number"
 }
 }
 }

name :

Config File

Mon, 01 Jan 0001 00:00:00 +0000

Config

Pixiu supports specifying local config file with argument -c which you can find in those samples pixiu dir.

Pixiu uses the config abstraction like envoy such as listener, filter, route and cluster.

Besides, pixiu provides another dubbo-specific config named api_config, by which dubbo-filter can transform the http request to dubbo generic call. You can also find it in those samples’s pixiu directory.

The document Api Model provides the api_config specification about the pixiu config abstraction.

Start and configuration

Mon, 01 Jan 0001 00:00:00 +0000

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.

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.

Deployment operations

Mon, 01 Jan 0001 00:00:00 +0000

1. Docker Image Deployment

Note: First confirm that Docker is installed and running on your machine.

1. Pull the Pixiu image from Docker Hub

docker pull phial3/dubbo-go-pixiu:latest

2. Prepare Pixiu Configuration as Needed

Detailed Explanation of Pixiu Configuration Parameters

Prepare the log.yml and conf.yaml configuration files, and mount these two configuration files to the local directory when starting Pixiu.

3. Start Pixiu

Foreground Start: Convenient to check if the service information is running normally.