marathon-api 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43d4d0f2016049fc44bde4ee4ffe6789de4631c0
-  data.tar.gz: 03579636a8d4577d7e8dc2ba1098eeb67b099ad2
+  metadata.gz: 23bb47d2d3c76218c3aa461968660ac5551e3f76
+  data.tar.gz: ce1149c5f48884ecd403b69e61fb9ab12f8e0b3b
 SHA512:
-  metadata.gz: fe8feb603efd0ebe26e33ccd4cc3a406906a3dcef67e15e8f4b14393a239a8a01995de5e2d77fc89cc980d900319e1ee011b77caca1c7894bd03850be697a484
-  data.tar.gz: c0f7768067d89be77eb44e179636e40e9533722697555bc65fbe84c090d7307e0980016f0dcd52533bc965e4599af4cbcd9ade1b7ebb389933dc8358ddabe08b
+  metadata.gz: 7fca9778495fc930fe67d956a7db8e749f08c56e2e0bcce4320bac3dfbf94ac6d1025909135c573e06938fa2c27705b1a2d7f774a8713830192d768c27990faa
+  data.tar.gz: 6301fea04cd2a18a89aa6dd59a52c46b79d2ee8a6a580131783661c249021e75750aa758c19c7efad99dad13621e24243f64270654f29b6d3aa672c75f00684d

data/.simplecov

@@ -1,5 +1,5 @@
 SimpleCov.start do
   add_group 'Library', 'lib'
-  add_group 'Specs', 'spec'
-  add_filter '/vendor/'
+  add_filter '/vendor'
+  add_filter '/spec'
 end

data/.travis.yml

@@ -6,5 +6,5 @@ rvm:
   - 2.2.0
 env:
   global:
-    - CODECLIMATE_REPO_TOKEN=8e7c316d892f832fa3de24bc2e88bf0d243e09947ea95319afcafcdb10f5eb3c
+    - CODECLIMATE_REPO_TOKEN=a0f25c19629dd353c43aef0cbbd886a7a4079c2238711fa4f932e1477b818195
 script: bundle exec rake

data/README.md

@@ -1,46 +1,72 @@
 marathon-api
 ============
 
-[![travis-ci](https://travis-ci.org/felixb/marathon-api.png?branch=master)](https://travis-ci.org/felixb/marathon-api) [![Code Climate](https://codeclimate.com/github/felixb/marathon-api/badges/gpa.svg)](https://codeclimate.com/github/felixb/marathon-api) [![Test Coverage](https://codeclimate.com/github/felixb/marathon-api/badges/coverage.svg)](https://codeclimate.com/github/felixb/marathon-api)
+[![Gem Version](https://badge.fury.io/rb/marathon-api.svg)](http://badge.fury.io/rb/marathon-api) [![travis-ci](https://travis-ci.org/otto-de/marathon-api.png?branch=master)](https://travis-ci.org/otto-de/marathon-api) [![Code Climate](https://codeclimate.com/github/otto-de/marathon-api/badges/gpa.svg)](https://codeclimate.com/github/otto-de/marathon-api) [![Test Coverage](https://codeclimate.com/github/otto-de/marathon-api/badges/coverage.svg)](https://codeclimate.com/github/otto-de/marathon-api)
 
 This gem provides an object oriented interface to the [Marathon Remote API][1]. At the time if this writing, marathon-api is meant to interface with Marathon version 0.8.0.
 
 Installation
 ------------
 
-Add this line to your application's Gemfile=>
+Add this line to your application's Gemfile:
 
 ```ruby
-gem 'docker-api',  =>require => 'docker',  =>git => 'https=>//github.com/felixb/marathon-api.git'
+gem 'marathon-api', :require => 'marathon'
 ```
 
-And then run=>
+And then run:
 
 ```shell
 $ bundle install
 ```
 
-Finally,  just add `require 'marathon'` to the top of the file using this gem.
+Alternatively, if you wish to just use the gem in a script, you can run:
+
+```shell
+$ gem install marathon-api
+```
+
+Finally, just add `require 'marathon'` to the top of the file using this gem.
 
 Usage
 -----
 
 marathon-api is designed to be very lightweight. Only little state is cached to ensure that each method call's information is up to date. As such,  just about every external method represents an API call.
 
-If you're running Marathon locally on port 8080,  there is no setup to do in Ruby. If you're not or change the path or port,  you'll have to point the gem to your socket or local/remote port. For example=>
+If you're running Marathon locally on port 8080,  there is no setup to do in Ruby. If you're not or change the path or port,  you'll have to point the gem to your socket or local/remote port. For example:
+
+```ruby
+Marathon.url = 'http://example.com:8080'
+```
+
+It's possible to use `ENV` variables to configure the endpoint as well:
+
+```shell
+$ MARATHON_URL=http://remote.marathon.example.com:8080 irb
+irb(main):001:0> require 'marathon'
+=> true
+irb(main):002:0> Marathon.url
+=> "http://remote.marathon.example.com:8080"
+```
+
+## Authentification
+
+You have two options to set authentification if your Marathon API requires it:
 
 ```ruby
-Marathon.url = 'http=>//example.com=>8080'
+Marathon.options = {:username => 'your-user-name', :password => 'your-secret-password'}
 ```
 
-It's possible to use `ENV` variables to configure the endpoint as well=>
+or
 
 ```shell
-$ MARATHON_URL=http=>//remote.marathon.example.com=>8080 irb
-irb(main)=>001=>0> require 'marathon'
+$ export MARATHON_USER=your-user-name
+$ export MARATHON_PASSWORD=your-secret-password
+$ irb
+irb(main):001:0> require 'marathon'
 => true
-irb(main)=>002=>0> Marathon.url
-=> "http=>//remote.marathon.example.com=>8080"
+irb(main):002:0> Marathon.options
+=> {:username => "your-user-name", :password => "your-secret-password"}
 ```
 
 ## Global calls
@@ -50,7 +76,7 @@ require 'marathon'
 # => true
 
 Marathon.info
-# => {"name"=>"marathon", "http_config"=>{"assets_path"=>null, "http_port"=>8080, "https_port"=>8443}, "frameworkId"=>"20150228-110436-16842879-5050-2169-0001", "leader"=>null, "event_subscriber"=>null, "marathon_config"=>{"local_port_max"=>20000, "local_port_min"=>10000, "hostname"=>"mesos", "master"=>"zk=>//localhost=>2181/mesos", "reconciliation_interval"=>300000, "mesos_role"=>null, "task_launch_timeout"=>300000, "reconciliation_initial_delay"=>15000, "ha"=>true, "failover_timeout"=>604800, "checkpoint"=>true, "executor"=>"//cmd", "marathon_store_timeout"=>2000, "mesos_user"=>"root"}, "version"=>"0.8.0", "zookeeper_config"=>{"zk_path"=>"/marathon", "zk"=>null, "zk_timeout"=>10, "zk_hosts"=>"localhost=>2181", "zk_future_timeout"=>{"duration"=>10}}, "elected"=>false}
+# => {"name"=>"marathon", "http_config"=>{"assets_path"=>null, "http_port"=>8080, "https_port"=>8443}, "frameworkId"=>"20150228-110436-16842879-5050-2169-0001", "leader"=>null, "event_subscriber"=>null, "marathon_config"=>{"local_port_max"=>20000, "local_port_min"=>10000, "hostname"=>"mesos", "master"=>"zk://localhost:2181/mesos", "reconciliation_interval"=>300000, "mesos_role"=>null, "task_launch_timeout"=>300000, "reconciliation_initial_delay"=>15000, "ha"=>true, "failover_timeout"=>604800, "checkpoint"=>true, "executor"=>"//cmd", "marathon_store_timeout"=>2000, "mesos_user"=>"root"}, "version"=>"0.8.0", "zookeeper_config"=>{"zk_path"=>"/marathon", "zk"=>null, "zk_timeout"=>10, "zk_hosts"=>"localhost:2181", "zk_future_timeout"=>{"duration"=>10}}, "elected"=>false}
 
 Docker.ping
 # => 'pong'
@@ -88,4 +114,4 @@ This program is licensed under the MIT license. See LICENSE for details.
 
 [1]: https://mesosphere.github.io/marathon/docs/rest-api.html
 [2]: https://github.com/mesosphere/marathon_client
-[3]: https://github.com/swipely/docker-api
+[3]: https://github.com/swipely/docker-api

data/bin/marathon

@@ -0,0 +1,242 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'marathon'))
+require 'trollop'
+require 'json'
+
+SUB_COMMANDS = %w[kill kill_tasks start scale list list_tasks search]
+ATTRIBUTES = [:id, :cmd, :executor, :instances, :cpus, :mem, :uris]
+DEFAULT_APP_OPTS = {
+        :instances => 1,
+        :cpus => 1,
+        :mem  => 10,
+      }
+
+# print a list of apps to STDOUT
+def print_apps(apps)
+  if apps.empty?
+    puts "No apps currently running"
+  else
+    apps.each do |app|
+      puts app.to_pretty_s
+      puts
+    end
+  end
+end
+
+# print a list of tasks to STDOUT
+def print_tasks(tasks)
+  if tasks.empty?
+    puts "No tasks currently running"
+  else
+    tasks.each do |task|
+      puts task.to_pretty_s
+      puts
+    end
+  end
+end
+
+def subcmd_list(cmd_opts)
+  apps = Marathon::App.list(cmd_opts[:command], 'apps.tasks')
+  print_apps(apps)
+end
+
+def subcmd_start(cmd_opts)
+  begin
+    if cmd_opts[:json]
+      path = cmd_opts[:json]
+      if path == '-'
+        app_opts = Marathon::Util.keywordize_hash(JSON.parse($stdin.read))
+      elsif File.exists?(path)
+        app_opts = Marathon::Util.keywordize_hash(JSON.parse(File.read(cmd_opts[:json])))
+      else
+        raise Marathon::Error::ArgumentError, "File '#{path}' does not exist"
+      end
+    else
+      app_opts = DEFAULT_APP_OPTS
+    end
+    app_opts.merge!(cmd_opts.select { |k,_| ATTRIBUTES.include?(k) and cmd_opts["#{k.id2name}_given".to_sym] })
+    if cmd_opts[:env]
+      app_opts[:env] = Hash[cmd_opts[:env].map { |e| e.split('=', 2) }]
+    end
+    if cmd_opts[:constraints]
+      app_opts[:constraints] = cmd_opts[:constraint].map { |c| c.split(':') }
+    end
+    app = Marathon::App.new(app_opts)
+    puts "Starting app '#{app}'"
+    app.start!
+    print_apps([app])
+  rescue Marathon::Error::MarathonError => e
+    puts "#{e.class}: #{e.message}"
+    exit 1
+  end
+end
+
+def subcmd_scale(cmd_opts)
+  begin
+    app = Marathon::App.get(cmd_opts[:id])
+    puts "Scaling app '#{app.id}' from #{app.instances} to #{cmd_opts[:instances]}"
+    puts app.scale!(cmd_opts[:instances], cmd_opts[:force])
+  rescue Marathon::Error::NotFoundError => e
+    puts "#{e.class}: #{e.message}"
+    exit 1
+  end
+end
+
+def subcmd_kill(cmd_opts)
+  begin
+    puts "Removing app '#{cmd_opts[:id]}'"
+    Marathon::App.delete(cmd_opts[:id])
+    puts 'done'
+  rescue Marathon::Error::NotFoundError => e
+    puts "#{e.class}: #{e.message}"
+    exit 1
+  end
+end
+
+def subcmd_list_tasks(cmd_opts)
+  if cmd_opts[:id]
+    tasks = Marathon::Task.get(cmd_opts[:id])
+  else
+    tasks = Marathon::Task.list
+  end
+  print_tasks(tasks)
+end
+
+def subcmd_kill_tasks(cmd_opts)
+  if cmd_opts[:task_id]
+    puts "Killing task of '#{cmd_opts[:id]}' with id '#{cmd_opts[:task_id]}'"
+    tasks = [Marathon::Task.delete(cmd_opts[:id], cmd_opts[:task_id], cmd_opts[:scale])]
+  elsif cmd_opts[:host]
+    puts "Killing tasks of '#{cmd_opts[:id]}' on host '#{cmd_opts[:host]}'"
+    tasks = Marathon::Task.delete_all(cmd_opts[:id], cmd_opts[:host], cmd_opts[:scale])
+  else
+    puts "Killing tasks of '#{cmd_opts[:id]}'"
+    tasks = Marathon::Task.delete_all(cmd_opts[:id], nil, cmd_opts[:scale])
+  end
+  print_tasks(tasks)
+end
+
+# parse global options
+def parse_global_opts
+  global_opts = Trollop.options do
+    version Marathon::VERSION
+    banner <<-EOS
+Usage: marathon [global options] [command] [options]
+
+Available commands:
+
+  kill        Kill an app and remove it from Marathon.
+  kill_tasks  Kill a task or tasks belonging to a specified app.
+  list        Show a list of running apps and their options.
+  list_tasks  Show a list of an app's running tasks.
+  scale       Scale the number of app instances.
+  search      Search the current list of apps.
+  start       Start a new app.
+
+Global options:
+EOS
+
+    opt :url, 'Marathon host (default http://localhost:8080, or MARATHON_HOST)',
+      :short => '-M', :type => String
+    opt :username, 'User name to authenticate against Marathon (optional, default unset, or MARATHON_USER).',
+      :short => '-U', :type => String
+    opt :password, 'Password to authenticate against Marathon (optional, default unset, or MARATHON_PASSWORD).',
+      :short => '-P', :type => String
+    stop_on SUB_COMMANDS
+  end
+  return global_opts
+end
+
+# set global options to Marathon API
+def set_global_opts(global_opts)
+  # Set client's URL
+  Marathon.url = global_opts[:url] if global_opts[:url]
+  global_opts.delete(:url)
+  # Set client's options
+  Marathon.options = global_opts if global_opts.size > 0
+end
+
+# get the subcommand
+def parse_subcmd
+  cmd = ARGV.shift
+  return cmd
+end
+
+# parse subcommand specific options
+def parse_subcmd_opts(cmd)
+  cmd_opts = case cmd
+    when 'list'
+      Trollop.options do
+        opt :command, 'The command for the app.', :short => '-C', :type => String
+      end
+    when 'start'
+      Trollop.options do
+        opt :json, 'A json formatted file to read application details from. (use - to read from stdin)', :short => '-j', :type => String
+        opt :id, 'A unique identifier for the app.', :short => '-i', :type => String
+        opt :cmd, 'The command to start the app.', :short => '-C', :type => String
+        opt :executor, 'The mesos executor to be used to launch the app.', :short => '-X', :type => String
+        opt :instances, 'The number of instances to run (default 1).', :default => 1, :short => '-n'
+        opt :cpus, 'The number of CPUs to give to this app, can be a fraction (default 1.0).', :short => '-c'
+        opt :mem, 'The memory limit for this app, in MB, can be a fraction (default 10.0).', :short => '-m'
+        opt :uri, 'URIs to download and unpack into the working directory.', :short => '-u', :type => :strings
+        opt :env, 'Environment variables to add to the process, as NAME=VALUE.', :short => '-e', :type => :strings
+        opt :constraint, 'Placement constraint for tasks, e.g. hostname:UNIQUE or rackid:CLUSTER', :type => :strings
+      end
+    when 'scale'
+      Trollop.options do
+        opt :id, 'A unique identifier for the app.', :short => '-i', :type => String, :required => true
+        opt :instances, 'The number of instances to run.', :short => '-n', :type => Integer, :required => true
+        opt :force, 'The current deployment can be overridden by setting the `force`.', :short => '-f'
+      end
+    when 'kill'
+      Trollop.options do
+        opt :id, 'A unique identifier for the app.', :short => '-i', :type => String, :required => true
+      end
+    when 'list_tasks'
+      Trollop.options do
+        opt :id, 'A unique identifier for the app.', :short => '-i', :type => String, :default => nil
+      end
+    when 'kill_tasks'
+      Trollop.options do
+        opt :host, 'Scope task killing to the given host.', :short => '-H', :type => String
+        opt :id, 'A unique identifier for the app.', :short => '-i', :type => String, :required => true
+        opt :scale, 'If true, the app is scaled down after killing tasks', :short => '-s'
+        opt :task_id, 'A unique identifier for the task.', :short => '-t', :type => String
+      end
+    else
+      {}
+    end
+
+  return cmd_opts
+end
+
+# Run selected subcmd
+def run_subcmd(cmd, cmd_opts)
+  case cmd
+  when 'list'
+    subcmd_list(cmd_opts)
+  when 'start'
+    subcmd_start(cmd_opts)
+  when 'scale'
+    subcmd_scale(cmd_opts)
+  when 'kill'
+    subcmd_kill(cmd_opts)
+  when 'list_tasks'
+    subcmd_list_tasks(cmd_opts)
+  when 'kill_tasks'
+    subcmd_kill_tasks(cmd_opts)
+  else
+    Trollop.die "unknown subcommand #{cmd.inspect}"
+  end
+end
+
+if __FILE__ == $0
+  global_opts = parse_global_opts
+  set_global_opts(global_opts)
+
+  cmd = parse_subcmd
+  cmd_opts = parse_subcmd_opts(cmd)
+
+  run_subcmd(cmd, cmd_opts)
+end

data/fixtures/marathon_docker_sample_2.json

@@ -10,5 +10,6 @@
   "cpus": 0.1,
   "mem": 64,
   "uris": [],
-  "cmd": "while sleep 10; do date -u +%T; done"
+  "cmd": "while sleep 10; do date -u +%T; done",
+  "constraints": [["hostname", "GROUP_BY"]]
 }

data/fixtures/vcr/Marathon_App/_restart/restarts_an_app.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:8080/v2/apps//ubuntu2/restart
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - ub0r/Marathon-API 0.9.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"version":"2015-03-07T14:15:30.159Z","deploymentId":"d38f8d55-b8b0-4893-ab16-ae474e282263"}'
+    http_version: 
+  recorded_at: Sat, 07 Mar 2015 14:15:30 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_Group/_changes/changes_the_group.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:8080/v2/groups//ubuntu2
+    body:
+      encoding: UTF-8
+      string: '{"instances":2}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - ub0r/Marathon-API 0.9.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"version":"2015-03-09T10:33:40.511Z","deploymentId":"4186c1d4-80a8-4cf2-a606-cc9e93680c13"}'
+    http_version: 
+  recorded_at: Mon, 09 Mar 2015 10:33:40 GMT
+- request:
+    method: put
+    uri: http://localhost:8080/v2/groups//ubuntu2?force=true
+    body:
+      encoding: UTF-8
+      string: '{"instances":1}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - ub0r/Marathon-API 0.9.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"version":"2015-03-09T10:33:40.730Z","deploymentId":"72ad642f-90ba-4fec-8470-9abec46c47c3"}'
+    http_version: 
+  recorded_at: Mon, 09 Mar 2015 10:33:40 GMT
+recorded_with: VCR 2.9.3