scaltainer 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e83fe8588dcb50e60dd1b55b3fccefa1957f553b
-  data.tar.gz: fcaca1ceaa70b6145ce7c0de83246775cfb14627
+  metadata.gz: 6ff62795b21afacc40d04790673b5695f0ef86cb
+  data.tar.gz: bc4946701f80b23c6b16976518f546fd41cc278c
 SHA512:
-  metadata.gz: e92dad052350902b89d6a1055daea1aedbb72b217a851767008b74cc7b5ad50f14124148eeb02ed3198480f39c428cb87b142dff733033e5fc8a1f6abcb8a8a2
-  data.tar.gz: 290abee67df29b3bde1517d4f331b6562f58064312d6406463f45f7b3f2f9fc66dbfbd23a768c4f7fc3f46521473a379dd3bbec644b2b61aa2f2e6c4e399cea2
+  metadata.gz: 24760c131990d3e4a7401d1ddaae1240340fb3be1df55f21ef759dc4a90fdf615864b7b4aefd763822e30f0904fe0fd2de89b386716db841fbc5723e095ea297
+  data.tar.gz: 157ffea30dace9c2426ebc6c7014ed2b645824be62d540eef3e72a3d68b07842a1cc132c0e62f74de39c65ddc239a845844a1bac9241041030008cf52c91294e

data/README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://travis-ci.org/hammady/scaltainer.svg?branch=master)](https://travis-ci.org/hammady/scaltainer)
 [![Coverage Status](https://coveralls.io/repos/github/hammady/scaltainer/badge.svg?service=github&branch=master)](https://coveralls.io/github/hammady/scaltainer?branch=master)
+[![Gem Version](https://badge.fury.io/rb/scaltainer.svg)](https://badge.fury.io/rb/scaltainer)
 
 # Scaltainer
 
@@ -41,7 +42,12 @@ Example:
 
     scaltainer -f /path/to/configuration/file.yml --state-file /path/to/different/state/file.yml
 
-Typically, the above command should be put inside a cronjob that is triggered every minute or so.
+Typically one would want to repeatedly call scaltainer every minute or so. To do this
+specify the wait time between repetitions using the `-w` parameter in seconds:
+
+    scaltainer -w 60
+
+This will repeatedly call scaltainer every 60 seconds, sleeping in between.
 
 ## Configuration
 
@@ -120,6 +126,57 @@ The configuration file (determined by `-f FILE` command line parameter) should b
 
 More details about configuration parameters can be found in [HireFire docs](https://help.hirefire.io/guides).
 
+## Docker installation and usage
+
+Scaltainer is availabe on Docker Hub, so you can `docker run` it:
+
+    docker run -it --rm rayyanqcri/scaltainer
+
+Which will print the usage. To add arguments, just append them:
+
+    docker run -it --rm rayyanqcri/scaltainer -f scaltainer.yml
+
+Scaltainer should typically be run as a minutely cron service.
+If you are using [rayyanqcri/swarm-scheduler](https://github.com/rayyanqcri/swarm-scheduler),
+a service definition for scaltainer is typically something like this:
+
+    version: '3.3'
+    services:
+      scaltainer:
+        image: rayyanqcri/scaltainer:latest
+        command: -f /scaltainer.yml --state-file /tmp/scaltainer-state.yml
+        volumes:
+          - /var/run/docker.sock:/var/run/docker.sock
+        environment:
+          - DOCKER_URL=unix:///var/run/docker.sock
+          - DOCKER_SECRETS_PATH_GLOB={/run/secrets/*}
+          - RESPONSE_TIME_WINDOW=3
+        configs:
+          - source: scaltainer
+            target: /scaltainer.yml
+        secrets:
+          - scaltainer
+        deploy:
+          replicas: 0
+          restart_policy:
+            condition: none
+          placement:
+            constraints:
+              - node.role == manager
+    configs:
+      scaltainer:
+        file: scaltainer.yml
+    secrets:
+      scaltainer:
+        file: scaltainer.env
+
+Where `scaltainer.env` is a file containing HireFire and NewRelic secrets:
+
+    HIREFIRE_TOKEN=
+    NEW_RELIC_API_KEY=
+
+And `scaltainer.yml` is the scaltainer configuration file.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/scaltainer

@@ -3,8 +3,8 @@
 require 'scaltainer'
 
 begin
-  configfile, statefile, logger = Scaltainer::Command.parse ARGV
-  Scaltainer::Runner.new configfile, statefile, logger
+  configfile, statefile, logger, wait = Scaltainer::Command.parse ARGV
+  Scaltainer::Runner.new configfile, statefile, logger, wait
 rescue => e
   $stderr.puts e.message
   $stderr.puts e.backtrace

data/lib/scaltainer/command.rb

@@ -4,7 +4,7 @@ require "optparse"
 module Scaltainer
   class Command
     def self.parse(args)
-      configfile, statefile = 'scaltainer.yml', nil
+      configfile, statefile, wait = 'scaltainer.yml', nil, 0
       OptionParser.new do |opts|
         opts.banner = "Usage: scaltainer [options]"
         opts.on("-f", "--conf-file FILE", "Specify configuration file (default: scaltainer.yml)") do |file|
@@ -13,6 +13,9 @@ module Scaltainer
         opts.on("--state-file FILE", "Specify state file (default: <conf-file>.state)") do |file|
           statefile = file
         end
+        opts.on("-w", "--wait SECONDS", "Specify wait time between repeated calls, 0 for no repetition (default: 0)") do |w|
+          wait = w.to_i
+        end
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts
           puts "\nEnvironment variables: \n"
@@ -35,7 +38,7 @@ module Scaltainer
       logger = Logger.new(STDOUT)
       logger.level = %w(debug info warn error fatal unknown).find_index((ENV['LOG_LEVEL'] || '').downcase) || 1
 
-      return configfile, statefile, logger
+      return configfile, statefile, logger, wait
     end
 
     private

data/lib/scaltainer/runner.rb

@@ -2,7 +2,7 @@ require "yaml"
 
 module Scaltainer
   class Runner
-    def initialize(configfile, statefile, logger)
+    def initialize(configfile, statefile, logger, wait)
       @logger = logger
       @default_service_config = {
         "min" => 0,
@@ -16,14 +16,24 @@ module Scaltainer
       Docker.logger = @logger
       state = get_state(statefile) || {}
       endpoint = config["endpoint"]
-      service_prefix = config["stack_name"]
-      iterate_services config["web_services"], service_prefix, ServiceTypeWeb.new(endpoint), state
-      iterate_services config["worker_services"], service_prefix, ServiceTypeWorker.new(endpoint), state
-      save_state statefile, state
+      service_type_web = ServiceTypeWeb.new(endpoint)
+      service_type_worker = ServiceTypeWorker.new(endpoint)
+      loop do
+        run config, state, service_type_web, service_type_worker
+        save_state statefile, state
+        sleep wait
+        break if wait == 0
+      end
     end
 
     private
 
+    def run(config, state, service_type_web, service_type_worker)
+      service_prefix = config["stack_name"]
+      iterate_services config["web_services"], service_prefix, service_type_web, state
+      iterate_services config["worker_services"], service_prefix, service_type_worker, state
+    end
+
     def get_state(statefile)
       YAML.load_file statefile if File.exists? statefile
     end

data/lib/scaltainer/version.rb

@@ -1,3 +1,3 @@
 module Scaltainer
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scaltainer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Hossam Hammady
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2017-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler