README
¶
Trinquet
- Master :
- Develop :
trinquet uses gRPC for its messaging protocol. The trinquet project includes a gRPC-based Go client and a command line utility, trinquetctl, for communicating with the trinquetd server.
For languages with no gRPC support, trinquet provides a JSON grpc-gateway. This gateway serves a RESTful proxy that translates HTTP/JSON requests into gRPC messages.
It exports metrics for Prometheus
Distributed tracing is available using OpenTracing. Supported tracers are:
Installation
You can download the binaries :
Trinquetd
- Architecture i386 [ linux / darwin / freebsd / netbsd / openbsd / windows ]
- Architecture amd64 [ linux / darwin / freebsd / netbsd / openbsd / windows ]
- Architecture arm [ linux / freebsd / netbsd ]
Trinquetctl
- Architecture i386 [ linux / darwin / freebsd / netbsd / openbsd / windows ]
- Architecture amd64 [ linux / darwin / freebsd / netbsd / openbsd / windows ]
- Architecture arm [ linux / freebsd / netbsd ]
Trinquetadm
- Architecture i386 [ linux / darwin / freebsd / netbsd / openbsd / windows ]
- Architecture amd64 [ linux / darwin / freebsd / netbsd / openbsd / windows ]
- Architecture arm [ linux / freebsd / netbsd ]
Usage
Launch Zipkin with Docker, and open a browser on 9411:
$ docker run -d -p 9411:9411 openzipkin/zipkin
or Jaeger with Docker (open a browser on 16686):
$ docker run -d -p5775:5775/udp -p16686:16686 jaegertracing/all-in-one:latest
Use the trinquetd CLI to launch a server:
$ trinquetd run -config trinquet.toml -v 2 -logtostderr
Use the trinquetctl CLI to manage pelota informations.
Use the trinquetadm CLI to manage the server.
You could explore the API using Swagger UI :
http://localhost:9090/swagger-ui/
Development
-
Initialize environment
$ make init -
Build tool :
$ make build -
Launch unit tests :
$ make test
Contributing
See CONTRIBUTING.
License
See LICENSE for the complete license.
Changelog
A changelog is available
Contact
Nicolas Lamirault nicolas.lamirault@gmail.com
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api contains the REST and gRPC API.
|
Package api contains the REST and gRPC API. |
|
Package auth provides authentication method
|
Package auth provides authentication method |
|
cmd
|
|
|
Package config contains the configuration used by the Trinquet server
|
Package config contains the configuration used by the Trinquet server |
|
Package pb contains the protocol buffer descriptions
|
Package pb contains the protocol buffer descriptions |
|
health
Package health is a generated protocol buffer package.
|
Package health is a generated protocol buffer package. |
|
info
Package info is a generated protocol buffer package.
|
Package info is a generated protocol buffer package. |
|
v1beta
Package v1beta is a generated protocol buffer package.
|
Package v1beta is a generated protocol buffer package. |
|
pkg
|
|
|
rbac
Package rbac provides a lightweight role-based access control
|
Package rbac provides a lightweight role-based access control |
|
server
|
|
|
Package tracing provides support for request tracing mechanisms.
|
Package tracing provides support for request tracing mechanisms. |
|
zipkin
Package zipkin provides support for opentracing Zipkin framework.
|
Package zipkin provides support for opentracing Zipkin framework. |