docker-swarm-api 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0b90891a651e044750fc2bc7b1956679634db08
-  data.tar.gz: 7fd85045899307db8a32fb3d94654167f4ba8ef2
+  metadata.gz: 1a8630271a889f20bc866426d01c86a9892e6fbe
+  data.tar.gz: 41d722648cf609db8f83da1e27715cd7f519040f
 SHA512:
-  metadata.gz: 4083515f3553d91273ea6e8f0b3959f71996529f9ab3340fd8f6e756677bf6cca787748e9491ec5b2e778d17e89b48ca1bc7a8c50b778e7b492f8bce6f119b17
-  data.tar.gz: a0e8a29a37b6eabc9c42e5963db95de9568cc2070b6c6e9fc00c008eb973d81ee38383ab2308873b6187af16076f49f32d1e1f37b8b6ad11c952ad0f0c17974d
+  metadata.gz: 5c84719528dfc669814d3444647fb96b052da5a61be9480dbbb68992e6309e80ba1f34db7c7606c0144a3c8ff5fa5c76178676c35c20f81916a6c646373c6a6a
+  data.tar.gz: 430e4921e366265643d67c917b77b4c97b7f8ce71d4216a352ea3fc2e5db6513f3f11a947d39c95e583e81072d4cdcf888bfbb5348353cef535314508241ed38

data/README.md

@@ -1,5 +1,11 @@
 # docker-swarm-api
 
+Must use Docker API Version of 1.24 or above.
+
+This project leverages swipely/docker-api, and adds Docker Swarm capability.
+
+Warning: cannot create overlay network in Docker Engine versions less than 1.13.  
+
 Sample Usage
 ------------
 ```ruby

data/lib/docker-swarm-api.rb

@@ -1 +1 @@
-require 'docker-swarm'
+require_relative './docker-swarm'

data/lib/docker-swarm.rb

@@ -22,12 +22,18 @@ module Docker
   module Swarm
     attr_accessor :creds, :logger
 
-    require 'docker/swarm/node'
-    require 'docker/swarm/service'
-    require 'docker/swarm/swarm'
-    require 'docker/swarm/connection'
-    require 'docker/swarm/network'
-    require 'docker/swarm/task'
+    require_relative './docker/swarm/node'
+    require_relative './docker/swarm/service'
+    require_relative './docker/swarm/swarm'
+    require_relative './docker/swarm/connection'
+    require_relative './docker/swarm/network'
+    require_relative './docker/swarm/task'
+    # require 'docker/swarm/node'
+    # require 'docker/swarm/service'
+    # require 'docker/swarm/swarm'
+    # require 'docker/swarm/connection'
+    # require 'docker/swarm/network'
+    # require 'docker/swarm/task'
 
     def default_socket_url
       'unix:///var/run/docker.sock'

data/lib/docker/swarm/connection.rb

@@ -6,13 +6,6 @@ class Docker::Swarm::Connection < Docker::Connection
     super(url, opts)
   end
   
-  #
-  # # The actual client that sends HTTP methods to the Docker server. This value
-  # # is not cached, since doing so may cause socket errors after bad requests.
-  # def resource
-  #   Excon.new(url, options)
-  # end
-  # private :resource
 
   # Send a request to the server with the `
   def request(*args, &block)
@@ -25,42 +18,4 @@ class Docker::Swarm::Connection < Docker::Connection
     end
   end
 
-  # def log_request(request)
-  #   if Docker.logger
-  #     Docker.logger.debug(
-  #       [request[:method], request[:path], request[:query], request[:body]]
-  #     )
-  #   end
-  # end
-
-#   # Delegate all HTTP methods to the #request.
-#   [:get, :put, :post, :delete].each do |method|
-#     define_method(method) { |*args, &block| request(method, *args, &block) }
-#   end
-#
-#   def to_s
-#     "Docker::Connection { :url => #{url}, :options => #{options} }"
-#   end
-#
-# private
-#   # Given an HTTP method, path, optional query, extra options, and block,
-#   # compiles a request.
-#   def compile_request_params(http_method, path, query = nil, opts = nil, &block)
-#     query ||= {}
-#     opts ||= {}
-#     headers = opts.delete(:headers) || {}
-#     content_type = opts[:body].nil? ?  'text/plain' : 'application/json'
-#     user_agent = "Swipely/Docker-API #{Docker::VERSION}"
-#     {
-#       :method        => http_method,
-#       :path          => "/v#{Docker::API_VERSION}#{path}",
-#       :query         => query,
-#       :headers       => { 'Content-Type' => content_type,
-#                           'User-Agent'   => user_agent,
-#                         }.merge(headers),
-#       :expects       => (200..204).to_a << 301 << 304,
-#       :idempotent    => http_method == :get,
-#       :request_block => block,
-#     }.merge(opts).reject { |_, v| v.nil? }
-#   end
 end

data/lib/docker/swarm/network.rb

@@ -1,16 +1,56 @@
 require 'docker-api'
 
-class Docker::Swarm::Network < Docker::Network
-
+class Docker::Swarm::Network 
+  attr_reader :hash
+  
+  def initialize(swarm, hash)
+    @hash = hash
+    @swarm = swarm
+  end
+  
+  def connection
+    return @swarm.connection
+  end
+  
+  def id
+    return @hash['Id']
+  end
+  
+  def name
+    return @hash['Name']
+  end
 
-  def self.find_by_name(network_name, connection)
-    networks = Docker::Network.all({}, connection)
-    
-    networks.each do |network|
-      if (network.info['Name'] == network_name)
-        return network
-      end
+  def remove
+    response = @swarm.connection.delete("/networks/#{id()}", {}, expects: [200, 204, 500], full_response: true)
+    if (response.status > 204)
+      raise "Error deleting network (#{name})  HTTP-#{response.status}  #{response.body}"
     end
-    return nil
   end
-end
+  
+end
+
+# EXAMPLE INSPECT OF OVERLAY NETWORK:
+# {
+#         "Name": "overlay1",
+#         "Id": "3eluvldbrv17xw6w39xxgg30a",
+#         "Scope": "swarm",
+#         "Driver": "overlay",
+#         "EnableIPv6": false,
+#         "IPAM": {
+#             "Driver": "default",
+#             "Options": null,
+#             "Config": [
+#                 {
+#                     "Subnet": "10.0.9.0/24",
+#                     "Gateway": "10.0.9.1"
+#                 }
+#             ]
+#         },
+#         "Internal": false,
+#         "Containers": null,
+#         "Options": {
+#             "com.docker.network.driver.overlay.vxlanid_list": "257"
+#         },
+#         "Labels": null
+#     }
+    

data/lib/docker/swarm/node.rb

@@ -61,7 +61,7 @@ class Docker::Swarm::Node
   
   def tasks
     return @swarm.tasks.select {|t| 
-      t.node.id == self.id
+      (t.node != nil) && (t.node.id == self.id)
     }
   end
 

data/lib/docker/swarm/service.rb

@@ -8,11 +8,23 @@ class Docker::Swarm::Service
     @swarm = swarm
     @hash = hash
   end
+  
+  def name()
+    @hash['Spec']['Name']
+  end
 
   def id()
     return @hash['ID']
   end
   
+  def network_ids
+    network_ids = []
+    @hash['Endpoint']['VirtualIPs'].each do |network_info|
+      network_ids << network_info['NetworkID']
+    end
+    return network_ids
+  end
+  
   def remove(opts = {})
     query = {}
     @swarm.connection.delete("/services/#{self.id}", query, :body => opts.to_json)

data/lib/docker/swarm/swarm.rb

@@ -1,4 +1,6 @@
 require 'docker-api'
+require 'resolv'
+
 
 # This class represents a Docker Swarm Node.
 class Docker::Swarm::Swarm
@@ -25,7 +27,16 @@ class Docker::Swarm::Swarm
           node.connection = Docker::Swarm::Connection.new("tcp://#{ip_address}:#{docker_port}")
         end
       else
-        ip_address = Resolv::DNS.new.getaddress(node.host_name())
+        ip_address = nil
+        begin
+          ip_address = Resolv::DNS.new.getaddress(node.host_name())
+        rescue
+          ip_address = Resolv::Hosts.new.getaddress(node.host_name())
+          if (!ip_address)
+            host_addresses = options[:host_addresses]
+            ip_address = host_addresses[node.host_name]
+          end
+        end
         node.connection = Docker::Swarm::Connection.new("tcp://#{ip_address}:#{docker_port}")
       end
       @node_hash[node.id] = {hash: node.hash, connection: node.connection}
@@ -120,15 +131,68 @@ class Docker::Swarm::Swarm
   end
   
   def networks
-    networks = Docker::Network.all({}, self.connection)
+    all_networks = []
+    response = connection.get("/networks", {}, full_response: true)
+    if (response.status == 200)
+      hashes = JSON.parse(response.body)
+      hashes.each do |hash|
+        all_networks << Docker::Swarm::Network.new(self, hash)
+      end
+    else
+      raise "Error finding netw"
+    end
+    return all_networks
   end
   
-  def create_network(network_name)
-    return Docker::Swarm::Network.create(network_name, opts = {}, self.connection)
+  def create_network(network_name, options = {})
+    defaults = {
+        "Name" => network_name,
+        "CheckDuplicate" => true,
+#        "Driver" => "bridge",
+        "Driver" => "overlay",
+        "EnableIPv6" => false,
+#         "IPAM" => {
+#           "Driver" => "default",
+#           "Config" => [
+#             {
+#              "Subnet" => "172.20.0.0/16",
+#              "IPRange" => "172.20.10.0/24",
+#              "Gateway" => "172.20.10.11"
+#             }
+#           ],
+#           "Options" => {
+# #            "foo" => "bar"
+#           }
+#          },
+        "Internal" => false,
+        "Options" => {
+            "com.docker.network.driver.overlay.vxlanid_list" => "257"
+        },
+        "Labels" => {
+          # "com.example.some-label": "some-value",
+          # "com.example.some-other-label": "some-other-value"
+        }
+      }
+      opts = defaults.merge(options)
+      response = connection.post('/networks/create', {},  body: opts.to_json, expects: [200, 201, 500], full_response: true)
+      if (response.status <= 201)
+        hash = JSON.parse(response.body)
+        response = connection.get("/networks/#{hash['Id']}", {}, expects: [200, 201], full_response: true)
+        hash = Docker::Util.parse_json(response.body)
+        network = Docker::Swarm::Network.new(self, hash)
+        return network
+      else
+        raise "Error creating network: HTTP-#{response.status} - #{response.body}"
+      end
   end
   
   def find_network_by_name(network_name)
-    return Docker::Swarm::Network::find_by_name(network_name, self.connection)
+    networks.each do |network|
+      if (network.name == network_name)
+        return network
+      end
+    end
+    return nil
   end
   
   # Return all of the Nodes.
@@ -151,10 +215,15 @@ class Docker::Swarm::Swarm
 
   def create_service(opts = {})
     query = {}
-    response = self.connection.post('/services/create', query, :body => opts.to_json)
-    info = JSON.parse(response)
-    service_id = info['ID']
-    return self.find_service(service_id)
+    response = self.connection.post('/services/create', query, :body => opts.to_json, expects: [201, 500], full_response: true)
+    if (response.status <= 201)
+      info = JSON.parse(response.body)
+      service_id = info['ID']
+      return self.find_service(service_id)
+    else
+      raise "Error creating service:  HTTP-#{response.status}  #{response.body}"
+    end
+    return nil
   end
   
   def find_service(id)
@@ -165,6 +234,13 @@ class Docker::Swarm::Swarm
     return Docker::Swarm::Service.new(self, hash)
   end
   
+  def find_service_with_name(name)
+    services.each do |service|
+      return service if (service.name == name)
+    end
+    return nil
+  end
+  
   def services
     items = []
     query = {}
@@ -218,6 +294,8 @@ class Docker::Swarm::Swarm
     if (response.status == 200)
       swarm = Docker::Swarm::Swarm.new(JSON.parse(response.body), connection, options)
       return swarm
+    elsif (response.status == 406)
+      return nil
     else 
       raise "Error finding swarm: HTTP-#{response.status} #{response.body}"
     end

data/lib/docker/swarm/version.rb

@@ -1,7 +1,7 @@
 module Docker
   module Swarm
     # The version of the docker-api gem.
-    VERSION = '1.2.1'
+    VERSION = '1.2.2'
 
     # The version of the compatible Docker remote API.
     API_VERSION = '1.24'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-swarm-api
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Mike Moore / Rogue Wave Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-26 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json