marathon_deploy 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35b3f25c8764a73dd299377a082c1bf279574ba3
-  data.tar.gz: f8db464c0a0165b0f16de1bda5c170b07c069e60
+  metadata.gz: b3c10080e27dce236a05a0579d9ff2ba19517bb6
+  data.tar.gz: 19d88259390b2d88b19542cab495afafcf8445cf
 SHA512:
-  metadata.gz: 77cdd112a5424d33c3188391194ae099090ed7bd15b6a3e97ccdf20d0b42517491b5342a51ddba7288b481413e319b84a281c45277b244f822ce1c182990c7a9
-  data.tar.gz: cbee096acc67009a5b7183fc2eeb7a04890c94f54f09e1f715f43b47e27496f621132d0f8b1d37b60a33d38e0ad3280c2bbd3627ffccd2b232e921ce4984d4fe
+  metadata.gz: 0d10120a0317cfb3472efb082c579c3e9ae7b58c3cc3bc8e7ca0dcf3f7c3f26babb21d1876de9ba389fac83e290e7dd9e41ac9e77ba19f199cec66307d623274
+  data.tar.gz: 7d51c281c3efa1682114d11f597ffc0067578556ccd734dc0c9c05408e2ff430bd49df12725cdb4a57e6739a587d991893c20cd937310677ea2ce93076ac46c6

data/README.md

@@ -1,26 +1,115 @@
-# MarathonDeploy
+# Marathon Deploy
+
+A [Marathon](https://mesosphere.github.io/marathon/) command-line deployment tool in Ruby.  Takes a json or yaml file describing an application and pushes it to the Marathon [REST API](https://mesosphere.github.io/marathon/docs/rest-api.html)
+
+### Feature Summary
+* Deploy a single application descriptor to multiple marathon endpoints
+* Checks for existing deployment of application before starting new deployment
+* Polls for Healthcheck results after deployment
+* Proper exit codes for easier integration with Jenkins automated pipelines
+* Deploy file macro substitution using values from ENV variables (eg, %%MACRO_NAME%%)
+* PRODUCTION / PREPRODUCTION modes (specified with --environment)
+* Rolling upgrade deployment strategy (Marathon default)
+
+
+### Roadmap Features
+* Record actions and json payload to a database (for rollback, history, auditing)
+* Deploy a deployment descriptor containing multiple applications
 
-TODO: Write a gem description
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Ensure Ruby (1.9+) and gem are installed on you system, then run:
 
-```ruby
-gem 'marathon_deploy'
+```
+$ gem install marathon_deploy
 ```
 
-And then execute:
-
-    $ bundle
+Executables from this gem (automatically added to your $PATH):
 
-Or install it yourself as:
+    $ deploy.rb  (client program executable)
+    $ json2yaml.rb (convenience utility for converting json to yaml)
+    $ expand_macros.rb (expands all macros in the form %%MACRO%% with value of ENV[MACRO])
 
-    $ gem install marathon_deploy
 
 ## Usage
 
-TODO: Write usage instructions here
+### Help
+```
+ deploy.rb -h
+Usage: deploy.rb [options]
+    -u, --url MARATHON_URL(S)        Default: ["http://localhost:8080"]
+    -l, --logfile LOGFILE            Default: STDOUT
+    -v, --verbose                    Run verbosely
+    -f, --file DEPLOYFILE            Deploy file with json or yaml file extension. Default: deploy.yaml
+    -e, --environment ENVIRONMENT    Default: PREPRODUCTION
+    -h, --help                       Show this message
+```
+
+### Example Deployfile
+By default, a file called 'deploy.yaml' is searched for in the current directory where deploy.rb is run from.  An alternative file name can be provided with the -f parameter.
+
+The file format must conform to the [Marathon API specification](https://mesosphere.github.io/marathon/docs/rest-api.html#post-/v2/apps)
+
+Minimalistic example (using Docker container):
+
+```
+id: python-example-stable
+cmd: echo python stable `hostname` > index.html; python3 -m http.server 8080
+mem: 16
+cpus: 0.1
+instances: 5
+container:
+  type: DOCKER
+  docker:
+    image: ubuntu:14.04
+    network: BRIDGE
+    portMappings:
+    - containerPort: 8080
+      hostPort: 0
+      protocol: tcp
+env:
+  SERVICE_TAGS: python,webapp,http,weight=100
+  SERVICE_NAME: python
+healthChecks:
+- portIndex: 0
+  protocol: TCP
+  gracePeriodSeconds: 30
+  intervalSeconds: 10
+  timeoutSeconds: 30
+  maxConsecutiveFailures: 3
+- path: "/"
+  portIndex: 0
+  protocol: HTTP
+  gracePeriodSeconds: 30
+  intervalSeconds: 10
+  timeoutSeconds: 30
+  maxConsecutiveFailures: 3
+```
+
+### JSON to YAML file conversion
+
+As a convenience, the provided json2yaml.rb script can convert a JSON file to the arguably more human-readable YAML format:
+
+```
+$json2yaml.rb marathon-webapp.json  > marathon-webapp.yaml
+```
+
+### Parsing a file with macro expansion from ENV variables
+
+A helper script which takes a file and replaces all macros having the format %%MACRO%% with the values from ENV variables.  Script will fail if there are no ENV values for macro names contained in the template.
+
+```
+$expand_macros.rb -h
+Usage: bin/expand_macros.rb [options]
+    -o, --outfile OUTFILE            Default: STDOUT
+    -l, --logfile LOGFILE            Default: STDOUT
+    -d, --debug                      Run in debug mode
+    -v, --version                    Version info
+    -f, --force                      force overwrite of existing OUTFILE
+    -t, --template TEMPLATE_FILE     Input file. Default: dockerfile.tpl
+    -h, --help                       Show this message
+```
 
 ## Contributing
 

data/bin/deploy.rb

@@ -5,6 +5,7 @@ require 'marathon_deploy/marathon_client'
 require 'marathon_deploy/error'
 require 'marathon_deploy/application'
 require 'marathon_deploy/environment'
+require 'marathon_deploy/version'
 require 'optparse'
 require 'logger'
 
@@ -12,14 +13,15 @@ options = {}
   
 # DEFAULTS
 options[:deployfile] = MarathonDeploy::MarathonDefaults::DEFAULT_DEPLOYFILE
-options[:verbose] = MarathonDeploy::MarathonDefaults::DEFAULT_LOGLEVEL
+options[:debug] = MarathonDeploy::MarathonDefaults::DEFAULT_LOGLEVEL
 options[:environment] = MarathonDeploy::MarathonDefaults::DEFAULT_ENVIRONMENT_NAME
-options[:marathon_endpoints] = nil
+options[:marathon_endpoints] = MarathonDeploy::MarathonDefaults::DEFAULT_PREPRODUCTION_MARATHON_ENDPOINTS
 options[:logfile] = MarathonDeploy::MarathonDefaults::DEFAULT_LOGFILE
   
 OptionParser.new do |opts|
-  opts.banner = "Usage: deploy.rb [options]"
-
+  opts.banner = "Usage: #{$0} [options]"
+  opts.release =  MarathonDeploy::VERSION
+  
   opts.on("-u","--url MARATHON_URL(S)", Array, "Default: #{options[:marathon_endpoints]}") do |u|    
     options[:marathon_endpoints] = u  
   end
@@ -28,8 +30,13 @@ OptionParser.new do |opts|
     options[:logfile] = l  
   end
   
-  opts.on("-v", "--verbose", "Run verbosely") do |v|
-    options[:verbose] = Logger::DEBUG
+  opts.on("-d", "--debug", "Run in debug mode") do |d|
+    options[:debug] = Logger::DEBUG
+  end
+  
+  opts.on("-v", "--version", "Version info") do |v|
+    puts "#{$0} version #{opts.release}"
+    exit!
   end
   
   opts.on("-f", "--file DEPLOYFILE" ,"Deploy file with json or yaml file extension. Default: #{options[:deployfile]}") do |f|
@@ -47,7 +54,7 @@ OptionParser.new do |opts|
 end.parse!
 
 $LOG = options[:logfile] ? Logger.new(options[:logfile]) : Logger.new(STDOUT)
-$LOG.level = options[:verbose]
+$LOG.level = options[:debug]
 
 deployfile = options[:deployfile]
 environment = MarathonDeploy::Environment.new(options[:environment])

data/bin/expand_macros.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+require 'marathon_deploy/error'
+require 'marathon_deploy/macro'
+require 'marathon_deploy/version'
+require 'optparse'
+require 'logger'
+
+DEFAULT_TEMPLATE_FILENAME = 'dockerfile.tpl'
+
+options = {}
+  
+# DEFAULTS
+options[:template] = DEFAULT_TEMPLATE_FILENAME
+options[:debug] = Logger::FATAL #Logger::INFO
+options[:outfile] = false
+options[:logfile] = false
+options[:force] = false
+  
+  
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+  opts.release =  MarathonDeploy::VERSION
+  
+  opts.on("-o","--outfile OUTFILE", String, "Default: STDOUT") do |o|   
+    options[:outfile] = o 
+  end
+    
+  opts.on("-l", "--logfile LOGFILE", "Default: STDOUT") do |l|
+    options[:logfile] = l  
+  end
+  
+  opts.on("-d", "--debug", "Run in debug mode") do |d|
+    options[:debug] = Logger::DEBUG
+  end
+  
+  opts.on("-v", "--version", "Version info") do |v|
+    puts "#{$0} version #{opts.release}"
+    exit!
+  end
+  
+  opts.on("-f", "--force", "force overwrite of existing OUTFILE") do |f|
+    options[:force] = true
+  end
+  
+  opts.on("-t", "--template TEMPLATE_FILE" ,"Input file. Default: #{options[:template]}") do |t|
+    options[:template] = t
+  end
+    
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end 
+end.parse!
+
+$LOG = options[:logfile] ? Logger.new(options[:logfile]) : Logger.new(STDOUT)
+$LOG.level = options[:debug]
+
+template = options[:template]
+
+begin
+  processed = MarathonDeploy::Macro.process_macros(template)
+rescue MarathonDeploy::Error::UndefinedMacroError => e
+  abort(e.message)
+rescue Errno::ENOENT => e
+  abort("Could not locate template file #{template}")
+end
+
+output = IO.new(STDOUT.fileno) 
+outfile = options[:outfile]
+if (outfile)
+  abort("File #{outfile} already exists. Please remove or rename it.") if (File.exists?(outfile) && !options[:force])
+  fd = IO.sysopen(outfile, "w")
+  output = IO.new(fd,'w')
+end
+  
+output.write processed
+output.close
+  

data/lib/marathon_deploy/marathon_defaults.rb

@@ -10,7 +10,7 @@ module MarathonDeploy
   HEALTHY_WAIT_TIMEOUT = 300
   HEALTHY_WAIT_RECHECK_INTERVAL = 3
   PRODUCTION_ENVIRONMENT_NAME = 'PRODUCTION'
-  DEFAULT_ENVIRONMENT_NAME = 'INTEGRATION'
+  DEFAULT_ENVIRONMENT_NAME = 'PREPRODUCTION'
   DEFAULT_PREPRODUCTION_MARATHON_ENDPOINTS = ['http://localhost:8080']
   DEFAULT_PRODUCTION_MARATHON_ENDPOINTS = ['http://paasmaster46-1.mobile.rz:8080']
   DEFAULT_DEPLOYFILE = 'deploy.yaml'
@@ -20,7 +20,7 @@ module MarathonDeploy
   MARATHON_DEPLOYMENT_REST_PATH = '/v2/deployments/'
 
   @@preproduction_override = {
-    :instances => 20,
+    :instances => 5,
     :mem => 512,
     :cpus => 0.1      
   } 

data/lib/marathon_deploy/version.rb

@@ -1,3 +1,3 @@
 module MarathonDeploy
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/marathon_deploy.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.files         << ["bin/deploy.rb"]
   spec.files         << ["bin/json2yaml.rb"]
+  spec.files         << ["bin/expand_macros.rb"]
+  
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marathon_deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jonathan Colby
@@ -71,6 +71,7 @@ email:
 - jcolby@team.mobile.de
 executables:
 - deploy.rb
+- expand_macros.rb
 - json2yaml.rb
 extensions: []
 extra_rdoc_files: []
@@ -83,6 +84,7 @@ files:
 - Rakefile
 - TODO
 - bin/deploy.rb
+- bin/expand_macros.rb
 - bin/json2yaml.rb
 - examples/deploy.json
 - examples/deploy.yaml