Public and private cloud or different technologies like virtual machine or containers. Our applications and our environments require to be resilient doesn't matter where they are or which services are you using.
This project is a work in progress cross platform open source autoscaler.
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 (go to zero-conf
chapter. look full example
under
./contrib/swarm
directory - DigitalOcean
orbiter daemon -config config.yml
Orbiter is a daemon that use a YAML configuration file to starts one or more autoscaler and it exposes an HTTP API to trigger scaling up or down.
autoscalers:
events:
provider: swarm
parameters:
policies:
php:
up: 4
down: 3
infra_scale:
provider: digitalocean
parameters:
token: zerbzrbzrtnxrtnx
region: nyc3
size: 512mb
image: ubuntu-14-04-x64
key_id: 163422
# https://www.digitalocean.com/community/tutorials/an-introduction-to-cloud-config-scripting
userdata: |
#cloud-config
runcmd:
- sudo apt-get update
- wget -qO- https://get.docker.com/ | sh
policies:
frontend:
up: 2
down: 3
This is an example of configuration file. Right now we are creating two
autoscalers one to deal with swarm called events/php
and the second one with
DigitalOcean called infra_scale
.
provider
contains integration with the platform to scale. It can be swarm, DigitalOcean, OpenStack, AWS.- Every autoscaler supports a k\v storage of
parameters
that you can use to configure your provider. - autoscaler` is composed by provider, parameters and policies. You can have one or more.
- autoscaler has only or more policies they contains information about a specific application.
You can have only one autoscaler or more with th same provider. Same for policies, only one or more. Doesn't matter.
Orbiter exposes an HTTP JSON api that you can use to trigger scaling UP (true) or DOWN (false).
The concept is very simple, when your monitoring system knows that it's time to scale it can call the outscaler to persist the right action
curl -v -d '{"direction": true}' \
http://localhost:8000/v1/orbiter/handle/infra_scale/docker
Or if you prefer
curl -v -X POST http://localhost:8000/v1/orbiter/handle/infra_scale/docker/up
You can look at the list of services managed by orbiter:
curl -v -X GET http://localhost:8000/v1/orbiter/autoscaler
Look at the health to know if everything is working:
curl -v -X GET http://localhost:8000/v1/orbiter/halth
The autodetect mode starts when you don't specify any configuration file. If you start oribter with the command:
orbiter 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
autoswarm/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.
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
applications.
OpenStack, Kubernets all of them have a sort of autoscaling feature that you can
use. The idea is to keep this complexy out of your deployment tools. You can
just implement orbiter
.
Another use case is a self-deployed application. Kelsey
Hightower had a talk about this
idea. I am still not sure that can be real in those terms but we are already
moving something in our applications that before was in external system as
monitoring, healthcheck why not the deployment part?
package scalingallthethings
import (
"github.com/gianarb/orbiter/autoscaler"
"github.com/gianarb/orbiter/provider"
)
func CreateAutoScaler() *autoscaler.Autoscaler{
p, _ := provider.NewProvider("swarm", map[string]string{})
a, _ := autoscaler.NewAutoscaler(p, "name-service", 4, 3)
return a
}
docker run -it -v ${PWD}/your.yml:/etc/orbiter.yml -p 8000:8000 gianarb/orbiter daemon
We are supporting an imag gianarb/orbiter
in hub.docker.com. You can run it
with your configuration.
In this example I am using volumes but if you have a Docker Swarm 1.13 up and running you can use secrets.