Class: FPM::Fry::Client

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/fpm/fry/client.rb

Defined Under Namespace

Classes: ContainerNotFound, FileNotFound, NotAFile

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/fpm/fry/client.rb', line 32

def initialize(options = {})
  @docker_url = options.fetch(:docker_url){ self.class.docker_url }
  @logger = options[:logger]
  if @logger.nil?
    @logger = Cabin::Channel.get
  end
  if options[:tls].nil? ? docker_url =~ %r!(\Ahttps://|:2376\z)! : options[:tls]
    # enable tls
    @tls = {
      client_cert: File.join(self.class.docker_cert_path,'cert.pem'),
      client_key: File.join(self.class.docker_cert_path, 'key.pem'),
      ssl_ca_file: File.join(self.class.docker_cert_path, 'ca.pem'),
      ssl_verify_peer: options.fetch(:tlsverify){ false }
    }
    [:client_cert, :client_key, :ssl_ca_file].each do |k|
      if !File.exist?(@tls[k])
        raise ArgumentError.new("#{k} #{@tls[k]} doesn't exist. Did you set DOCKER_CERT_PATH correctly?")
      end
    end
  else
    @tls = {}
  end
end

Instance Attribute Details

#docker_url ⇒ Object (readonly)

Returns the value of attribute docker_url.



30
31
32
 
# File 'lib/fpm/fry/client.rb', line 30

def docker_url
  @docker_url
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



30
31
32
 
# File 'lib/fpm/fry/client.rb', line 30

def logger
  @logger
end

#tls ⇒ Object (readonly)

Returns the value of attribute tls.



30
31
32
 
# File 'lib/fpm/fry/client.rb', line 30

def tls
  @tls
end

Class Method Details

.docker_cert_path ⇒ String

Returns docker cert path from environment.

Returns:

  • (String) —

    docker cert path from environment



72
73
74
 
# File 'lib/fpm/fry/client.rb', line 72

def self.docker_cert_path
  ENV.fetch('DOCKER_CERT_PATH',File.join(Dir.home, '.docker'))
end

.docker_url ⇒ Object 



76
77
78
 
# File 'lib/fpm/fry/client.rb', line 76

def self.docker_url
  ENV.fetch('DOCKER_HOST'.freeze, 'unix:///var/run/docker.sock')
end

Instance Method Details

#agent ⇒ Object 



214
215
216
 
# File 'lib/fpm/fry/client.rb', line 214

def agent
  @agent ||= agent_for(docker_url, tls)
end

#agent_for(uri, tls) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/fpm/fry/client.rb', line 222

def agent_for( uri, tls )
  proto, address = uri.split('://',2)
  options = {
    read_timeout: 10000
  }.merge( tls )
  case(proto)
  when 'unix'
    uri = "unix:///"
    options[:socket] = address
    options[:host] = ""
    options[:hostname] = ""
  when 'tcp'
    if tls.any?
      return agent_for("https://#{address}", tls)
    else
      return agent_for("http://#{address}", tls)
    end
  when 'http', 'https'
  end
  logger.debug("Creating Agent", options.merge(uri: uri))
  return Excon.new(uri, options)
end

#broken_symlinks? ⇒ Boolean

Returns:

  • (Boolean) 


218
219
220
 
# File 'lib/fpm/fry/client.rb', line 218

def broken_symlinks?
  return true
end

#changes(name) ⇒ Object 



176
177
178
179
180
181
182
183
 
# File 'lib/fpm/fry/client.rb', line 176

def changes(name)
  url = url('containers',name,'changes')
  res = agent.get(path: url, expects: [200, 204])
  return JSON.parse(res.body)
rescue Excon::Error => e
  @logger.error("could not retrieve changes for: #{name}, url: #{url}, error: #{e}")
  raise
end

#copy(name, resource, map, options = {}) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/fpm/fry/client.rb', line 163

def copy(name, resource, map, options = {})
  ex = FPM::Fry::Tar::Extractor.new(logger: @logger)
  base = File.dirname(resource)
  read(name, resource) do | entry |
    file = File.join(base, entry.full_name).chomp('/')
    file = file.sub(%r"\A\./",'')
    to = map[file]
    next unless to
    @logger.debug("Copy",name: file, to: to)
    ex.extract_entry(to, entry, options)
  end
end

#create(image) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/fpm/fry/client.rb', line 189

def create(image)
  url = url('containers','create')
  res = agent.post(
    headers: { 'Content-Type' => 'application/json' },
    path: url,
    body: JSON.generate('Image' => image)
  )
  return JSON.parse(res.body)['Id']
rescue Excon::Error => e
  @logger.error("could not create image: #{image}, url: #{url}, error: #{e}")
  raise
end

#destroy(container) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/fpm/fry/client.rb', line 202

def destroy(container)
  return unless container
  url = self.url('containers', container)
  agent.delete(
    path: url,
    expects: [204]
  )
rescue Excon::Error => e
  @logger.error("could not destroy container: #{container}, url: #{url}, error: #{e}")
  raise
end

#link_target(name, resource) ⇒ String?

Gets the target of a symlink

Parameters:

  • name (String) —

    the container name

  • resource (String) —

    the file name

Returns:

  • (String) —

    target

  • (nil) —

    if resource is not a symlink



153
154
155
156
157
158
159
160
161
 
# File 'lib/fpm/fry/client.rb', line 153

def link_target(name, resource)
  read(name, resource) do |file|
    if file.header.typeflag == "2"
      return File.absolute_path(file.header.linkname,File.dirname(resource))
    end
    return nil
  end
  return nil
end

#pull(image) ⇒ Object 



185
186
187
 
# File 'lib/fpm/fry/client.rb', line 185

def pull(image)
  agent.post(path: url('images','create'), query: {'fromImage' => image})
end

#read(name, resource) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/fpm/fry/client.rb', line 88

def read(name, resource)
  return to_enum(:read, name, resource) unless block_given?
  url = nil
  res = begin
          if (server_version['ApiVersion'] < "1.20")
            url = self.url('containers', name, 'copy')
            agent.post(
              path: url,
              headers: { 'Content-Type' => 'application/json' },
              body: JSON.generate({'Resource' => resource}),
              expects: [200,404,500]
            )
          else
            url = self.url('containers', name, 'archive')
            agent.get(
              path: url,
              headers: { 'Content-Type' => 'application/json' },
              query: {:path => resource},
              expects: [200,404,500]
            )
          end
        rescue Excon::Error => e
          @logger.error("unexpected response when reading resource: url: #{url}, error: #{e}")
          raise
        end
  if [404,500].include? res.status
    body_message = Hash[JSON.load(res.body).map{|k,v| ["docker.#{k}",v] }] rescue {'docker.message' => res.body}
    body_message['docker.container'] = name
    if body_message['docker.message'] =~ /\ANo such container:/
      raise ContainerNotFound.new("container not found", body_message)
    end
    raise FileNotFound.new("file not found", {'path' => resource}.merge(body_message))
  end
  sio = StringIO.new(res.body)
  tar = FPM::Fry::Tar::Reader.new( sio )
  tar.each do |entry|
    yield entry
  end
end

#read_content(name, resource) ⇒ String

Gets the file contents while following symlinks

Parameters:

  • name (String) —

    the container name

  • resource (String) —

    the file name

Returns:

  • (String) —

    content

Raises:

  • (NotAFile) —

    when the file has no readable content

  • (FileNotFound) —

    when the file does not exist



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/fpm/fry/client.rb', line 135

def read_content(name, resource)
  read(name, resource) do |file|
    if file.header.typeflag == "2"
      return read_content(name, File.absolute_path(file.header.linkname,File.dirname(resource)))
    end
    if file.header.typeflag != "0"
      raise NotAFile.new("not a file", {'path' => resource})
    end
    return file.read
  end
end

#server_version ⇒ String

Returns docker server api version.

Returns:

  • (String) —

    docker server api version



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/fpm/fry/client.rb', line 57

def server_version
  @server_version ||=
    begin
      res = agent.get(
        expects: [200],
        path: '/version'
      )
      JSON.parse(res.body)
    rescue Excon::Error => e
      @logger.error("could not read server version: url: /version, errorr #{e}")
      raise
    end
end

#tls? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/fpm/fry/client.rb', line 80

def tls?
  tls.any?
end

#url(*path) ⇒ Object 



84
85
86
 
# File 'lib/fpm/fry/client.rb', line 84

def url(*path)
  ['', "v"+server_version['ApiVersion'], *path.compact].join('/')
end