class Omnibus::Config

Global configuration object for Omnibus runs.

@todo Write a {yardoc.org/guides/extending-yard/writing-handlers.html

Yard handler} for Mixlib::Config-style DSL methods.  I'd like
the default value to show up in the docs without having to type
it out twice, which I'm doing now for benefit of viewers of the Yard docs.

Public Class Methods

valid_s3_config?() click to toggle source

@raise [InvalidS3Configuration]

# File lib/omnibus/config.rb, line 213
def self.valid_s3_config?
  if use_s3_caching
    unless s3_bucket
      raise InvalidS3Configuration.new(s3_bucket, s3_access_key, s3_secret_key)
    end
  end
end
validate() click to toggle source

Asserts that the Config object is in a valid state. If invalid for any reason, an exception will be thrown.

@raise [RuntimeError] @return [void]

# File lib/omnibus/config.rb, line 207
def self.validate
  valid_s3_config?
  # add other validation methods as needed
end