mirrors/sablier
1
0
Fork 0
mirror of https://github.com/sablierapp/sablier.git synced 2026-01-02 11:07:25 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
0ecd9d9213bf990bf2fead533dc8819ebda2e8ba
sablier/README.md
Alexis Couvreur 19d3b71722 docs: add CLI, Docker and API usage
2021-09-26 14:32:33 +00:00

1.9 KiB
Raw Blame History

Traefik on demand service

Build Latest version

Description

This is a service that can scale up or down a docker swarm service on demand. It basically starts a service when it's needed and then shut it down when it's no longer needed.

Usage

CLI

./traefik-ondemand-service --swarmMode=true

Argument Value Description
swarmMode true,false (default true) Enable/Disable swarm mode. Used to determine the scaler implementation.

Docker

docker run -v /var/run/docker.sock:/var/run/docker.sock -p 10000:10000 ghcr.io/acouvreur/traefik-ondemand-service:latest --swarmode=true

API

GET <service_url>:10000/?name=<service_name>&timeout=<timeout>
Query param Type Description
name string The docker container name, or the swarm service name
timeout time.Duration The duration after which the container/service will be scaled down to 0
Body Status code Description
started 202 Created The container/service is available
starting 201 Accepted The container/service has been scheduled for starting but is not yet available