README
¶
go-microservice
A tool and kit to help the go developer to stick to pace standards and fasten certain processes.
Install
go get -u lab.jamit.de/pace/go-microservice/cmd/pace
Usage
pace -h
Environment variables
PACE_EDITOR
The path to the editor that should be used for opening a project. Defaults to $EDITOR.
PACE_PATH
The path where new project should be created. Defaults to $HOME/PACE.
Requirements
- A working go installation
- A working git installation
- Installed SSH keys for git
Testing
Use make testserver to test logging and tracing with postgres, redis and external http service.
Use make docker.all to create/start all docker containers.
http/jsonapi
In http/jsonapi/generator/internal multiple test APIs can be found. The
generated code in these directories can be updated with make jsonapi.
Jaeger
Access web UI: http://localhost:16686/search
Directories
¶
| Path | Synopsis |
|---|---|
|
backend
|
|
|
postgres
Package postgres helps creating PostgreSQL connection pools
|
Package postgres helps creating PostgreSQL connection pools |
|
redis
Package redis helps creating redis connection pools
|
Package redis helps creating redis connection pools |
|
client
|
|
|
nominatim
Package nominatim provides a client for the nominatim geocoder
|
Package nominatim provides a client for the nominatim geocoder |
|
pace/client
Package client contains a generic JSON API client for cockpit, cloud and jarvis
|
Package client contains a generic JSON API client for cockpit, cloud and jarvis |
|
pace/cloudwebv2
Package cloudwebv2 implements the APIs described here http://docs.pacelink.net/cloud/api-web-v2.html
|
Package cloudwebv2 implements the APIs described here http://docs.pacelink.net/cloud/api-web-v2.html |
|
pace/jarvisv1
Package jarvisv1 implements the APIs described here http://docs.pacelink.net/jarvis/api-v1.html
|
Package jarvisv1 implements the APIs described here http://docs.pacelink.net/jarvis/api-v1.html |
|
cmd
|
|
|
Package http implements the basic pace microservice handlers and a standard microservice server configured via environment variables.
|
Package http implements the basic pace microservice handlers and a standard microservice server configured via environment variables. |
|
jsonapi/generator
Package generator translates an OpenAPIv3 specification into working go code that handles marshalling, error handling, parameter parsing and validation.
|
Package generator translates an OpenAPIv3 specification into working go code that handles marshalling, error handling, parameter parsing and validation. |
|
jsonapi/runtime
Package runtime contains functions for marshalling, error handling, parameter parsing and validation.
|
Package runtime contains functions for marshalling, error handling, parameter parsing and validation. |
|
oauth2
Package oauth2 provides a middelware that introspects the auth token on behalf of PACE services and populate the request context with useful information when the token is valid, otherwise aborts the request.
|
Package oauth2 provides a middelware that introspects the auth token on behalf of PACE services and populate the request context with useful information when the token is valid, otherwise aborts the request. |
|
internal
|
|
|
maintenance
|
|
|
health
Package health implements a simple but performant handler that will be invoked by the loadbalancer frequently
|
Package health implements a simple but performant handler that will be invoked by the loadbalancer frequently |
|
metrics
Package metrics returns the prometheus metrics handler
|
Package metrics returns the prometheus metrics handler |
|
metrics/jsonapi
Package jsonapi implements the json api related metrics documented here: https://lab.jamit.de/pace/web/meta/wikis/concept/metrics#m2-microservice-any-pace-microservice
|
Package jsonapi implements the json api related metrics documented here: https://lab.jamit.de/pace/web/meta/wikis/concept/metrics#m2-microservice-any-pace-microservice |
|
pkg
|
|
|
synctx
Package synctx implements helpers for the context package on top of the sync package.
|
Package synctx implements helpers for the context package on top of the sync package. |
|
testing
|
|
|
livetest
Package livetest implements a set of helpers that ease writing of a sidecar that tests the functions of a service.
|
Package livetest implements a set of helpers that ease writing of a sidecar that tests the functions of a service. |
|
tools
|
|
Click to show internal directories.
Click to hide internal directories.