Class: Convection::Control::Stack

Inherits:
Object
  • Object
show all
Defined in:
lib/convection/control/stack.rb,
lib/convection/terraform/ext/stack.rb

Overview

Monkey patch functions defined on Stack for use during terraform export.

Constant Summary collapse

CREATE_COMPLETE =

Represents a stack that has successfully been converged.

'CREATE_COMPLETE'.freeze
CREATE_FAILED =

Represents a stack that has not successfully been converged.

'CREATE_FAILED'.freeze
CREATE_IN_PROGRESS =

Represents a stack that is currently being converged for the first time.

'CREATE_IN_PROGRESS'.freeze
DELETE_COMPLETE =

Represents a stack that has successfully been deleted.

'DELETE_COMPLETE'.freeze
DELETE_FAILED =

Represents a stack that has not successfully been deleted.

'DELETE_FAILED'.freeze
DELETE_IN_PROGRESS =

Represents a stack that is currently being deleted.

'DELETE_IN_PROGRESS'.freeze
ROLLBACK_COMPLETE =

Represents a stack that has successfully been rolled back.

'ROLLBACK_COMPLETE'.freeze
ROLLBACK_FAILED =

Represents a stack that has not successfully been rolled back.

'ROLLBACK_FAILED'.freeze
ROLLBACK_IN_PROGRESS =

Represents a stack that is currently being rolled back.

'ROLLBACK_IN_PROGRESS'.freeze
UPDATE_COMPLETE =

Represents a stack that has successfully been updated (re-converged).

'UPDATE_COMPLETE'.freeze
UPDATE_COMPLETE_CLEANUP_IN_PROGRESS =

Represents a stack that is currently performing post-update cleanup.

'UPDATE_COMPLETE_CLEANUP_IN_PROGRESS'.freeze
UPDATE_FAILED =

Represents a stack that has not successfully been updated.

'UPDATE_FAILED'.freeze
UPDATE_IN_PROGRESS =

Represents a stack that is currently being updated (re-converged).

'UPDATE_IN_PROGRESS'.freeze
UPDATE_ROLLBACK_COMPLETE =

Represents a stack that has successfully rolled back an update (re-converge).

'UPDATE_ROLLBACK_COMPLETE'.freeze
UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS =

Represents a stack that is currently performing post-update-rollback cleanup.

'UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS'.freeze
UPDATE_ROLLBACK_FAILED =

Represents a stack that has successfully been rolled back after an update.

'UPDATE_ROLLBACK_FAILED'.freeze
UPDATE_ROLLBACK_IN_PROGRESS =

Represents a stack that is currently performing a update rollback.

'UPDATE_ROLLBACK_IN_PROGRESS'.freeze
NOT_CREATED =

Represents a stack that has not been created. The default state for a convection stack before getting its status.

'NOT_CREATED'.freeze
TASK_COMPLETE =

Represents a stack task being completed.

'TASK_COMPLETE'.freeze
TASK_FAILED =

Represents a stack task having failed.

'TASK_FAILED'.freeze
TASK_IN_PROGRESS =

Represents a stack task that is currently in progress.

'TASK_IN_PROGRESS'.freeze

Instance Attribute Summary collapse

Attribute accessors collapse

Stack state methods collapse

Render/diff methods collapse

Controllers collapse

Task methods collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, template, options = {}, &block) ⇒ Stack

Returns a new instance of Stack.

Parameters:

  • name (String)

    the name of the CloudFormation Stack

  • template (Convection::Model::Template)

    a wrapper of the CloudFormation template (can be rendered into CF JSON)

  • options (Hash) (defaults to: {})

    an options hash to pass in advanced configuration options. Undocumented options will be passed directly to CloudFormation’s #create_stack or #update_stack.

Options Hash (options):

  • :region (String)

    AWS region, format us-east-1. Default us-east-1

  • :credentials (Hash)

    optional instance of ‘Aws::Credentials`

  • :parameters (Hash)

    CloudFormation Stack parameters

  • :tags (String)

    CloudFormation Stack tags

  • :on_failure (String)

    the create failure action. Default: ‘DELETE`

  • :capabilities (Array<String>)

    A list of capabilities (such as ‘CAPABILITY_IAM`). See also Aws::CloudFormation::Client#create_stack



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
# File 'lib/convection/control/stack.rb', line 103

def initialize(name, template, options = {}, &block)
  @name = name
  @template = template.clone(self)
  @errors = []

  @cloud = options.delete(:cloud)
  @cloud_name = options.delete(:cloud_name)
  @region = options.delete(:region) { |_| 'us-east-1' }
  @exclude_availability_zones = options.delete(:exclude_availability_zones) { |_| [] } # Default empty Array
  @credentials = options.delete(:credentials)
  @parameters = options.delete(:parameters) { |_| {} } # Default empty hash
  @tags = options.delete(:tags) { |_| {} } # Default empty hash
  options.delete(:disable_rollback) # There can be only one...
  @on_failure = options.delete(:on_failure) { |_| 'DELETE' }
  @capabilities = options.delete(:capabilities) { |_| %w(CAPABILITY_IAM CAPABILITY_NAMED_IAM) }

  @attributes = options.delete(:attributes) { |_| Model::Attributes.new }
  @options = options
  @retry_limit = options[:retry_limit] || 7

  client_options = {}.tap do |opt|
    opt[:region] = @region
    opt[:credentials] = @credentials unless @credentials.nil?
    opt[:retry_limit] = @retry_limit
  end
  @ec2_client = Aws::EC2::Client.new(client_options)
  @cf_client = Aws::CloudFormation::Client.new(client_options)

  ## Remote state
  @exist = false
  @status = NOT_CREATED
  @id = nil
  @outputs = {}
  @resources = {}
  @tasks = { after_create: [], after_delete: [], after_update: [], before_create: [], before_delete: [], before_update: [] }
  instance_exec(&block) if block
  @current_template = {}
  @last_event_seen = nil

  # First pass evaluation of stack
  # This is important because it:
  #   * Catches syntax errors before starting a converge
  #   * Builds a list of all resources that allows stacks early in
  #     the dependency tree to know about later stacks.  Some
  #     clouds use this, for example, to create security groups early
  #     in the dependency tree to avoid the chicken-and-egg problem.
  @template.execute
rescue Aws::Errors::ServiceError => e
  @errors << e
end

Instance Attribute Details

#attribute_mapping_valuesObject (readonly)

Returns the value of attribute attribute_mapping_values.



31
32
33
# File 'lib/convection/control/stack.rb', line 31

def attribute_mapping_values
  @attribute_mapping_values
end

#attributesObject (readonly)

Returns the value of attribute attributes.



27
28
29
# File 'lib/convection/control/stack.rb', line 27

def attributes
  @attributes
end

#capabilitiesObject (readonly)

Returns the value of attribute capabilities.



39
40
41
# File 'lib/convection/control/stack.rb', line 39

def capabilities
  @capabilities
end

#cloudObject

Returns the value of attribute cloud.



38
39
40
# File 'lib/convection/control/stack.rb', line 38

def cloud
  @cloud
end

#credentialsObject

Returns the value of attribute credentials.



40
41
42
# File 'lib/convection/control/stack.rb', line 40

def credentials
  @credentials
end

#current_templateObject (readonly)

Returns the value of attribute current_template.



25
26
27
# File 'lib/convection/control/stack.rb', line 25

def current_template
  @current_template
end

#errorsObject (readonly)

Returns the value of attribute errors.



28
29
30
# File 'lib/convection/control/stack.rb', line 28

def errors
  @errors
end

#exclude_availability_zonesObject

Returns the value of attribute exclude_availability_zones.



37
38
39
# File 'lib/convection/control/stack.rb', line 37

def exclude_availability_zones
  @exclude_availability_zones
end

#existBoolean (readonly) Also known as: exist?

Returns whether the stack exists and has a status other than DELETED.

Returns:

  • (Boolean)

    whether the stack exists and has a status other than DELETED.



20
21
22
# File 'lib/convection/control/stack.rb', line 20

def exist
  @exist
end

#idObject (readonly)

Returns the value of attribute id.



15
16
17
# File 'lib/convection/control/stack.rb', line 15

def id
  @id
end

#nameObject (readonly)

Returns the value of attribute name.



16
17
18
# File 'lib/convection/control/stack.rb', line 16

def name
  @name
end

#on_failureObject

Returns the value of attribute on_failure.



43
44
45
# File 'lib/convection/control/stack.rb', line 43

def on_failure
  @on_failure
end

#optionsObject (readonly)

Returns the value of attribute options.



29
30
31
# File 'lib/convection/control/stack.rb', line 29

def options
  @options
end

#outputsObject (readonly)

Returns the value of attribute outputs.



32
33
34
# File 'lib/convection/control/stack.rb', line 32

def outputs
  @outputs
end

#parametersObject (readonly)

Returns the value of attribute parameters.



41
42
43
# File 'lib/convection/control/stack.rb', line 41

def parameters
  @parameters
end

#regionObject

AWS-SDK



36
37
38
# File 'lib/convection/control/stack.rb', line 36

def region
  @region
end

#resourcesObject (readonly)

Returns the value of attribute resources.



30
31
32
# File 'lib/convection/control/stack.rb', line 30

def resources
  @resources
end

#statusString (readonly)

Returns CloudFormation Stack status.

Returns:

  • (String)

    CloudFormation Stack status



22
23
24
# File 'lib/convection/control/stack.rb', line 22

def status
  @status
end

#tagsObject (readonly)

Returns the value of attribute tags.



42
43
44
# File 'lib/convection/control/stack.rb', line 42

def tags
  @tags
end

#tasksObject (readonly)

Returns the value of attribute tasks.



33
34
35
# File 'lib/convection/control/stack.rb', line 33

def tasks
  @tasks
end

#templateObject

Returns the value of attribute template.



17
18
19
# File 'lib/convection/control/stack.rb', line 17

def template
  @template
end

Instance Method Details

#[](key) ⇒ Object



189
190
191
# File 'lib/convection/control/stack.rb', line 189

def [](key)
  @attributes.get(name, key)
end

#[]=(key, value) ⇒ Object



194
195
196
# File 'lib/convection/control/stack.rb', line 194

def []=(key, value)
  @attributes.set(name, key, value)
end

#_original_cloudObject

Returns the value of attribute cloud.



6
7
8
# File 'lib/convection/terraform/ext/stack.rb', line 6

def cloud
  @cloud
end

#_original_regionObject

AWS-SDK



11
12
13
# File 'lib/convection/terraform/ext/stack.rb', line 11

def region
  @region
end

#after_create_task(task) ⇒ Object

Register a given task to run after creation of a stack.



462
463
464
# File 'lib/convection/control/stack.rb', line 462

def after_create_task(task)
  @tasks[:after_create] << task
end

#after_delete_task(task) ⇒ Object

Register a given task to run after deletion of a stack.



467
468
469
# File 'lib/convection/control/stack.rb', line 467

def after_delete_task(task)
  @tasks[:after_delete] << task
end

#after_update_task(task) ⇒ Object

Register a given task to run after an update of a stack.



472
473
474
# File 'lib/convection/control/stack.rb', line 472

def after_update_task(task)
  @tasks[:after_update] << task
end

#apply(retain: false, &block) ⇒ Object

Render the CloudFormation template and apply the Stack using the CloudFormation client.

Parameters:

  • block (Proc)

    a configuration block to pass any Model::Events to.



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'lib/convection/control/stack.rb', line 324

def apply(retain: false, &block)
  request_options = @options.clone.tap do |o|
    o[:template_body] = to_json(retain: retain)
    o[:parameters] = cf_parameters
    o[:capabilities] = capabilities
  end

  # Get the state of existence before creation
  existing_stack = exist?
  if existing_stack
    if diff(retain: retain).empty? ## No Changes. Just get resources and move on
      block.call(Model::Event.new(:complete, "Stack #{ name } has no changes", :info)) if block
      get_status
      return
    elsif !resource_changes? && resource_dependent_changes?
      message = "Stack #{ name } has no convergable changes (you must update Resources to update Conditions, Metadata, or Outputs)"
      block.call(Model::Event.new(UPDATE_FAILED, message, :warn)) if block
      get_status
      return
    end

    ## Execute before update tasks
    @tasks[:before_update].delete_if do |task|
      run_task(:before_update, task, &block)
    end

    ## Update
    @cf_client.update_stack(request_options.tap do |o|
      o[:stack_name] = id
    end)
  else
    ## Execute before create tasks
    @tasks[:before_create].delete_if do |task|
      run_task(:before_create, task, &block)
    end

    ## Create
    @cf_client.create_stack(request_options.tap do |o|
      o[:stack_name] = cloud_name

      o[:tags] = cf_tags
      o[:on_failure] = on_failure
    end)

    get_status(cloud_name) # Get ID of new stack
  end

  watch(&block) if block # Block execution on stack status

  ## Execute after create tasks
  after_task_type = existing_stack ? :after_update : :after_create
  @tasks[after_task_type].delete_if do |task|
    run_task(after_task_type, task, &block)
  end
rescue Aws::Errors::ServiceError => e
  @errors << e
end

#availability_zones(&block) ⇒ Array<String>

Returns the list of availability zones found by the call to ec2 client’s describe availability zones.

Parameters:

  • block (Proc)

    a block to pass each availability zone (with its index)

Returns:

  • (Array<String>)

    the list of availability zones found by the call to ec2 client’s describe availability zones



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'lib/convection/control/stack.rb', line 434

def availability_zones(&block)
  @availability_zones ||=
    @ec2_client.describe_availability_zones.availability_zones.map(&:zone_name)

  unless @exclude_availability_zones.empty?
    @availability_zones.reject! { |az| @exclude_availability_zones.include?(az) }
  end
  if @availability_zones.empty? && block
    fail 'There are no AvailabilityZones, check exclude_availability_zones in the Cloudfile.'
  end
  @availability_zones.sort!

  @availability_zones.each_with_index(&block) if block
  @availability_zones
end

#before_create_task(task) ⇒ Object

Register a given task to run before creation of a stack.



477
478
479
# File 'lib/convection/control/stack.rb', line 477

def before_create_task(task)
  @tasks[:before_create] << task
end

#before_delete_task(task) ⇒ Object

Register a given task to run before deletion of a stack.



482
483
484
# File 'lib/convection/control/stack.rb', line 482

def before_delete_task(task)
  @tasks[:before_delete] << task
end

#before_update_task(task) ⇒ Object

Register a given task to run before an update of a stack.



487
488
489
# File 'lib/convection/control/stack.rb', line 487

def before_update_task(task)
  @tasks[:before_update] << task
end

#cloud_nameObject



169
170
171
172
173
# File 'lib/convection/control/stack.rb', line 169

def cloud_name
  return @cloud_name unless @cloud_name.nil?
  return name if cloud.nil?
  "#{ cloud }-#{ name }"
end

#complete?Boolean

Returns whether the CloudFormation Stack is in one of the several *_COMPLETE states.

Returns:

  • (Boolean)

    whether the CloudFormation Stack is in one of the several *_COMPLETE states.



223
224
225
# File 'lib/convection/control/stack.rb', line 223

def complete?
  [CREATE_COMPLETE, ROLLBACK_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE].include?(status)
end

#credential_error?Boolean

Returns whether a credential error occurred is the reason accessing the CloudFormation stack failed.

Returns:

  • (Boolean)

    whether a credential error occurred is the reason accessing the CloudFormation stack failed.



229
230
231
# File 'lib/convection/control/stack.rb', line 229

def credential_error?
  error? && errors.all? { |e| e.class == Aws::EC2::Errors::RequestExpired }
end

#delete(&block) ⇒ Object

Delete the CloudFormation Stack using the CloudFormation client.

Parameters:

  • block (Proc)

    a configuration block to pass any Model::Events to.



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'lib/convection/control/stack.rb', line 386

def delete(&block)
  ## Execute before delete tasks
  @tasks[:before_delete].delete_if do |task|
    run_task(:before_delete, task, &block)
  end

  @cf_client.delete_stack(
    :stack_name => id
  )

  ## Block execution on stack status
  watch(&block) if block

  get_status

  ## Execute after delete tasks
  @tasks[:after_delete].delete_if do |task|
    run_task(:after_delete, task, &block)
  end
rescue Aws::Errors::ServiceError => e
  @errors << e
end

#delete_complete?Boolean

Returns whether the CloudFormation Stack is in one of the several *_COMPLETE states.

Returns:

  • (Boolean)

    whether the CloudFormation Stack is in one of the several *_COMPLETE states.



235
236
237
# File 'lib/convection/control/stack.rb', line 235

def delete_complete?
  DELETE_COMPLETE == status
end

#delete_success?Boolean

Returns whether the Stack state is now #delete_complete? (with no errors present).

Returns:

  • (Boolean)

    whether the Stack state is now #delete_complete? (with no errors present).



240
241
242
# File 'lib/convection/control/stack.rb', line 240

def delete_success?
  !error? && delete_complete?
end

#diff(retain: false) ⇒ Hash

Returns a set of differences between the current template (in CloudFormation) and the state of the rendered template (what would be converged).

Returns:

  • (Hash)

    a set of differences between the current template (in CloudFormation) and the state of the rendered template (what would be converged).

See Also:



281
282
283
# File 'lib/convection/control/stack.rb', line 281

def diff(retain: false)
  @template.diff(@current_template, retain: retain)
end

#error?Boolean

Returns whether any errors occurred modifying the stack.

Returns:

  • (Boolean)

    whether any errors occurred modifying the stack.



252
253
254
# File 'lib/convection/control/stack.rb', line 252

def error?
  !errors.empty?
end

#fail?Boolean

Returns whether the CloudFormation Stack is in one of the several *_FAILED states.

Returns:

  • (Boolean)

    whether the CloudFormation Stack is in one of the several *_FAILED states.



246
247
248
# File 'lib/convection/control/stack.rb', line 246

def fail?
  [CREATE_FAILED, ROLLBACK_FAILED, DELETE_FAILED, UPDATE_ROLLBACK_FAILED].include?(status)
end

#fetch(*args) ⇒ Object



199
200
201
# File 'lib/convection/control/stack.rb', line 199

def fetch(*args)
  @attributes.fetch(*args)
end

#get(*args) ⇒ Object



204
205
206
# File 'lib/convection/control/stack.rb', line 204

def get(*args)
  @attributes.get(*args)
end

#in_progress?Boolean

Returns whether or not the CloudFormation Stack is in one of several *IN_PROGRESS states.

Returns:

  • (Boolean)

    whether or not the CloudFormation Stack is in one of several *IN_PROGRESS states.



214
215
216
217
218
219
# File 'lib/convection/control/stack.rb', line 214

def in_progress?
  [CREATE_IN_PROGRESS, ROLLBACK_IN_PROGRESS, DELETE_IN_PROGRESS,
   UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS,
   UPDATE_ROLLBACK_IN_PROGRESS,
   UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS].include?(status)
end

#include?(key) ⇒ Boolean #include?(stack_name, key) ⇒ Boolean

Returns whether the stack includes the specified key.

Overloads:

  • #include?(key) ⇒ Boolean

    Parameters:

    • key (String)

      the name of the attribute to find

  • #include?(stack_name, key) ⇒ Boolean

    Parameters:

    • stack_name (String)

      the name of the stack to check within

    • key (String)

      the name of the attribute to find

Returns:

  • (Boolean)

    whether the stack includes the specified key.



183
184
185
186
# File 'lib/convection/control/stack.rb', line 183

def include?(stack, key = nil)
  return @attributes.include?(name, stack) if key.nil?
  @attributes.include?(stack, key)
end

#load_template_infoObject



160
161
162
163
164
165
166
167
# File 'lib/convection/control/stack.rb', line 160

def load_template_info
  get_resources
  get_template
  resource_attributes
  get_events(1) # Get the latest page of events (Set @last_event_seen before starting)
rescue Aws::Errors::ServiceError => e
  @errors << e
end

#renderObject



266
267
268
# File 'lib/convection/control/stack.rb', line 266

def render
  @template.render
end

#resource_changes?Boolean

Returns whether the Resources section of the rendered template has any changes compared to the current template (in CloudFormation).

Returns:

  • (Boolean)

    whether the Resources section of the rendered template has any changes compared to the current template (in CloudFormation).



288
289
290
291
292
293
# File 'lib/convection/control/stack.rb', line 288

def resource_changes?
  ours = { 'Resources' => @template.all_resources.map(&:render) }
  thiers = { 'Resources' => @current_template['Resources'] }

  ours.diff(thiers).any?
end

#resource_dependent_changes?Boolean

Returns whether the any template sections dependent on the Resources section of the rendered template has any changes compared to the current template (in CloudFormation). For example Conditions, Metadata, and Outputs depend on changes to resources to be able to converge. See also rapid7/convection#140.

Returns:

  • (Boolean)

    whether the any template sections dependent on the Resources section of the rendered template has any changes compared to the current template (in CloudFormation). For example Conditions, Metadata, and Outputs depend on changes to resources to be able to converge. See also rapid7/convection#140.



302
303
304
305
306
307
308
309
310
311
312
313
# File 'lib/convection/control/stack.rb', line 302

def resource_dependent_changes?
  ours = {
    'Conditions' => @template.conditions.map(&:render),
    'Outputs' => @template.outputs.map(&:render)
  }
  theirs = {
    'Conditions' => @current_template['Conditions'],
    'Outputs' => @current_template['Outputs']
  }

  ours.diff(theirs).any?
end

#success?Boolean

Returns whether the Stack state is now #complete? (with no errors present).

Returns:

  • (Boolean)

    whether the Stack state is now #complete? (with no errors present).



257
258
259
# File 'lib/convection/control/stack.rb', line 257

def success?
  !error? && complete?
end

#template_statusObject



154
155
156
157
158
# File 'lib/convection/control/stack.rb', line 154

def template_status
  get_status(cloud_name)
rescue Aws::Errors::ServiceError => e
  @errors << e
end

#to_json(pretty = false) ⇒ Object

Returns the renedered CloudFormation Template JSON.

Parameters:

  • pretty (Boolean) (defaults to: false)

    whether to to pretty-print the JSON output

Returns:

  • the renedered CloudFormation Template JSON.

See Also:



273
274
275
# File 'lib/convection/control/stack.rb', line 273

def to_json(pretty = false)
  @template.to_json(nil, pretty)
end

#validateObject

Validates a rendered template against the CloudFormation API.

Raises:

  • unless the validation was successful



453
454
455
456
457
# File 'lib/convection/control/stack.rb', line 453

def validate
  result = @cf_client.validate_template(:template_body => template.to_json)
  fail result.context.http_response.inspect unless result.successful?
  puts "\nTemplate validated successfully"
end

#watch(poll = 2, &block) ⇒ Object

Loops through current events until the CloudFormation Stack has finished being modified.



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/convection/control/stack.rb', line 413

def watch(poll = 2, &block)
  get_status

  loop do
    get_events.reverse_each do |event|
      block.call(Model::Event.from_cf(event))
    end if block

    break unless in_progress?

    sleep poll
    get_status
  end
rescue Aws::Errors::ServiceError => e
  @errors << e
end