Class: Bosh::Director::Config

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

Overview

We are in the slow painful process of extracting all of this class-level behavior into instance behavior, much of it on the App class. When this process is complete, the Config will be responsible only for maintaining configuration information - not holding the state of the world.

Constant Summary collapse

CONFIG_OPTIONS = 
[
  :base_dir,
  :cloud_options,
  :db,
  :dns,
  :dns_db,
  :dns_domain_name,
  :event_log,
  :logger,
  :max_tasks,
  :max_threads,
  :name,
  :process_uuid,
  :result,
  :revision,
  :task_checkpoint_interval,
  :uuid,
  :current_job,
  :encryption,
  :fix_stateful_nodes,
  :enable_snapshots,
  :max_vm_create_tries,
  :nats_uri,
]

Constants included from DnsHelper

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

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class 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, invalid_dns, reverse_domain, reverse_host, update_dns_a_record, update_dns_ptr_record

Class Attribute Details

.db_config ⇒ Object (readonly)

Returns the value of attribute db_config.



44
45
46
 
# File 'lib/bosh/director/config.rb', line 44

def db_config
  @db_config
end

.redis_logger_level ⇒ Object (readonly)

Returns the value of attribute redis_logger_level.



44
45
46
 
# File 'lib/bosh/director/config.rb', line 44

def redis_logger_level
  @redis_logger_level
end

Instance Attribute Details

#hash ⇒ Object (readonly)

Returns the value of attribute hash.



355
356
357
 
# File 'lib/bosh/director/config.rb', line 355

def hash
  @hash
end

Class Method Details

.clear ⇒ Object 



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

def clear
  CONFIG_OPTIONS.each do |option|
    self.instance_variable_set("@#{option}".to_sym, 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 



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

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

.cloud_options=(options) ⇒ Object 



237
238
239
240
241
242
 
# File 'lib/bosh/director/config.rb', line 237

def cloud_options=(options)
  @lock.synchronize do
    @cloud_options = options
    @cloud = nil
  end
end

.cloud_type ⇒ Object 



200
201
202
203
204
 
# File 'lib/bosh/director/config.rb', line 200

def cloud_type
  if @cloud_options
    @cloud_options['plugin']
  end
end

.compiled_package_cache_blobstore ⇒ Object 



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/bosh/director/config.rb', line 185

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 



196
197
198
 
# File 'lib/bosh/director/config.rb', line 196

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

.configure(config) ⇒ Object 



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
 
# File 'lib/bosh/director/config.rb', line 66

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)

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

  @lock = Monitor.new
end

.configure_db(db_config) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/bosh/director/config.rb', line 169

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)
  if logger
    db.logger = logger
    db.sql_log_level = :debug
  end

  db
end

.cpi_task_log ⇒ Object 



215
216
217
 
# File 'lib/bosh/director/config.rb', line 215

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

.dns_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


272
273
274
 
# File 'lib/bosh/director/config.rb', line 272

def dns_enabled?
  !@dns_db.nil?
end

.encryption? ⇒ Boolean

Returns:

  • (Boolean) 


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

def encryption?
  @encryption
end

.get_revision ⇒ Object 



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

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) 


219
220
221
 
# File 'lib/bosh/director/config.rb', line 219

def job_cancelled?
  @current_job.task_checkpoint if @current_job
end

.load_file(path) ⇒ Object 



346
347
348
 
# File 'lib/bosh/director/config.rb', line 346

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

.load_hash(hash) ⇒ Object 



350
351
352
 
# File 'lib/bosh/director/config.rb', line 350

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

.log_dir ⇒ Object 



153
154
155
 
# File 'lib/bosh/director/config.rb', line 153

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

.nats_rpc ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/bosh/director/config.rb', line 244

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 



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/bosh/director/config.rb', line 314

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

  if File.exists?(state_file)
    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)
  end

  new_uuid
end

.patch_sqlite ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/bosh/director/config.rb', line 284

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 



256
257
258
 
# File 'lib/bosh/director/config.rb', line 256

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

.redis? ⇒ Boolean

Returns:

  • (Boolean) 


268
269
270
 
# File 'lib/bosh/director/config.rb', line 268

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

.redis_logger=(logger) ⇒ Object 



260
261
262
263
264
265
266
 
# File 'lib/bosh/director/config.rb', line 260

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

.redis_options ⇒ Object 



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

def redis_options
  @redis_options ||= {}
end

.redis_options=(options) ⇒ Object 



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

def redis_options=(options)
  @redis_options = options
end

.threaded ⇒ Object 



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

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

.use_compiled_package_cache? ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
 
# File 'lib/bosh/director/config.rb', line 157

def use_compiled_package_cache?
  !@compiled_package_cache_options.nil?
end