README
¶
JUPITER: Governance-oriented Microservice Framework
Introduction
JUPITER is a governance-oriented microservice framework, which is being used for years at Douyu.
Online Demo
Username: admin
Password: admin
Documentation
See the 中文文档 for the Chinese documentation.
Requirements
- Go version >= 1.19
- Docker
Quick Start
- Install jupiter toolkit
- Create example project from jupiter-layout
- Download go mod dependencies
- Run the example project with jupiter toolkit
- Just code yourself :-)
go install github.com/douyu/jupiter/cmd/jupiter@latest
jupiter new example-go
cd example-go
go mod tidy
docker-compose -f test/docker-compose.yml up -d
jupiter run -c cmd/exampleserver/.jupiter.toml
Learn More:
- Juno: Microservice Governance System for jupiter
- Jupiter Layout: Project Template for jupiter
- Examples
Bugs and Feedback
For bug report, questions and discussions please submit an issue.
Contributing
Contributions are always welcomed! Please see CONTRIBUTING for detailed guidelines.
You can start with the issues labeled with good first issue.
Contact
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( //StageAfterStop after app stop StageAfterStop uint32 = uint32(hooks.Stage_AfterStop) //StageBeforeStop before app stop StageBeforeStop = uint32(hooks.Stage_BeforeStop) )
View Source
var DefaultApp = application.DefaultApp
View Source
var New = application.New
View Source
var WithConfigParser = application.WithConfigParser
View Source
var WithDisable = application.WithDisable
Functions ¶
This section is empty.
Types ¶
type Application ¶
type Application = application.Application
Application is the framework's instance, it contains the servers, workers, client and configuration settings. Create an instance of Application, by using &Application{}
type Disable ¶ added in v0.2.4
type Disable = application.Disable
const ( DisableParserFlag Disable = application.DisableParserFlag DisableLoadConfig Disable = application.DisableLoadConfig DisableDefaultGovernor Disable = application.DisableDefaultGovernor )
type Option ¶ added in v0.2.4
type Option = application.Option
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
jupiter
command
|
|
|
protoc-gen-go-echo
command
|
|
|
protoc-gen-go-gin
command
|
|
|
protoc-gen-go-xerror
command
|
|
|
protoc-gen-go-xfieldmask
command
|
|
|
example
module
|
|
|
util/xbuffer
Package buffer provides an implementation of an unbounded buffer.
|
Package buffer provides an implementation of an unbounded buffer. |
|
util/xgeneric
module
|
|
|
proto
|
|
|
helloworld/v1
Package helloworldv1 is a reverse proxy.
|
Package helloworldv1 is a reverse proxy. |
|
test
|
|
|
e2e
module
|
|
|
tools
|
|
|
jupiter
module
|
Click to show internal directories.
Click to hide internal directories.