Module: Indocker

Defined in:
lib/indocker.rb,
lib/indocker/version.rb

Defined Under Namespace

Modules: Artifacts, Concerns, Configurations, Containers, EnvFiles, Images, Registries, Repositories, Volumes Classes: BuildContext, BuildContextHelper, BuildContextPool, BuildServer, ConfigurationDeployer, ContainerDeployer, ContainerHelper, ContainerRunner, ContextArgs, CrontabRedeployRulesBuilder, DeployContext, DeploymentChecker, DeploymentProgress, Docker, DockerRunArgs, EnvFileHelper, HashMerger, ImagesCompiler, IndockerHelper, Network, NetworkHelper, Rsync, Server, ServerPool, Shell, SshResultLogger, SshSession, VolumeHelper

Constant Summary collapse

VERSION = 
"0.1.7"

Class Method Summary collapse

Class Method Details

.add_artifact(artifact) ⇒ Object 



134
135
136
 
# File 'lib/indocker.rb', line 134

def add_artifact(artifact)
  artifacts.push(artifact)
end

.add_build_server(build_server) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/indocker.rb', line 217

def add_build_server(build_server)
  if !build_server.is_a?(Indocker::BuildServer)
    raise ArgumentError.new("should be an instance of Indocker::BuildServer, got: #{build_server.inspect}")
  end

  existing = build_servers.detect {|s| s == build_server}

  if existing
    raise ArgumentError.new("build server with name #{build_server.name} was already defined")
  end

  build_servers.push(build_server)
end

.add_registry(registry) ⇒ Object 



146
147
148
149
150
151
152
 
# File 'lib/indocker.rb', line 146

def add_registry(registry)
  if !registry.is_a?(Indocker::Registries::Abstract)
    raise ArgumentError.new("should be an instance of Indocker::Registries::Abstract, got: #{registry.inspect}")
  end

  registries.push(registry)
end

.add_repository(repository) ⇒ Object 



138
139
140
141
142
143
144
 
# File 'lib/indocker.rb', line 138

def add_repository(repository)
  if !repository.is_a?(Indocker::Repositories::Abstract)
    raise ArgumentError.new("should be an instance of Indocker::Repositories::Abstract, got: #{repository.inspect}")
  end

  repositories.push(repository)
end

.add_server(server) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/indocker.rb', line 154

def add_server(server)
  if !server.is_a?(Indocker::Server)
    raise ArgumentError.new("should be an instance of Indocker::Server, got: #{server.inspect}")
  end

  existing = servers.detect {|s| s == server}

  if existing
    raise ArgumentError.new("server with name #{server.name} was already defined")
  end

  servers.push(server)
end

.artifacts ⇒ Object 



251
252
253
 
# File 'lib/indocker.rb', line 251

def artifacts
  @artifacts ||= []
end

.build_configuration(name) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/indocker.rb', line 275

def build_configuration(name)
  builder = Indocker::Configurations::ConfigurationBuilder.new(
    name: name,
    repositories: repositories,
    registries: registries,
    servers: servers,
    build_servers: build_servers,
    volumes: volumes,
    networks: networks,
    env_files: env_files,
    containers: containers,
  )

  @configuration = builder.configuration
  builder
end

.build_helper(&proc) ⇒ Object 



450
451
452
 
# File 'lib/indocker.rb', line 450

def build_helper(&proc)
  Indocker::BuildContextHelper.class_exec(&proc)
end

.build_servers ⇒ Object 



255
256
257
 
# File 'lib/indocker.rb', line 255

def build_servers
  @build_servers ||= []
end

.check(servers: []) ⇒ Object 



340
341
342
343
344
345
346
347
 
# File 'lib/indocker.rb', line 340

def check(servers: [])
  Indocker::DeploymentChecker
    .new(Indocker.logger)
    .run(
      configuration: configuration,
      servers: servers,
    )
end

.compile(images:, skip_dependent:) ⇒ Object 



360
361
362
363
364
365
366
367
368
 
# File 'lib/indocker.rb', line 360

def compile(images:, skip_dependent:)
  Indocker::ImagesCompiler
    .new(Indocker.logger)
    .compile(
      configuration: configuration,
      image_list: images,
      skip_dependent: skip_dependent,
    )
end

.configuration ⇒ Object 



263
264
265
 
# File 'lib/indocker.rb', line 263

def configuration
  @configuration || (raise ArgumentError.new("no configuration provided"))
end

.configuration_name ⇒ Object 



458
459
460
 
# File 'lib/indocker.rb', line 458

def configuration_name
  @configuration_name || (raise ArgumentError.new("configuration was not specified"))
end

.container_files ⇒ Object 



176
177
178
 
# File 'lib/indocker.rb', line 176

def container_files
  @container_files || (raise ArgumentError.new("container files were not found. Set bounded contexts dir"))
end

.containers ⇒ Object 



271
272
273
 
# File 'lib/indocker.rb', line 271

def containers
  @containers ||= []
end

.define_container(name) ⇒ Object 



311
312
313
314
315
316
317
318
319
 
# File 'lib/indocker.rb', line 311

def define_container(name)
  builder = Indocker::Containers::ContainerBuilder.new(
    name: name,
    configuration: configuration,
  )

  containers.push(builder.container)
  builder
end

.define_env_file(env_file) ⇒ Object 



200
201
202
203
204
205
206
207
 
# File 'lib/indocker.rb', line 200

def define_env_file(env_file)
  if env_files.detect {|ef| ef.name == env_file.name}
    Indocker.logger.error("env file :#{env_file.name} was already defined")
    exit 1
  end

  env_files.push(env_file)
end

.define_image(name) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/indocker.rb', line 292

def define_image(name)
  path = caller[0].split(':').first

  if !(path =~ /\/image.rb$/)
    Indocker.logger.error("image :#{name} should be defined in image.rb file")
    exit 1
  end

  builder = Indocker::Images::ImageBuilder.new(
    name: name,
    configuration: configuration,
    dir: path.split('image.rb').first
  )

  images.push(builder.image)

  builder
end

.define_network(name) ⇒ Object 



168
169
170
171
172
173
174
 
# File 'lib/indocker.rb', line 168

def define_network(name)
  if networks.detect {|n| n.name == name}
    raise ArgumentError.new("network :#{name} was already defined")
  end

  networks.push(Indocker::Network.new(name))
end

.define_volume(volume) ⇒ Object 



209
210
211
212
213
214
215
 
# File 'lib/indocker.rb', line 209

def define_volume(volume)
  if volumes.detect { |v| v.name == volume.name}
    raise ArgumentError.new("volume :#{volume.name} was already defined")
  end

  volumes.push(volume)
end

.deploy(containers: [], skip_tags: [], tags: [], skip_dependent: false, skip_containers: [], servers: [], skip_build: false, force_restart: false, skip_force_restart: [], auto_confirm: false, require_confirmation: false) ⇒ Object 



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/indocker.rb', line 321

def deploy(containers: [], skip_tags: [], tags: [], skip_dependent: false, skip_containers: [], servers: [], skip_build: false, force_restart: false, skip_force_restart: [], auto_confirm: false, require_confirmation: false)
  Indocker::ConfigurationDeployer
    .new(Indocker.logger)
    .run(
      configuration: configuration,
      deploy_containers: containers,
      deploy_tags: tags,
      skip_dependent: skip_dependent,
      skip_containers: skip_containers,
      servers: servers,
      skip_build: skip_build,
      force_restart: force_restart,
      skip_tags: skip_tags,
      skip_force_restart: skip_force_restart,
      auto_confirm: auto_confirm,
      require_confirmation: require_confirmation,
    )
end

.deploy_dir ⇒ Object 



118
119
120
121
122
123
124
 
# File 'lib/indocker.rb', line 118

def deploy_dir
  if @deploy_dir
    @deploy_dir
  else
    raise ArgumentError.new("deploy dir was not specified")
  end
end

.dockerignore ⇒ Object 



446
447
448
 
# File 'lib/indocker.rb', line 446

def dockerignore
  @dockerignore || []
end

.env_files ⇒ Object 



259
260
261
 
# File 'lib/indocker.rb', line 259

def env_files
  @env_files ||= []
end

.export_command ⇒ Object 



98
99
100
 
# File 'lib/indocker.rb', line 98

def export_command
  @export_command
end

.global_build_args ⇒ Object 



380
381
382
 
# File 'lib/indocker.rb', line 380

def global_build_args
  Indocker::ContextArgs.new(nil, configuration.global_build_args, nil)
end

.helper ⇒ Object 



384
385
386
 
# File 'lib/indocker.rb', line 384

def helper
  Indocker::BuildContextHelper.new(Indocker.configuration, nil)
end

.image_files ⇒ Object 



180
181
182
 
# File 'lib/indocker.rb', line 180

def image_files
  @image_files || (raise ArgumentError.new("image files were not found. Set bounded contexts dir"))
end

.images ⇒ Object 



267
268
269
 
# File 'lib/indocker.rb', line 267

def images
  @images ||= []
end

.launched?(contaner_name, servers: []) ⇒ Boolean

Returns:

  • (Boolean) 


349
350
351
352
353
354
355
356
357
358
 
# File 'lib/indocker.rb', line 349

def launched?(contaner_name, servers: [])
  silent_logger = Logger.new(File.open(File::NULL, "w"))
  Indocker::DeploymentChecker
    .new(silent_logger, silent_logger)
    .launched?(
      contaner_name,
      configuration: configuration,
      servers: servers,
    )
end

.logger ⇒ Object 



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/indocker.rb', line 388

def logger
  @logger ||= begin
    logger = if @log_level == Logger::DEBUG
      Logger.new(STDOUT)
    else
      Logger.new(File.open(File::NULL, "w"))
    end

    logger.level = @log_level || Logger::INFO

    logger.formatter = proc do |severity, datetime, progname, msg|
      level = Logger::SEV_LABEL.index(severity)

      severity = case level
      when Logger::INFO
        severity.green
      when Logger::WARN
        severity.purple
      when Logger::DEBUG
        severity.yellow
      when Logger::ERROR
        severity.red
      when Logger::FATAL
        severity.red
      else
        severity
      end

      severity = severity.downcase

      if logger.debug?
        if msg == "{timestamp}"
          ""
        else
          "#{datetime.strftime("%Y/%m/%d %H:%M:%S")} #{severity}: #{msg}\n"
        end
      else
        # Use a nicer logging for not debug
        if msg == "{timestamp}"
          datetime.strftime("%Y/%m/%d %H:%M:%S\n").grey
        else
          "  #{severity}: #{msg}\n"
        end
      end
    end

    logger
  end
end

.networks ⇒ Object 



239
240
241
 
# File 'lib/indocker.rb', line 239

def networks
  @networks ||= []
end

.redeploy_crontab_path ⇒ Object 



114
115
116
 
# File 'lib/indocker.rb', line 114

def redeploy_crontab_path
  @redeploy_crontab_path
end

.registries ⇒ Object 



235
236
237
 
# File 'lib/indocker.rb', line 235

def registries
  @registries ||= []
end

.repositories ⇒ Object 



231
232
233
 
# File 'lib/indocker.rb', line 231

def repositories
  @repositories ||= []
end

.root_dir ⇒ Object 



126
127
128
129
130
131
132
 
# File 'lib/indocker.rb', line 126

def root_dir
  if @root_dir
    File.expand_path(@root_dir)
  else
    raise ArgumentError.new("root dir was not specified")
  end
end

.run(container_name, force_restart) ⇒ Object 



370
371
372
373
374
375
376
377
378
 
# File 'lib/indocker.rb', line 370

def run(container_name, force_restart)
  Indocker::ContainerRunner
    .new(Indocker.logger)
    .run(
      configuration: configuration,
      container_name: container_name,
      force_restart: force_restart
    )
end

.servers ⇒ Object 



247
248
249
 
# File 'lib/indocker.rb', line 247

def servers
  @servers ||= []
end

.set_bounded_contexts_dir(path) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/indocker.rb', line 184

def set_bounded_contexts_dir(path)
  @container_files = {}

  Dir[File.join(path, '**/container.rb')].map do |path|
    name = path.gsub('/container.rb', '').split('/').last.to_sym
    @container_files[name] = path
  end

  @image_files = {}

  Dir[File.join(path, '**/image.rb')].map do |path|
    name = path.gsub('/image.rb', '').split('/').last.to_sym
    @image_files[name] = path
  end
end

.set_configuration_name(name) ⇒ Object 



454
455
456
 
# File 'lib/indocker.rb', line 454

def set_configuration_name(name)
  @configuration_name = name
end

.set_deploy_dir(val) ⇒ Object 



102
103
104
 
# File 'lib/indocker.rb', line 102

def set_deploy_dir(val)
  @deploy_dir = val
end

.set_dockerignore(ignore_list) ⇒ Object 



442
443
444
 
# File 'lib/indocker.rb', line 442

def set_dockerignore(ignore_list)
  @dockerignore = ignore_list
end

.set_export_command(command) ⇒ Object 



94
95
96
 
# File 'lib/indocker.rb', line 94

def set_export_command(command)
  @export_command = command
end

.set_log_level(level) ⇒ Object 



438
439
440
 
# File 'lib/indocker.rb', line 438

def set_log_level(level)
  @log_level = level
end

.set_redeploy_crontab_path(val) ⇒ Object 



110
111
112
 
# File 'lib/indocker.rb', line 110

def set_redeploy_crontab_path(val)
  @redeploy_crontab_path = val
end

.set_root_dir(val) ⇒ Object 



106
107
108
 
# File 'lib/indocker.rb', line 106

def set_root_dir(val)
  @root_dir = val
end

.volumes ⇒ Object 



243
244
245
 
# File 'lib/indocker.rb', line 243

def volumes
  @volumes ||= []
end