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,
]

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

Instance Attribute Details

#hash ⇒ Object (readonly)

Returns the value of attribute hash.



340
341
342
 
# File 'lib/bosh/director/config.rb', line 340

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 



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/bosh/director/config.rb', line 191

def cloud
  @lock.synchronize do
    if @cloud.nil?
      plugin = @cloud_options['plugin']
      properties = @cloud_options['properties']
      @cloud = Bosh::Clouds::Provider.create(plugin, properties)
    end
  end
  @cloud
end

.cloud_options=(options) ⇒ Object 



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

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

.cloud_type ⇒ Object 



185
186
187
188
189
 
# File 'lib/bosh/director/config.rb', line 185

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

.compiled_package_cache_blobstore ⇒ Object 



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

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 



181
182
183
 
# File 'lib/bosh/director/config.rb', line 181

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
 
# 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.fetch('logging', {})
  @log_device = Logger::LogDevice.new(logging.fetch('file', STDOUT))
  @logger = Logger.new(@log_device)
  @logger.level = Logger.const_get(logging.fetch('level', 'debug').upcase)
  @logger.formatter = ThreadFormatter.new

  # use a separate logger for redis to make it stfu
  redis_logger = Logger.new(@log_device)
  logging = config.fetch('redis', {}).fetch('logging', {})
  redis_logger_level = logging.fetch('level', 'info').upcase
  redis_logger.level = Logger.const_get(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 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/bosh/director/config.rb', line 154

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

.dns_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


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

def dns_enabled?
  !@dns_db.nil?
end

.encryption? ⇒ Boolean

Returns:

  • (Boolean) 


261
262
263
 
# File 'lib/bosh/director/config.rb', line 261

def encryption?
  @encryption
end

.get_revision ⇒ Object 



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

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) 


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

def job_cancelled?
  @current_job.task_checkpoint if @current_job
end

.load_file(path) ⇒ Object 



331
332
333
 
# File 'lib/bosh/director/config.rb', line 331

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

.load_hash(hash) ⇒ Object 



335
336
337
 
# File 'lib/bosh/director/config.rb', line 335

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

.log_dir ⇒ Object 



138
139
140
 
# File 'lib/bosh/director/config.rb', line 138

def log_dir
  File.dirname(@log_device.filename) if @log_device.filename
end

.logger=(logger) ⇒ Object 



202
203
204
205
206
207
208
 
# File 'lib/bosh/director/config.rb', line 202

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

.nats ⇒ Object 



231
232
233
234
235
236
237
238
 
# File 'lib/bosh/director/config.rb', line 231

def nats
  @lock.synchronize do
    if @nats.nil?
      @nats = NATS.connect(:uri => @nats_uri, :autostart => false)
    end
  end
  @nats
end

.nats_rpc ⇒ Object 



240
241
242
243
244
245
246
247
 
# File 'lib/bosh/director/config.rb', line 240

def nats_rpc
  @lock.synchronize do
    if @nats_rpc.nil?
      @nats_rpc = NatsRpc.new
    end
  end
  @nats_rpc
end

.override_uuid ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/bosh/director/config.rb', line 299

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 



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/bosh/director/config.rb', line 269

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 



249
250
251
 
# File 'lib/bosh/director/config.rb', line 249

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

.redis? ⇒ Boolean

Returns:

  • (Boolean) 


253
254
255
 
# File 'lib/bosh/director/config.rb', line 253

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

.redis_options ⇒ Object 



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

def redis_options
  @redis_options ||= {}
end

.redis_options=(options) ⇒ Object 



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

def redis_options=(options)
  @redis_options = options
end

.threaded ⇒ Object 



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

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

.use_compiled_package_cache? ⇒ Boolean

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/bosh/director/config.rb', line 142

def use_compiled_package_cache?
  !@compiled_package_cache_options.nil?
end