Roo (Beta)

TL;DR This basically lets you run your own load balanced Amazon AWS ECS clusters on your own hardware, with no configuration (no additional setup for clustered kv stores, no janky config files, no defining providers, no dodgy second hand helm charts etc). I setup a cluster, and publish a new domain in around 30 seconds now.

This aims to be a free replacement of Amazon's ECS (Elastic Compute Service), EKS, CertificateManager, Load-Balancer and CloudWatch using your own Docker Swarm. It IS a complete replacement for nginx, traefik, haproxy, and a lot of kubernetes. The idea is to give developers back the power and take it back from ridiculous self-complicating dev-ops tools that get more complicated and less useful (for example Traefik 2 just removed support for clustered Letsencrypt from their open source version to spruik their enterprise version. Nginx and HAProxy do the same). I wasted a lot of time on their software before writing this. I truly hope it benefits others too.

If you are unfamiliar with swarm/kubernetes and are a developer and want a quick intro into how powerful and easy swarm can be, check out my command notes. In a day I was scaling clusters up and down on my own infrastructure with single commands.

The power Roo gives you is to add HTTPS://example1.com and HTTPS://example2.com to your clustered services with zero configuration. Let's encrypt allocates your service's certificates. It works across every machine, docker node, service, in your cluster.

Roo itself is clustered. Every machine it runs on shares the load to your services. It's distributed store shares certificates from Letsencrypt used across all your nodes. Now apple is denying certificates older than a year, I feel as a dev, that lets encrypt is almost mandatory as it creates a lot of admin.

Getting Started (on swarm)

Run this all in the docker swarm manager look here to get started.

Create the default network, for example:

docker network create -d overlay --attachable forenet --subnet 192.168.9.0/24

Add label to the nodes you want to run it on (load_balancer describes the label for roo to attach to):

docker node update --label-add load_balancer=true docker1-prod

You'll need to run roo on at least one manager node if you want docker services to auto-sync with Let's Encrypt. Don't worry though as this is not a security issue like in other platforms (like Traefik) as the manager node need not be publicly accessible.
Run the docker-compose file on swarm (WARNING: LetsEncrypt hates load, so update the ROO_ACME_STAGING=true if you plan to muck about):

# docker stack deploy -c roo-docker-compose.yml roo

It takes a minute to bootstrap
Notice the roo images are available at dockerhub sfproductlabs/roo:latest. I don't use the Github repository service as it requires a key to just get the image.
Then in your own docker-compose file do something like (note the label used in the zeroconfig, and the destination, its usually swarmstack_swarmservicename):

version: "3.7"
services:
  test:
    image: test
    deploy:
      replicas: 1
    networks:
      - forenet
    labels:
      OriginHosts: test.sfpl.io
      DestinationHost: test_test
      DestinationScheme: http
      DestinationPort: 80
    
networks:
  forenet:
    external: true

NOTE: Give it a minute before you query your service, as the service blocks unknown traffic (the docker watcher updates every 30 seconds or so, and it will need a bit to find your new service). JOB DONE!

Zeroconfig of docker swarm services

You need to tell roo what the incoming hostname etc is and where to route it to in the docker-compose file (if you want to go fully automoatic)

Going Manual

Roo comes with a clustered Distributed Key-Value (KV) Store (See the API below for access). You can use this to manually configure roo. To add the route and do the zeroconfig example above manually, do this instead:

You'll need to first deploy the test stack

docker stack deploy -c test-docker-compose.yml test

Then let roo know the route (do this inside any machine in the forenet network):

curl -X PUT roo_roo:6299/roo/v1/kv/com.roo.host:test.sfpl.io:https -d 'http://test_test:80'

Building from source

You need to get the dependencies. Check the roo-docker-compose.yml file for a current list.
Run make in the root directory (not the roo directory).

Schema Definitions

Adding a route to the routing table

Use the Put API below

com.roo.host:<requesting_host<:port (optional)>:scheme>  <destination_url>

See an example

API

Post a single key to the distributed store

curl -X PUT -d'test data' http://localhost:6299/roo/v1/kv/test

Returns a json object { "ok" : true} if succeded

A Real Example Route

Put in a test route. For our example we are serving goole.com at our public endpoint, and routing to a swarm service with an endpoint inside our network on port 9001. The swarm stack is cool, the swarm service name is game. In docker swarm world this equates to a mesh network load balanced DNS record of tasks.cool_game. (you'll need to find your stack, service, and replace that and port 9001 with your details to get it working). The overall result to add this to our routing tables is:

curl -X PUT -d'http://tasks.cool_game:9001' http://localhost:6299/roo/v1/kv/com.roo.host:google.com:https

Note: as we don't specify a port in our requests we remove the optional port :443

To test you can run something like this (this just makes your localhost pretend like its responding to a request to google.com): curl -H "Host: google.com" https://localhost/

So to summarize, google.com:443 is the incoming route to roo from the internet, and tasks.cool_game:9001 is your service and port to your internal service (in this case its an internal intranet docker swarm service).

Get a SINGLE key from the store

curl -X GET http://localhost:6299/roo/v1/kv/test

Returns the raw bytes (you'll see this as a string if you stored it like that)

List multiple keys from the store (Using a SCAN/Prefix filter query)

curl -X GET http://localhost:6299/roo/v1/kvs/te #Searches the prefix _te_
curl -X GET http://localhost:6299/roo/v1/kvs/tes #Searches the prefix _tes_
curl -X GET http://localhost:6299/roo/v1/kvs/test #Searches the prefix _test_
curl -X GET http://localhost:6299/roo/v1/kvs #Gets everything in the _entire_ kv store (filter is on nothing)

Returns the rows searched using the SCAN query (in KV land its a prefix filter) in JSON
The resulting values are encoded in base64, so you may need to convert them (unlike the GET single query above which returns raw bytes)
Use window.atob("dGVz......dCBkYXRh") in javascript. Use json.Unmarshall or string([]byte) in Golang Go if you want a string... OR just use GET instead.

Help!

FAQ

It hangs

You've reached the maximum requests to LetsEncrypt probably. You can check this by running curl -X GET http://localhost:6299/roo/v1/kvs/ and finding com.roo.cache:your.domain.com. If it exists it's not this.
Or your stack_service name isn't correct (the DestinationHost label in your docker-compose file).

I don't see my site!

You may have tried to go to the site before the service updated the docker routing table (it updates every 60 seconds). If you went to your site before it updates, roo thinks that your domain is a dodgy request and puts similar requests in the bin for 4 minutes.

Something might be up!

Get a status of your containers (you first need to get ansible, and add your docker nodes to the docker-hosts group [you may need to look into ssh-agent too]):

ansible docker-hosts -a "docker stats --no-stream"

This will get a realtime snapshot on all your machines in your swarm.

Inspecting the roo containers

Inspect the logs

docker service logs roo_roo -f

Inspect the containers

docker run -it --net=forenet alpine ash
nslookup tasks.roo_roo.
curl -X GET http://<result_of_nslookup>:6299/roo/v1/kvs

Getting Started (on docker)

Want to just run it?

docker run sfproductlabs/roo:latest

Andrew's DevOps Setup (Yuck! But we have to do it)

I use floating IPs that transition from swarm worker to swarm worker upon failure. (Highly Available)
with round robin DNS (setup a few workers and share the IPs) (Load Balanced, a bit dodgy but works)
You need to make the swarm redundant with more than one node, the mesh network load balances internally. Make it more than 2 nodes so that the raft cluster doesn't fight over leadership. Odd numbers are great. (HA & LB)
It may not cost as much as an AWS ELB, but it probably won't saturate either. Yes, I've run into issues where you need to "warm up" the Amazon elastic load balancer before. I wouldn't be surprised if this handled as much traffic without the cost.
No need to say this is $$$$ cheap. I'm saving 10x as much as I would be if I used Amazon AWS using this setup. It's nice to give my startups the same tech my enterprise clients get, but they can actually afford. I don't want to share which cloud provider I used as it took 30 days to request 1 extra machine. But it was cheap. Let us all know if you find something better! You can get these benefits too if you look!

TODO

Credits

Support

I use roo commercially and in production for my startups. If you want support, email us at [email protected].

If you use it or like it please let me know!

m8e / roo Goto Github PK

roo's Introduction