rgummich/depoy repository overview

⁠Depoy

Depoy is an API-Gateway which natively supports Continous Deployment (CD) of RESTful-Application. It evaluates the state of an upstream application by collecting HTTP-Connection metrics and by scraping the Prometheus-Endpoint of the upstream application - if provided. It integrates into Prometheus and offers a reactive web-application for configuration and monitoring.

⁠Architecture

The API-Gateway is built using Go for all backend tasks and Vue for the web-application.

⁠Building

Using the provided "Dockerfile_multistage"⁠ you are able to build the dockerimage yourself. A prebuild image can be found in the Dockerhub⁠.

By using npm and go it is also possible to build the executable without needing Docker.

cd webapp
npm install
npm run build
cd ..
go get -u github.com/gobuffalo/packr/v2/packr2
CGO_ENABLED=0 packr2 build -a -o depoy .

⁠Deployment

Depoy provides args that can be used to configure the core components. Using "./depoy --help" you are able to view all args and their default values. When starting Depoy these args can be set, e. g. through Dockers entrypoint.

⁠Examples

Examples of configurations in YAML can be found under the folder "examples".

⁠Access

The default ports for the Gateway are 8080/8443. The default ports for the GUI are 8081/8444. The default Prometheus Port is 8090.

⁠Supported Metrics

...