Module: Vmpooler

Defined in:
lib/vmpooler.rb,
lib/vmpooler/api.rb,
lib/vmpooler/api/v1.rb,
lib/vmpooler/logger.rb,
lib/vmpooler/statsd.rb,
lib/vmpooler/version.rb,
lib/vmpooler/graphite.rb,
lib/vmpooler/dashboard.rb,
lib/vmpooler/providers.rb,
lib/vmpooler/api/helpers.rb,
lib/vmpooler/api/reroute.rb,
lib/vmpooler/dummy_statsd.rb,
lib/vmpooler/pool_manager.rb,
lib/vmpooler/api/dashboard.rb,
lib/vmpooler/providers/base.rb,
lib/vmpooler/providers/dummy.rb,
lib/vmpooler/providers/vsphere.rb,
lib/vmpooler/generic_connection_pool.rb

Defined Under Namespace

Classes: API, Dashboard, DummyStatsd, Graphite, Logger, PoolManager, Providers, Statsd

Constant Summary collapse

VERSION = 
'0.7.2'.freeze

Class Method Summary collapse

Class Method Details

.config(filepath = 'vmpooler.yaml') ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
 
# File 'lib/vmpooler.rb', line 19

def self.config(filepath = 'vmpooler.yaml')
  # Take the config either from an ENV config variable or from a config file
  if ENV['VMPOOLER_CONFIG']
    config_string = ENV['VMPOOLER_CONFIG']
    # Parse the YAML config into a Hash
    # Whitelist the Symbol class
    parsed_config = YAML.safe_load(config_string, [Symbol])
  else
    # Take the name of the config file either from an ENV variable or from the filepath argument
    config_file = ENV['VMPOOLER_CONFIG_FILE'] || filepath
    parsed_config = YAML.load_file(config_file) if File.exist? config_file
  end

  parsed_config ||= { config: {} }

  # Bail out if someone attempts to start vmpooler with dummy authentication
  # without enbaling debug mode.
  if parsed_config.has_key? :auth
    if parsed_config[:auth]['provider'] == 'dummy'
      unless ENV['VMPOOLER_DEBUG']
        warning = [
          'Dummy authentication should not be used outside of debug mode',
          'please set environment variable VMPOOLER_DEBUG to \'true\' if you want to use dummy authentication'
        ]

        raise warning.join(";\s")
      end
    end
  end

  # Set some configuration defaults
  parsed_config[:config]['task_limit'] = string_to_int(ENV['TASK_LIMIT']) || parsed_config[:config]['task_limit'] || 10
  parsed_config[:config]['migration_limit'] = string_to_int(ENV['MIGRATION_LIMIT']) if ENV['MIGRATION_LIMIT']
  parsed_config[:config]['vm_checktime'] = string_to_int(ENV['VM_CHECKTIME']) || parsed_config[:config]['vm_checktime'] || 1
  parsed_config[:config]['vm_lifetime'] = string_to_int(ENV['VM_LIFETIME']) || parsed_config[:config]['vm_lifetime']  || 24
  parsed_config[:config]['prefix'] = ENV['PREFIX'] || parsed_config[:config]['prefix'] || ''

  parsed_config[:config]['logfile'] = ENV['LOGFILE'] if ENV['LOGFILE']

  parsed_config[:config]['site_name'] = ENV['SITE_NAME'] if ENV['SITE_NAME']
  parsed_config[:config]['domain'] = ENV['DOMAIN'] if ENV['DOMAIN']
  parsed_config[:config]['clone_target'] = ENV['CLONE_TARGET'] if ENV['CLONE_TARGET']
  parsed_config[:config]['timeout'] = string_to_int(ENV['TIMEOUT']) if ENV['TIMEOUT']
  parsed_config[:config]['vm_lifetime_auth'] = string_to_int(ENV['VM_LIFETIME_AUTH']) if ENV['VM_LIFETIME_AUTH']
  parsed_config[:config]['max_tries'] = string_to_int(ENV['MAX_TRIES']) if ENV['MAX_TRIES']
  parsed_config[:config]['retry_factor'] = string_to_int(ENV['RETRY_FACTOR']) if ENV['RETRY_FACTOR']
  parsed_config[:config]['create_folders'] = ENV['CREATE_FOLDERS'] if ENV['CREATE_FOLDERS']
  parsed_config[:config]['create_template_delta_disks'] = ENV['CREATE_TEMPLATE_DELTA_DISKS'] if ENV['CREATE_TEMPLATE_DELTA_DISKS']
  set_linked_clone(parsed_config)
  parsed_config[:config]['experimental_features'] = ENV['EXPERIMENTAL_FEATURES'] if ENV['EXPERIMENTAL_FEATURES']
  parsed_config[:config]['purge_unconfigured_folders'] = ENV['PURGE_UNCONFIGURED_FOLDERS'] if ENV['PURGE_UNCONFIGURED_FOLDERS']
  parsed_config[:config]['usage_stats'] = ENV['USAGE_STATS'] if ENV['USAGE_STATS']

  parsed_config[:redis] = parsed_config[:redis] || {}
  parsed_config[:redis]['server'] = ENV['REDIS_SERVER'] || parsed_config[:redis]['server'] || 'localhost'
  parsed_config[:redis]['port'] = string_to_int(ENV['REDIS_PORT']) if ENV['REDIS_PORT']
  parsed_config[:redis]['password'] = ENV['REDIS_PASSWORD'] if ENV['REDIS_PASSWORD']
  parsed_config[:redis]['data_ttl'] = string_to_int(ENV['REDIS_DATA_TTL']) || parsed_config[:redis]['data_ttl'] || 168

  parsed_config[:statsd] = parsed_config[:statsd] || {} if ENV['STATSD_SERVER']
  parsed_config[:statsd]['server'] = ENV['STATSD_SERVER'] if ENV['STATSD_SERVER']
  parsed_config[:statsd]['prefix'] = ENV['STATSD_PREFIX'] if ENV['STATSD_PREFIX']
  parsed_config[:statsd]['port'] = string_to_int(ENV['STATSD_PORT']) if ENV['STATSD_PORT']

  parsed_config[:graphite] = parsed_config[:graphite] || {} if ENV['GRAPHITE_SERVER']
  parsed_config[:graphite]['server'] = ENV['GRAPHITE_SERVER'] if ENV['GRAPHITE_SERVER']
  parsed_config[:graphite]['prefix'] = ENV['GRAPHITE_PREFIX'] if ENV['GRAPHITE_PREFIX']
  parsed_config[:graphite]['port'] = string_to_int(ENV['GRAPHITE_PORT']) if ENV['GRAPHITE_PORT']

  parsed_config[:auth] = parsed_config[:auth] || {} if ENV['AUTH_PROVIDER']
  if parsed_config.has_key? :auth
    parsed_config[:auth]['provider'] = ENV['AUTH_PROVIDER'] if ENV['AUTH_PROVIDER']
    parsed_config[:auth][:ldap] = parsed_config[:auth][:ldap] || {} if parsed_config[:auth]['provider'] == 'ldap'
    parsed_config[:auth][:ldap]['host'] = ENV['LDAP_HOST'] if ENV['LDAP_HOST']
    parsed_config[:auth][:ldap]['port'] = string_to_int(ENV['LDAP_PORT']) if ENV['LDAP_PORT']
    parsed_config[:auth][:ldap]['base'] = ENV['LDAP_BASE'] if ENV['LDAP_BASE']
    parsed_config[:auth][:ldap]['user_object'] = ENV['LDAP_USER_OBJECT'] if ENV['LDAP_USER_OBJECT']
  end

  # Create an index of pool aliases
  parsed_config[:pool_names] = Set.new
  unless parsed_config[:pools]
    redis = new_redis(parsed_config[:redis]['server'], parsed_config[:redis]['port'], parsed_config[:redis]['password'])
    parsed_config[:pools] = load_pools_from_redis(redis)
  end

  # Create an index of pools by title
  parsed_config[:pool_index] = pool_index(parsed_config[:pools])

  parsed_config[:pools].each do |pool|
    parsed_config[:pool_names] << pool['name']
    if pool['alias']
      if pool['alias'].is_a?(Array)
        pool['alias'].each do |pool_alias|
          parsed_config[:alias] ||= {}
          parsed_config[:alias][pool_alias] = [pool['name']] unless parsed_config[:alias].key? pool_alias
          parsed_config[:alias][pool_alias] << pool['name'] unless parsed_config[:alias][pool_alias].include? pool['name']
          parsed_config[:pool_names] << pool_alias
        end
      elsif pool['alias'].is_a?(String)
        parsed_config[:alias][pool['alias']] = pool['name']
        parsed_config[:pool_names] << pool['alias']
      end
    end
  end

  if parsed_config[:tagfilter]
    parsed_config[:tagfilter].keys.each do |tag|
      parsed_config[:tagfilter][tag] = Regexp.new(parsed_config[:tagfilter][tag])
    end
  end

  parsed_config[:uptime] = Time.now

  parsed_config
end

.load_pools_from_redis(redis) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/vmpooler.rb', line 136

def self.load_pools_from_redis(redis)
  pools = []
  redis.smembers('vmpooler__pools').each do |pool|
    pool_hash = {}
    redis.hgetall("vmpooler__pool__#{pool}").each do |k, v|
      pool_hash[k] = v
    end
    pool_hash['alias'] = pool_hash['alias'].split(',')
    pools << pool_hash
  end
  pools
end

.new_logger(logfile) ⇒ Object 



153
154
155
 
# File 'lib/vmpooler.rb', line 153

def self.new_logger(logfile)
  Vmpooler::Logger.new logfile
end

.new_metrics(params) ⇒ Object 



157
158
159
160
161
162
163
164
165
 
# File 'lib/vmpooler.rb', line 157

def self.new_metrics(params)
  if params[:statsd]
    Vmpooler::Statsd.new(params[:statsd])
  elsif params[:graphite]
    Vmpooler::Graphite.new(params[:graphite])
  else
    Vmpooler::DummyStatsd.new
  end
end

.new_redis(host = 'localhost', port = nil, password = nil) ⇒ Object 



149
150
151
 
# File 'lib/vmpooler.rb', line 149

def self.new_redis(host = 'localhost', port = nil, password = nil)
  Redis.new(host: host, port: port, password: password)
end

.pool_index(pools) ⇒ Object 



171
172
173
174
175
176
177
178
179
 
# File 'lib/vmpooler.rb', line 171

def self.pool_index(pools)
  pools_hash = {}
  index = 0
  for pool in pools
    pools_hash[pool['name']] = index
    index += 1
  end
  pools_hash
end

.pools(conf) ⇒ Object 



167
168
169
 
# File 'lib/vmpooler.rb', line 167

def self.pools(conf)
  conf[:pools]
end

.set_linked_clone(parsed_config) ⇒ Object 



192
193
194
195
196
 
# File 'lib/vmpooler.rb', line 192

def self.set_linked_clone(parsed_config)
  parsed_config[:config]['create_linked_clones'] = parsed_config[:config]['create_linked_clones'] || true
  parsed_config[:config]['create_linked_clones'] = ENV['CREATE_LINKED_CLONES'] if ENV['CREATE_LINKED_CLONES'] =~ /true|false/
  parsed_config[:config]['create_linked_clones'] = true?(parsed_config[:config]['create_linked_clones']) if parsed_config[:config]['create_linked_clones']
end

.string_to_int(s) ⇒ Object 



181
182
183
184
185
186
 
# File 'lib/vmpooler.rb', line 181

def self.string_to_int(s)
  # Returns a integer if input is a string
  return if s.nil?
  return unless s =~ /\d/
  return Integer(s)
end

.true?(obj) ⇒ Boolean

Returns:

  • (Boolean) 


188
189
190
 
# File 'lib/vmpooler.rb', line 188

def self.true?(obj)
  obj.to_s.downcase == "true"
end