Class: Bosh::Director::Config

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

Overview

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

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.base_dir ⇒ Object

Returns the value of attribute base_dir.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def base_dir
  @base_dir
end

.cloud_options ⇒ Object

Returns the value of attribute cloud_options.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def cloud_options
  @cloud_options
end

.config_server_url ⇒ Object (readonly)

Returns the value of attribute config_server_url.



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

def config_server_url
  @config_server_url
end

.current_job ⇒ Object

Returns the value of attribute current_job.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def current_job
  @current_job
end

.db ⇒ Object

Returns the value of attribute db.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def db
  @db
end

.db_config ⇒ Object (readonly)

Returns the value of attribute db_config.



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

def db_config
  @db_config
end

.default_ssh_options ⇒ Object

Returns the value of attribute default_ssh_options.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def default_ssh_options
  @default_ssh_options
end

.director_ips ⇒ Object (readonly)

Returns the value of attribute director_ips.



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

def director_ips
  @director_ips
end

.dns ⇒ Object

Returns the value of attribute dns.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def dns
  @dns
end

.dns_db ⇒ Object

Returns the value of attribute dns_db.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def dns_db
  @dns_db
end

.dns_domain_name ⇒ Object

Returns the value of attribute dns_domain_name.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def dns_domain_name
  @dns_domain_name
end

.enable_post_deploy ⇒ Object

Returns the value of attribute enable_post_deploy.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def enable_post_deploy
  @enable_post_deploy
end

.enable_snapshots ⇒ Object

Returns the value of attribute enable_snapshots.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def enable_snapshots
  @enable_snapshots
end

.encryption ⇒ Object

Returns the value of attribute encryption.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def encryption
  @encryption
end

.event_log ⇒ Object

Returns the value of attribute event_log.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def event_log
  @event_log
end

.fix_stateful_nodes ⇒ Object

Returns the value of attribute fix_stateful_nodes.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def fix_stateful_nodes
  @fix_stateful_nodes
end

.flush_arp ⇒ Object

Returns the value of attribute flush_arp.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def flush_arp
  @flush_arp
end

.generate_vm_passwords ⇒ Object

Returns the value of attribute generate_vm_passwords.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def generate_vm_passwords
  @generate_vm_passwords
end

.ignore_missing_gateway ⇒ Object (readonly)

Returns the value of attribute ignore_missing_gateway.



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

def ignore_missing_gateway
  @ignore_missing_gateway
end

.keep_unreachable_vms ⇒ Object

Returns the value of attribute keep_unreachable_vms.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def keep_unreachable_vms
  @keep_unreachable_vms
end

.logger ⇒ Object

Returns the value of attribute logger.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def logger
  @logger
end

.max_tasks ⇒ Object

Returns the value of attribute max_tasks.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def max_tasks
  @max_tasks
end

.max_threads ⇒ Object

Returns the value of attribute max_threads.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def max_threads
  @max_threads
end

.max_vm_create_tries ⇒ Object

Returns the value of attribute max_vm_create_tries.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def max_vm_create_tries
  @max_vm_create_tries
end

.name ⇒ Object

Returns the value of attribute name.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def name
  @name
end

.nats_uri ⇒ Object

Returns the value of attribute nats_uri.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def nats_uri
  @nats_uri
end

.parse_config_values ⇒ Object (readonly)

Returns the value of attribute parse_config_values.



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

def parse_config_values
  @parse_config_values
end

.process_uuid ⇒ Object

Returns the value of attribute process_uuid.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def process_uuid
  @process_uuid
end

.record_events ⇒ Object (readonly)

Returns the value of attribute record_events.



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

def record_events
  @record_events
end

.remove_dev_tools ⇒ Object

Returns the value of attribute remove_dev_tools.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def remove_dev_tools
  @remove_dev_tools
end

.result ⇒ Object

Returns the value of attribute result.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def result
  @result
end

.revision ⇒ Object

Returns the value of attribute revision.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def revision
  @revision
end

.task_checkpoint_interval ⇒ Object

Returns the value of attribute task_checkpoint_interval.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def task_checkpoint_interval
  @task_checkpoint_interval
end

.trusted_certs ⇒ Object

Returns the value of attribute trusted_certs.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def trusted_certs
  @trusted_certs
end

.uuid ⇒ Object

Returns the value of attribute uuid.



11
12
13
 
# File 'lib/bosh/director/config.rb', line 11

def uuid
  @uuid
end

Class Method Details

.clear ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/bosh/director/config.rb', line 55

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 



243
244
245
246
247
248
249
250
 
# File 'lib/bosh/director/config.rb', line 243

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

.cloud_type ⇒ Object 



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

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

.compiled_package_cache_blobstore ⇒ Object 



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

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 



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

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

.configure(config) ⇒ Object 



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/bosh/director/config.rb', line 75

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

  @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'))

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

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

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

  @revision = get_revision

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

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

  @default_ssh_options = config['default_ssh_options']

  @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']
  if @dns && @dns['db']
    @dns_db = configure_db(@dns['db'])
    if @dns_db
      # Load these constants early.
      # These constants are not 'require'd, they are 'autoload'ed
      # in models.rb. We're seeing that in 1.9.3 that sometimes
      # the constants loaded from one thread are not visible to other threads,
      # causing failures.
      # These constants cannot be required because they are Sequel model classes
      # that refer to database configuration that is only present when the (optional)
      # powerdns job is present and configured and points to a valid DB.
      # This is an attempt to make sure the constants are loaded
      # before forking off to other threads, hopefully eliminating the errors.
      Bosh::Director::Models::Dns::Record.class
      Bosh::Director::Models::Dns::Domain.class
    end
  end

  @dns_manager = DnsManagerProvider.create
  @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']

  @keep_unreachable_vms = config.fetch('keep_unreachable_vms', false)
  @enable_post_deploy = config.fetch('enable_post_deploy', false)
  @generate_vm_passwords = config.fetch('generate_vm_passwords', false)
  @remove_dev_tools = config['remove_dev_tools']
  @record_events = config.fetch('record_events', false)

  @enable_virtual_delete_vms = config.fetch('enable_virtual_delete_vms', false)

  @director_ips = Socket.ip_address_list.reject { |addr| !addr.ip? || !addr.ipv4? || addr.ipv4_loopback? || addr.ipv6_loopback? }.map { |addr| addr.ip_address }


  @parse_config_values = config.fetch('parse_config_values', false)
  if @parse_config_values
    @config_server_url = config['config_server_url']
  end

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

  @lock = Monitor.new
end

.configure_db(db_config) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/bosh/director/config.rb', line 199

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

  Sequel.default_timezone = :utc
  db = Sequel.connect(connection_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 



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

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

.director_pool ⇒ Object 



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

def director_pool
  @director_pool ||= Socket.gethostname
end

.encryption? ⇒ Boolean

Returns:

  • (Boolean) 


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

def encryption?
  @encryption
end

.generate_temp_dir ⇒ Object 



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

def generate_temp_dir
  temp_dir = Dir.mktmpdir
  ENV["TMPDIR"] = temp_dir
  FileUtils.mkdir_p(temp_dir)
  at_exit do
    begin
      if $!
        status = $!.is_a?(::SystemExit) ? $!.status : 1
      else
        status = 0
      end
      FileUtils.rm_rf(temp_dir)
    ensure
      exit status
    end
  end
  temp_dir
end

.get_revision ⇒ Object 



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

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) 


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

def job_cancelled?
  @current_job.task_checkpoint if @current_job
end

.load_file(path) ⇒ Object 



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

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

.load_hash(hash) ⇒ Object 



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

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

.log_dir ⇒ Object 



183
184
185
 
# File 'lib/bosh/director/config.rb', line 183

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

.nats_rpc ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/bosh/director/config.rb', line 273

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 



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

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 = JSON.parse(file.read) || {}

      # 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

.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) 


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

def use_compiled_package_cache?
  !@compiled_package_cache_options.nil?
end

Instance Method Details

#backup_blobstore_config ⇒ Object 



413
414
415
 
# File 'lib/bosh/director/config.rb', line 413

def backup_blobstore_config
  hash['backup_destination']
end

#blobstore_config ⇒ Object 



409
410
411
 
# File 'lib/bosh/director/config.rb', line 409

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

#db ⇒ Object 



405
406
407
 
# File 'lib/bosh/director/config.rb', line 405

def db
  Config.configure_db(hash['db'])
end

#director_pool ⇒ Object 



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

def director_pool
  Config.director_pool
end

#get_uuid_provider ⇒ Object 



429
430
431
 
# File 'lib/bosh/director/config.rb', line 429

def get_uuid_provider
  Bosh::Director::Api::DirectorUUIDProvider.new(Config)
end

#identity_provider ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/bosh/director/config.rb', line 368

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] || {})
  end
end

#log_access_events_to_syslog ⇒ Object 



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

def log_access_events_to_syslog
  hash['log_access_events_to_syslog']
end

#name ⇒ Object 



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

def name
  hash['name']
end

#port ⇒ Object 



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

def port
  hash['port']
end

#record_events ⇒ Object 



433
434
435
 
# File 'lib/bosh/director/config.rb', line 433

def record_events
  hash.fetch('record_events', false)
end

#scheduled_jobs ⇒ Object 



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

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

#worker_logger ⇒ Object 



392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/bosh/director/config.rb', line 392

def worker_logger
  logger = Logging::Logger.new('DirectorWorker')
  logging_config = hash.fetch('logging', {})
  worker_logging = hash.fetch('delayed_job', {}).fetch('logging', {})
  if worker_logging.has_key?('file')
    logger.add_appenders(Logging.appenders.file('DirectorWorkerFile', filename: worker_logging.fetch('file'), layout: ThreadFormatter.layout))
  else
    logger.add_appenders(Logging.appenders.stdout('DirectorWorkerIO', layout: ThreadFormatter.layout))
  end
  logger.level = Logging.levelify(logging_config.fetch('level', 'debug'))
  logger
end