Class: Bosh::Director::Config

Inherits:
Object
  • Object
show all
Extended by:
DnsHelper
Defined in:
lib/bosh/director/config.rb

Overview

We want to shift from class methods to instance methods here.

Constant Summary

Constants included from DnsHelper

DnsHelper::SOA, DnsHelper::TTL_4H, DnsHelper::TTL_5M

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DnsHelper

add_default_dns_server, canonical, default_dns_server, delete_dns_records, delete_empty_domain, dns_domain_name, dns_ns_record, dns_servers, flush_dns_cache, invalid_dns, reverse_domain, reverse_host, update_dns_a_record, update_dns_ptr_record

Class Attribute Details

.base_dir ⇒ Object

Returns the value of attribute base_dir.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def base_dir
  @base_dir
end

.cloud_options ⇒ Object

Returns the value of attribute cloud_options.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def cloud_options
  @cloud_options
end

.current_job ⇒ Object

Returns the value of attribute current_job.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def current_job
  @current_job
end

.db ⇒ Object

Returns the value of attribute db.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def db
  @db
end

.db_config ⇒ Object (readonly)

Returns the value of attribute db_config.



39
40
41
 
# File 'lib/bosh/director/config.rb', line 39

def db_config
  @db_config
end

.dns ⇒ Object

Returns the value of attribute dns.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def dns
  @dns
end

.dns_db ⇒ Object

Returns the value of attribute dns_db.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def dns_db
  @dns_db
end

.dns_domain_name ⇒ Object

Returns the value of attribute dns_domain_name.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def dns_domain_name
  @dns_domain_name
end

.enable_snapshots ⇒ Object

Returns the value of attribute enable_snapshots.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def enable_snapshots
  @enable_snapshots
end

.encryption ⇒ Object

Returns the value of attribute encryption.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def encryption
  @encryption
end

.event_log ⇒ Object

Returns the value of attribute event_log.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def event_log
  @event_log
end

.fix_stateful_nodes ⇒ Object

Returns the value of attribute fix_stateful_nodes.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def fix_stateful_nodes
  @fix_stateful_nodes
end

.ignore_missing_gateway ⇒ Object (readonly)

Returns the value of attribute ignore_missing_gateway.



39
40
41
 
# File 'lib/bosh/director/config.rb', line 39

def ignore_missing_gateway
  @ignore_missing_gateway
end

.logger ⇒ Object

Returns the value of attribute logger.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def logger
  @logger
end

.max_tasks ⇒ Object

Returns the value of attribute max_tasks.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def max_tasks
  @max_tasks
end

.max_threads ⇒ Object

Returns the value of attribute max_threads.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def max_threads
  @max_threads
end

.max_vm_create_tries ⇒ Object

Returns the value of attribute max_vm_create_tries.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def max_vm_create_tries
  @max_vm_create_tries
end

.name ⇒ Object

Returns the value of attribute name.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def name
  @name
end

.process_uuid ⇒ Object

Returns the value of attribute process_uuid.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def process_uuid
  @process_uuid
end

.redis_logger_level ⇒ Object (readonly)

Returns the value of attribute redis_logger_level.



39
40
41
 
# File 'lib/bosh/director/config.rb', line 39

def redis_logger_level
  @redis_logger_level
end

.result ⇒ Object

Returns the value of attribute result.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def result
  @result
end

.revision ⇒ Object

Returns the value of attribute revision.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def revision
  @revision
end

.task_checkpoint_interval ⇒ Object

Returns the value of attribute task_checkpoint_interval.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def task_checkpoint_interval
  @task_checkpoint_interval
end

.trusted_certs ⇒ Object

Returns the value of attribute trusted_certs.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def trusted_certs
  @trusted_certs
end

.uuid ⇒ Object

Returns the value of attribute uuid.



13
14
15
 
# File 'lib/bosh/director/config.rb', line 13

def uuid
  @uuid
end

Class Method Details

.clear ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/bosh/director/config.rb', line 45

def clear
  self.instance_variables.each do |ivar|
    self.instance_variable_set(ivar, nil)
  end

  Thread.list.each do |thr|
    thr[:bosh] = nil
  end

  @blobstore = nil

  @compiled_package_cache = nil
  @compiled_package_blobstore = nil
  @compiled_package_cache_options = nil

  @nats = nil
  @nats_rpc = nil
  @cloud = nil
end

.cloud ⇒ Object 



215
216
217
218
219
220
221
222
 
# File 'lib/bosh/director/config.rb', line 215

def cloud
  @lock.synchronize do
    if @cloud.nil?
      @cloud = Bosh::Clouds::Provider.create(@cloud_options, @uuid)
    end
  end
  @cloud
end

.cloud_type ⇒ Object 



209
210
211
212
213
 
# File 'lib/bosh/director/config.rb', line 209

def cloud_type
  if @cloud_options
    @cloud_options['plugin'] || @cloud_options['provider']['name']
  end
end

.compiled_package_cache_blobstore ⇒ Object 



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/bosh/director/config.rb', line 194

def compiled_package_cache_blobstore
  @lock.synchronize do
    if @compiled_package_cache_blobstore.nil? && use_compiled_package_cache?
      provider = @compiled_package_cache_options['provider']
      options = @compiled_package_cache_options['options']
      @compiled_package_cache_blobstore = Bosh::Blobstore::Client.safe_create(provider, options)
    end
  end
  @compiled_package_cache_blobstore
end

.compiled_package_cache_provider ⇒ Object 



205
206
207
 
# File 'lib/bosh/director/config.rb', line 205

def compiled_package_cache_provider
  use_compiled_package_cache? ? @compiled_package_cache_options['provider'] : nil
end

.configure(config) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/bosh/director/config.rb', line 65

def configure(config)
  @max_vm_create_tries = Integer(config.fetch('max_vm_create_tries', 5))

  @base_dir = config['dir']
  FileUtils.mkdir_p(@base_dir)

  # checkpoint task progress every 30 secs
  @task_checkpoint_interval = 30

  logging_config = config.fetch('logging', {})
  if logging_config.has_key?('file')
    @log_file_path = logging_config.fetch('file')
    shared_appender = Logging.appenders.file(
      'DirectorLogFile',
      filename: @log_file_path,
      layout: ThreadFormatter.layout
    )
  else
    shared_appender = Logging.appenders.io(
      'DirectorStdOut',
      STDOUT,
      layout: ThreadFormatter.layout
    )
  end

  @logger = Logging::Logger.new('Director')
  @logger.add_appenders(shared_appender)
  @logger.level = Logging.levelify(logging_config.fetch('level', 'debug'))

  # use a separate logger with the same appender to avoid multiple file writers
  redis_logger = Logging::Logger.new('DirectorRedis')
  redis_logger.add_appenders(shared_appender)
  logging_config = config.fetch('redis', {}).fetch('logging', {})
  @redis_logger_level = Logging.levelify(logging_config.fetch('level', 'info'))
  redis_logger.level = @redis_logger_level

  # Event logger supposed to be overridden per task,
  # the default one does nothing
  @event_log = EventLog::Log.new

  # by default keep only last 500 tasks in disk
  @max_tasks = config.fetch('max_tasks', 500).to_i

  @max_threads = config.fetch('max_threads', 32).to_i

  self.redis_options = {
    :host     => config['redis']['host'],
    :port     => config['redis']['port'],
    :password => config['redis']['password'],
    :logger   => redis_logger
  }

  @revision = get_revision

  @logger.info("Starting BOSH Director: #{VERSION} (#{@revision})")

  @process_uuid = SecureRandom.uuid
  @nats_uri = config['mbus']

  @cloud_options = config['cloud']
  @compiled_package_cache_options = config['compiled_package_cache']
  @name = config['name'] || ''

  @compiled_package_cache = nil

  @db_config = config['db']
  @db = configure_db(config['db'])
  @dns = config['dns']
  @dns_domain_name = 'bosh'
  if @dns
    @dns_db = configure_db(@dns['db']) if @dns['db']
    @dns_domain_name = canonical(@dns['domain_name']) if @dns['domain_name']
  end

  @uuid = override_uuid || Bosh::Director::Models::DirectorAttribute.find_or_create_uuid(@logger)
  @logger.info("Director UUID: #{@uuid}")

  @encryption = config['encryption']
  @fix_stateful_nodes = config.fetch('scan_and_fix', {})
    .fetch('auto_fix_stateful_nodes', false)
  @enable_snapshots = config.fetch('snapshots', {}).fetch('enabled', false)

  @trusted_certs = config['trusted_certs'] || ''
  @ignore_missing_gateway = config['ignore_missing_gateway']

  Bosh::Clouds::Config.configure(self)

  @lock = Monitor.new
end

.configure_db(db_config) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/bosh/director/config.rb', line 171

def configure_db(db_config)
  patch_sqlite if db_config['adapter'] == 'sqlite'

  connection_options = db_config.delete('connection_options') {{}}
  db_config.delete_if { |_, v| v.to_s.empty? }
  db_config = db_config.merge(connection_options)

  db = Sequel.connect(db_config)

  Bosh::Common.retryable(sleep: 0.5, tries: 20, on: [Exception]) do
    db.extension :connection_validator
    true
  end

  db.pool.connection_validation_timeout = -1
  if logger
    db.logger = logger
    db.sql_log_level = :debug
  end

  db
end

.cpi_task_log ⇒ Object 



224
225
226
 
# File 'lib/bosh/director/config.rb', line 224

def cpi_task_log
  Config.cloud_options.fetch('properties', {}).fetch('cpi_log')
end

.dns_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


281
282
283
 
# File 'lib/bosh/director/config.rb', line 281

def dns_enabled?
  !@dns_db.nil?
end

.encryption? ⇒ Boolean

Returns:

  • (Boolean) 


285
286
287
 
# File 'lib/bosh/director/config.rb', line 285

def encryption?
  @encryption
end

.get_revision ⇒ Object 



163
164
165
166
167
168
169
 
# File 'lib/bosh/director/config.rb', line 163

def get_revision
  Dir.chdir(File.expand_path('../../../../../..', __FILE__))
  revision_command = '(cat REVISION 2> /dev/null || ' +
      'git show-ref --head --hash=8 2> /dev/null || ' +
      'echo 00000000) | head -n1'
  `#{revision_command}`.strip
end

.job_cancelled? ⇒ Boolean Also known as: task_checkpoint

Returns:

  • (Boolean) 


228
229
230
 
# File 'lib/bosh/director/config.rb', line 228

def job_cancelled?
  @current_job.task_checkpoint if @current_job
end

.load_file(path) ⇒ Object 



360
361
362
 
# File 'lib/bosh/director/config.rb', line 360

def load_file(path)
  Config.new(Psych.load_file(path))
end

.load_hash(hash) ⇒ Object 



364
365
366
 
# File 'lib/bosh/director/config.rb', line 364

def load_hash(hash)
  Config.new(hash)
end

.log_dir ⇒ Object 



155
156
157
 
# File 'lib/bosh/director/config.rb', line 155

def log_dir
  File.dirname(@log_file_path) if @log_file_path
end

.nats_rpc ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/bosh/director/config.rb', line 253

def nats_rpc
  # double-check locking to reduce synchronization
  if @nats_rpc.nil?
    @lock.synchronize do
      if @nats_rpc.nil?
        @nats_rpc = NatsRpc.new(@nats_uri)
      end
    end
  end
  @nats_rpc
end

.override_uuid ⇒ Object

Migrates director UUID to database Currently used by integration tests to set director UUID



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/bosh/director/config.rb', line 325

def override_uuid
  new_uuid = nil
  state_file = File.join(base_dir, 'state.json')

  begin
    open(state_file, 'r+') do |file|

      # Lock before read to avoid director/worker race condition
      file.flock(File::LOCK_EX)
      state = Yajl::Parser.parse(file) || {}

      # Empty state file to prevent blocked processes from attempting to set UUID
      file.truncate(0)

      if state['uuid']
        Bosh::Director::Models::DirectorAttribute.update_or_create_uuid(state['uuid'], @logger)
        @logger.info("Using director UUID #{state['uuid']} from #{state_file}")
        new_uuid = state['uuid']
      end

      # Unlock after storing UUID
      file.flock(File::LOCK_UN)
    end

    FileUtils.rm_f(state_file)

  rescue Errno::ENOENT
    # Catch race condition since another process (director/worker) might migrated the state
  end

  new_uuid
end

.patch_sqlite ⇒ Object 



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/bosh/director/config.rb', line 293

def patch_sqlite
  return if @patched_sqlite
  @patched_sqlite = true

  require 'sequel'
  require 'sequel/adapters/sqlite'

  Sequel::SQLite::Database.class_eval do
    def connect(server)
      opts = server_opts(server)
      opts[:database] = ':memory:' if blank_object?(opts[:database])
      db = ::SQLite3::Database.new(opts[:database])
      db.busy_handler do |retries|
        Bosh::Director::Config.logger.debug "SQLITE BUSY, retry ##{retries}"
        sleep(0.1)
        retries < 20
      end

      connection_pragmas.each { |s| log_yield(s) { db.execute_batch(s) } }

      class << db
        attr_reader :prepared_statements
      end
      db.instance_variable_set(:@prepared_statements, {})

      db
    end
  end
end

.redis ⇒ Object 



265
266
267
 
# File 'lib/bosh/director/config.rb', line 265

def redis
  threaded[:redis] ||= Redis.new(redis_options)
end

.redis? ⇒ Boolean

Returns:

  • (Boolean) 


277
278
279
 
# File 'lib/bosh/director/config.rb', line 277

def redis?
  !threaded[:redis].nil?
end

.redis_logger=(logger) ⇒ Object 



269
270
271
272
273
274
275
 
# File 'lib/bosh/director/config.rb', line 269

def redis_logger=(logger)
  if redis?
    redis.client.logger = logger
  else
    redis_options[:logger] = logger
  end
end

.redis_options ⇒ Object 



234
235
236
 
# File 'lib/bosh/director/config.rb', line 234

def redis_options
  @redis_options ||= {}
end

.redis_options=(options) ⇒ Object 



242
243
244
 
# File 'lib/bosh/director/config.rb', line 242

def redis_options=(options)
  @redis_options = options
end

.threaded ⇒ Object 



289
290
291
 
# File 'lib/bosh/director/config.rb', line 289

def threaded
  Thread.current[:bosh] ||= {}
end

.use_compiled_package_cache? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/bosh/director/config.rb', line 159

def use_compiled_package_cache?
  !@compiled_package_cache_options.nil?
end

Instance Method Details

#backup_blobstore_config ⇒ Object 



421
422
423
 
# File 'lib/bosh/director/config.rb', line 421

def backup_blobstore_config
  hash['backup_destination']
end

#blobstore_config ⇒ Object 



417
418
419
 
# File 'lib/bosh/director/config.rb', line 417

def blobstore_config
  hash.fetch('blobstore')
end

#configure_evil_config_singleton! ⇒ Object 



425
426
427
 
# File 'lib/bosh/director/config.rb', line 425

def configure_evil_config_singleton!
  Config.configure(hash)
end

#identity_provider ⇒ Object 



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/bosh/director/config.rb', line 381

def identity_provider
  @identity_provider ||= begin
    # no fetching w defaults?
    user_management = hash['user_management']
    user_management ||= {'provider' => 'local'}
    provider_name = user_management['provider']

    providers = {
      'uaa' => Bosh::Director::Api::UAAIdentityProvider,
      'local' => Bosh::Director::Api::LocalIdentityProvider,
    }
    provider_class = providers[provider_name]

    if provider_class.nil?
      raise ArgumentError,
        "Unknown user management provider '#{provider_name}', " +
          "available providers are: #{providers.keys.join(", ")}"
    end

    Config.logger.debug("Director configured with '#{provider_name}' user management provider")
    provider_class.new(user_management[provider_name] || {}, Bosh::Director::Api::DirectorUUIDProvider.new(Config))
  end
end

#name ⇒ Object 



369
370
371
 
# File 'lib/bosh/director/config.rb', line 369

def name
  hash['name']
end

#port ⇒ Object 



373
374
375
 
# File 'lib/bosh/director/config.rb', line 373

def port
  hash['port']
end

#resque_logger ⇒ Object 



405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/bosh/director/config.rb', line 405

def resque_logger
  logger = Logging::Logger.new('DirectorWorker')
  resque_logging = hash.fetch('resque', {}).fetch('logging', {})
  if resque_logging.has_key?('file')
    logger.add_appenders(Logging.appenders.file('DirectorWorkerFile', filename: resque_logging.fetch('file'), layout: ThreadFormatter.layout))
  else
    logger.add_appenders(Logging.appenders.stdout('DirectorWorkerIO', layout: ThreadFormatter.layout))
  end
  logger.level = Logging.levelify(resque_logging.fetch('level', 'info'))
  logger
end

#scheduled_jobs ⇒ Object 



377
378
379
 
# File 'lib/bosh/director/config.rb', line 377

def scheduled_jobs
  hash['scheduled_jobs'] || []
end