mirrors/sablier
1
0
Fork 0
mirror of https://github.com/sablierapp/sablier.git synced 2026-01-03 03:27:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation

Browse Source
This commit is contained in:
Alexis Couvreur
2020-10-21 22:15:42 +02:00
parent cc269ebb47
commit eb0ca0b44f
1 changed files with 27 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -1,23 +1,26 @@
# Traefik Ondemand Plugin
Traefik plugin to scale down to zero containers on swarm.
Traefik plugin to scale down to zero containers on docker swarm.
## Description
A container may be a simple nginx server serving static pages, when no one is using it, it still consome CPU and memory even if it's close to nothing it still something.
A container may be a simple nginx server serving static pages, when no one is using it, it still consume CPU and memory.
With this plugin you can scale down to zero when there is no more request.
With this plugin you can scale down to zero when there is no request for the service.
It will scale back to 1 when there is a user requesting the service.
## Authors
## Configuration
[Alexandre Hiltcher](https://www.linkedin.com/in/alexandre-hiltcher/)
[Alexis Couvreur](https://www.linkedin.com/in/alexis-couvreur/)
- `serviceUrl` the traefik-ondemand-service url
- `dockerServiceName` the service to sclae on demand name (docker service ls)
- `timeoutSeconds` timeout in seconds for the service to be scaled down to zero after the last request
![Alexandre and Alexis](./img/gophers-traefik.png)
See `config.yml` and docker-compose.yml for full configuration.
## Demo
The service whoami is scaled to 0. We configured a timeout of 10 seconds.
![Demo](./img/demo.gif)
## Run the demo
@@ -28,6 +31,22 @@ It will scale back to 1 when there is a user requesting the service.
## Limitations
### Cannot use service labels
You cannot set the labels for a service inside the service definition.
Otherwise when scaling to 0 the specification would not be found because there is no more task running. So you have to write it under the dynamic configuration file.
Otherwise when scaling to 0 the specification would not be found because there is no more task running. So you have to write it under the dynamic configuration file.
### The need of "traefik-ondemand-service"
This is a small project developped to interact freely with the docker deamon and manage an independant lifecycle.
*We may try to update this plugin to embed the scaling behavior in a future.*
-> The source is available at https://github.com/acouvreur/traefik-ondemand-service
## Authors
[Alexis Couvreur](https://www.linkedin.com/in/alexis-couvreur/) (left) and [Alexandre Hiltcher](https://www.linkedin.com/in/alexandre-hiltcher/) (right)
![Alexandre and Alexis](./img/gophers-traefik.png)