Class: VagrantPlugins::Cloudstack::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant-cloudstack/config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_specific = false) ⇒ Config

Returns a new instance of Config.



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
 
# File 'lib/vagrant-cloudstack/config.rb', line 132

def initialize(domain_specific=false)
  @host                   = UNSET_VALUE
  @path                   = UNSET_VALUE
  @port                   = UNSET_VALUE
  @scheme                 = UNSET_VALUE
  @api_key                = UNSET_VALUE
  @secret_key             = UNSET_VALUE
  @instance_ready_timeout = UNSET_VALUE
  @domain_id              = UNSET_VALUE
  @network_id             = UNSET_VALUE
  @network_type           = UNSET_VALUE
  @project_id             = UNSET_VALUE
  @service_offering_id    = UNSET_VALUE
  @template_id            = UNSET_VALUE
  @zone_id                = UNSET_VALUE
  @keypair                = UNSET_VALUE
  @pf_ip_address_id       = UNSET_VALUE
  @pf_public_port         = UNSET_VALUE
  @pf_private_port        = UNSET_VALUE
  @security_group_ids     = UNSET_VALUE
  @display_name           = UNSET_VALUE
  @group                  = UNSET_VALUE
  @security_group_names   = UNSET_VALUE
  @security_groups        = UNSET_VALUE
  @user_data              = UNSET_VALUE


  # Internal state (prefix with __ so they aren't automatically
  # merged)
  @__compiled_domain_configs = {}
  @__finalized = false
  @__domain_config = {}
  @__domain_specific = domain_specific
end

Instance Attribute Details

#api_key ⇒ String

The API key for accessing Cloudstack.

Returns:

  • (String) 


29
30
31
 
# File 'lib/vagrant-cloudstack/config.rb', line 29

def api_key
  @api_key
end

#display_name ⇒ String

display name for the instance

Returns:

  • (String) 


119
120
121
 
# File 'lib/vagrant-cloudstack/config.rb', line 119

def display_name
  @display_name
end

#domain_id ⇒ String

Domain id to launch the instance into.

Returns:

  • (String) 


44
45
46
 
# File 'lib/vagrant-cloudstack/config.rb', line 44

def domain_id
  @domain_id
end

#group ⇒ String

group for the instance

Returns:

  • (String) 


124
125
126
 
# File 'lib/vagrant-cloudstack/config.rb', line 124

def group
  @group
end

#host ⇒ String

Cloudstack api host.

Returns:

  • (String) 


9
10
11
 
# File 'lib/vagrant-cloudstack/config.rb', line 9

def host
  @host
end

#instance_ready_timeout ⇒ Fixnum

The timeout to wait for an instance to become ready.

Returns:

  • (Fixnum) 


39
40
41
 
# File 'lib/vagrant-cloudstack/config.rb', line 39

def instance_ready_timeout
  @instance_ready_timeout
end

#keypair ⇒ String

The name of the keypair to use.

Returns:

  • (String) 


80
81
82
 
# File 'lib/vagrant-cloudstack/config.rb', line 80

def keypair
  @keypair
end

#network_id ⇒ String

Network uuid that the instance should use

Returns:

  • (String) 


49
50
51
 
# File 'lib/vagrant-cloudstack/config.rb', line 49

def network_id
  @network_id
end

#network_type ⇒ String

Network Type

Returns:

  • (String) 


54
55
56
 
# File 'lib/vagrant-cloudstack/config.rb', line 54

def network_type
  @network_type
end

#path ⇒ String

Cloudstack api path.

Returns:

  • (String) 


14
15
16
 
# File 'lib/vagrant-cloudstack/config.rb', line 14

def path
  @path
end

#pf_ip_address_id ⇒ String

IP address id to use for port forwarding rule

Returns:

  • (String) 


85
86
87
 
# File 'lib/vagrant-cloudstack/config.rb', line 85

def pf_ip_address_id
  @pf_ip_address_id
end

#pf_private_port ⇒ String

private port to use for port forwarding rule

Returns:

  • (String) 


95
96
97
 
# File 'lib/vagrant-cloudstack/config.rb', line 95

def pf_private_port
  @pf_private_port
end

#pf_public_port ⇒ String

public port to use for port forwarding rule

Returns:

  • (String) 


90
91
92
 
# File 'lib/vagrant-cloudstack/config.rb', line 90

def pf_public_port
  @pf_public_port
end

#port ⇒ String

Cloudstack api port.

Returns:

  • (String) 


19
20
21
 
# File 'lib/vagrant-cloudstack/config.rb', line 19

def port
  @port
end

#project_id ⇒ String

Project uuid that the instance should belong to

Returns:

  • (String) 


59
60
61
 
# File 'lib/vagrant-cloudstack/config.rb', line 59

def project_id
  @project_id
end

#scheme ⇒ String

Cloudstack api scheme

Returns:

  • (String) 


24
25
26
 
# File 'lib/vagrant-cloudstack/config.rb', line 24

def scheme
  @scheme
end

#secret_key ⇒ String

The secret key for accessing Cloudstack.

Returns:

  • (String) 


34
35
36
 
# File 'lib/vagrant-cloudstack/config.rb', line 34

def secret_key
  @secret_key
end

#security_group_ids ⇒ Array

comma separated list of security groups id that going to be applied to the virtual machine.

Returns:

  • (Array) 


101
102
103
 
# File 'lib/vagrant-cloudstack/config.rb', line 101

def security_group_ids
  @security_group_ids
end

#security_group_names ⇒ Array

comma separated list of security groups name that going to be applied to the virtual machine.

Returns:

  • (Array) 


107
108
109
 
# File 'lib/vagrant-cloudstack/config.rb', line 107

def security_group_names
  @security_group_names
end

#security_groups ⇒ Array

comma separated list of security groups (hash with ingress/egress rules) to be applied to the virtual machine.

Returns:

  • (Array) 


114
115
116
 
# File 'lib/vagrant-cloudstack/config.rb', line 114

def security_groups
  @security_groups
end

#service_offering_id ⇒ String

Service offering uuid to use for the instance

Returns:

  • (String) 


64
65
66
 
# File 'lib/vagrant-cloudstack/config.rb', line 64

def service_offering_id
  @service_offering_id
end

#template_id ⇒ String

Template uuid to use for the instance

Returns:

  • (String) 


69
70
71
 
# File 'lib/vagrant-cloudstack/config.rb', line 69

def template_id
  @template_id
end

#user_data ⇒ String

The user data string

Returns:

  • (String) 


129
130
131
 
# File 'lib/vagrant-cloudstack/config.rb', line 129

def user_data
  @user_data
end

#zone_id ⇒ String

Zone uuid to launch the instance into. If nil, it will launch in default project.

Returns:

  • (String) 


75
76
77
 
# File 'lib/vagrant-cloudstack/config.rb', line 75

def zone_id
  @zone_id
end

Instance Method Details

#domain_config(domain, attributes = nil) {|config| ... } ⇒ Object

Allows domain-specific overrides of any of the settings on this configuration object. This allows the user to override things like template and keypair name for domains. Example:

cloudstack.domain_config "abcd-ef01-2345-6789" do |domain|
  domain.template_id = "1234-5678-90ab-cdef"
  domain.keypair_name = "company-east"
end

Parameters:

  • domain (String) —

    The Domain name to configure.

  • attributes (Hash) (defaults to: nil) —

    Direct attributes to set on the configuration as a shortcut instead of specifying a full block.

Yields:

  • (config) —

    Yields a new domain configuration.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/vagrant-cloudstack/config.rb', line 180

def domain_config(domain, attributes=nil, &block)
  # Append the block to the list of domain configs for that domain.
  # We'll evaluate these upon finalization.
  @__domain_config[domain] ||= []

  # Append a block that sets attributes if we got one
  if attributes
    attr_block = lambda do |config|
      config.set_options(attributes)
    end

    @__domain_config[domain] << attr_block
  end

  # Append a block if we got one
  @__domain_config[domain] << block if block_given?
end

#finalize! ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
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
298
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
 
# File 'lib/vagrant-cloudstack/config.rb', line 227

def finalize!
  # Domain_id must be nil, since we can't default that
  @host = nil if @host == UNSET_VALUE

  # Path must be nil, since we can't default that
  @path = nil if @path == UNSET_VALUE

  # Port must be nil, since we can't default that
  @port = nil if @port == UNSET_VALUE

  # We default the scheme to whatever the user has specifid in the .fog file
  # *OR* whatever is default for the provider in the fog library
  @scheme = nil if @scheme == UNSET_VALUE

  # Try to get access keys from environment variables, they will
  # default to nil if the environment variables are not present
  @api_key = ENV['CLOUDSTACK_API_KEY'] if @api_key == UNSET_VALUE
  @secret_key = ENV['CLOUDSTACK_SECRET_KEY'] if @secret_key == UNSET_VALUE

  # Set the default timeout for waiting for an instance to be ready
  @instance_ready_timeout = 120 if @instance_ready_timeout == UNSET_VALUE

  # Domain id must be nil, since we can't default that
  @domain_id = nil if @domain_id == UNSET_VALUE

  # Network uuid must be nil, since we can't default that
  @network_id = nil if @network_id == UNSET_VALUE

  # NetworkType is 'Advanced' by default
  @network_type = "Advanced" if @network_type == UNSET_VALUE

  # Project uuid must be nil, since we can't default that
  @project_id = nil if @project_id == UNSET_VALUE

  # Service offering uuid must be nil, since we can't default that
  @service_offering_id = nil if @service_offering_id == UNSET_VALUE

  # Template uuid must be nil, since we can't default that
  @template_id = nil if @template_id == UNSET_VALUE

  # Zone uuid must be nil, since we can't default that
  @zone_id = nil if @zone_id == UNSET_VALUE

  # Keypair defaults to nil
  @keypair = nil if @keypair == UNSET_VALUE

  # IP address id must be nil, since we can't default that
  @pf_ip_address_id = nil if @pf_ip_address_id == UNSET_VALUE

  # Public port must be nil, since we can't default that
  @pf_public_port = nil if @pf_public_port == UNSET_VALUE

  # Private port must be nil, since we can't default that
  @pf_private_port = nil if @pf_private_port == UNSET_VALUE

  # Security Group IDs must be nil, since we can't default that
  @security_group_ids = nil if @security_group_ids == UNSET_VALUE

  # Security Group Names must be nil, since we can't default that
  @security_group_names = nil if @security_group_names == UNSET_VALUE

  # Security Groups must be nil, since we can't default that
  @security_groups = nil if @security_groups == UNSET_VALUE

  # Display name must be nil, since we can't default that
  @display_name = nil if @display_name == UNSET_VALUE

  # Group must be nil, since we can't default that
  @group = nil if @group == UNSET_VALUE

  # User Data is nil by default
  @user_data = nil if @user_data == UNSET_VALUE

  # Compile our domain specific configurations only within
  # NON-DOMAIN-SPECIFIC configurations.
  if !@__domain_specific
    @__domain_config.each do |domain, blocks|
      config = self.class.new(true).merge(self)

      # Execute the configuration for each block
      blocks.each { |b| b.call(config) }

      # The domain name of the configuration always equals the
      # domain config name:
      config.domain = domain

      # Finalize the configuration
      config.finalize!

      # Store it for retrieval
      @__compiled_domain_configs[domain] = config
    end
  end

  # Mark that we finalized
  @__finalized = true
end

#get_domain_config(name) ⇒ Object

This gets the configuration for a specific domain. It shouldn’t be called by the general public and is only used internally.



348
349
350
351
352
353
354
355
 
# File 'lib/vagrant-cloudstack/config.rb', line 348

def get_domain_config(name)
  if !@__finalized
    raise "Configuration must be finalized before calling this method."
  end

  # Return the compiled domain config
  @__compiled_domain_configs[name] || self
end

#merge(other) ⇒ Object

Internal methods.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/vagrant-cloudstack/config.rb', line 202

def merge(other)
  super.tap do |result|
    # Copy over the domain specific flag. "True" is retained if either
    # has it.
    new_domain_specific = other.instance_variable_get(:@__domain_specific)
    result.instance_variable_set(
      :@__domain_specific, new_domain_specific || @__domain_specific)

    # Go through all the domain configs and prepend ours onto
    # theirs.
    new_domain_config = other.instance_variable_get(:@__domain_config)
    @__domain_config.each do |key, value|
      new_domain_config[key] ||= []
      new_domain_config[key] = value + new_domain_config[key]
    end

    # Set it
    result.instance_variable_set(:@__domain_config, new_domain_config)

    # Merge in the tags
    result.tags.merge!(self.tags)
    result.tags.merge!(other.tags)
  end
end

#validate(machine) ⇒ Object 



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/vagrant-cloudstack/config.rb', line 325

def validate(machine)
  errors = []

  if @domain
    # Get the configuration for the domain we're using and validate only
    # that domain.
    config = get_domain_config(@domain)

    if !config.use_fog_profile
      errors << I18n.t("vagrant_cloudstack.config.api_key_required") if \
        config.access_key_id.nil?
      errors << I18n.t("vagrant_cloudstack.config.secret_key_required") if \
        config.secret_access_key.nil?
    end

    errors << I18n.t("vagrant_cloudstack.config.ami_required") if config.ami.nil?
  end

  { "Cloudstack Provider" => errors }
end