Fixed #15 document autodetect

This commit is contained in:
Gianluca Arbezzano 2017-03-19 21:51:22 +00:00
parent 6e021fc164
commit fddce9e1b2

View File

@ -11,7 +11,8 @@ We designed in collaboration with InfluxData to show how metrics can be used.
It is based on plugins called `provider`. At the moment we implemented:
* Docker Swarm mode
* Docker Swarm mode [(go to zero-conf
chapter](https://github.com/gianarb/orbiter#autodetect)
* DigitalOcean
```sh
@ -79,6 +80,34 @@ curl -v -d '{"direction": true}' \
http://localhost:8000/handle/infra_scale/docker
```
## Autodetect
The autodetect mode starts when you don't specify any configuration file.
If you start oribter with the command:
```
orbiter daemon -daemon
```
It's going to start in autodetect mode. This modality at the moment only fetch
for Docker SwarmMode. It use the environment variables DOCKER_HOST and so on to
locate a Docker daemon. If it's in SwarmMode orbiter is going to look at all the
services currently running.
If a service is labeled with `orbiter=true` it's going to auto-register the
service and it's going to enable autoscaling.
Let's say that you started a service:
```
docker service create --label orbiter=true --name web -p 80:80 nginx
```
When you start orbiter, it's going to auto-register an autoscaler called
`autodetect_swarm/web`. By default up and down are set to 1 but you can override
them with the label `orbiter.up=3` and `orbiter.down=2`.
This calability allow you to istantiate orbiter in an extremely easy way in
Docker Swarm.
## Embeddable
This project is trying to provide also an easy API to maintain a lot complexy
and clean code base in order to allow you to use `orbiter` as project for your