Class: Ufo::Stack

Inherits:
Object
  • Object
show all
Extended by:
Memoist
Includes:
Helper
Defined in:
lib/ufo/stack/status.rb,
lib/ufo/stack.rb,
lib/ufo/stack/helper.rb,
lib/ufo/stack/context.rb

Overview

CloudFormation status codes, full list:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html

CREATE_COMPLETE
ROLLBACK_COMPLETE
DELETE_COMPLETE
UPDATE_COMPLETE
UPDATE_ROLLBACK_COMPLETE

CREATE_FAILED
DELETE_FAILED
ROLLBACK_FAILED
UPDATE_ROLLBACK_FAILED

CREATE_IN_PROGRESS
DELETE_IN_PROGRESS
REVIEW_IN_PROGRESS
ROLLBACK_IN_PROGRESS
UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
UPDATE_IN_PROGRESS
UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
UPDATE_ROLLBACK_IN_PROGRESS

Defined Under Namespace

Modules: Helper Classes: Context, Status

Instance Method Summary collapse

Methods included from Helper

#adjust_stack_name, #find_stack, #status

Methods included from Util

#default_cluster, #display_params, #execute, #pretty_time, #settings, #task_definition_arns, #user_params

Methods included from AwsService

#cloudformation, #cloudwatchlogs, #ec2, #ecr, #ecs, #elb

Constructor Details

#initialize(options) ⇒ Stack

Returns a new instance of Stack.



32
33
34
35
36
37
38
 
# File 'lib/ufo/stack.rb', line 32

def initialize(options)
  @options = options
  @task_definition = options[:task_definition]
  @service = options[:service]
  @cluster = @options[:cluster] || default_cluster
  @stack_name = adjust_stack_name(@cluster, options[:service])
end

Instance Method Details

#context ⇒ Object 



132
133
134
135
136
137
138
 
# File 'lib/ufo/stack.rb', line 132

def context
  Context.new(@options.merge(
    cluster: @cluster,
    stack_name: @stack_name,
    stack: @stack,
  ))
end

#current_desired_count ⇒ Object 



141
142
143
144
145
146
147
148
149
 
# File 'lib/ufo/stack.rb', line 141

def current_desired_count
  info = Info.new(@service, @options)
  service = info.service
  if service
    service.desired_count.to_s
  else
    "1" # new service default
  end
end

#deploy ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/ufo/stack.rb', line 40

def deploy
  @stack = find_stack(@stack_name)
  if @stack && rollback_complete?(@stack)
    puts "Existing stack in ROLLBACK_COMPLETE state. Deleting stack before continuing."
    cloudformation.delete_stack(stack_name: @stack_name)
    status.wait
    status.reset
    @stack = nil # at this point stack has been deleted
  end

  exit_with_message(@stack) if @stack && !updatable?(@stack)

  @stack ? perform(:update) : perform(:create)

  stop_old_tasks if @options[:stop_old_task]

  return unless @options[:wait]
  status.wait

  puts status.rollback_error_message if status.update_rollback?

  status.success?
end

#exit_with_message(stack) ⇒ Object 



169
170
171
172
173
174
175
 
# File 'lib/ufo/stack.rb', line 169

def exit_with_message(stack)
  region = `aws configure get region`.strip rescue "us-east-1"
  url = "https://console.aws.amazon.com/cloudformation/home?region=#{region}#/stacks"
  puts "The stack is not in an updateable state: #{stack.stack_status.colorize(:yellow)}."
  puts "Here's the CloudFormation url to check for more details #{url}"
  exit 1
end

#handle_stack_error(e) ⇒ Object

Assume only first container_definition to get the container info. Stack:arn:aws:cloudformation:… is in ROLLBACK_COMPLETE state and can not be updated.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/ufo/stack.rb', line 179

def handle_stack_error(e)
  case e.message
  when /is in ROLLBACK_COMPLETE state and can not be updated/
    puts "The #{@stack_name} stack is in #{"ROLLBACK_COMPLETE".colorize(:red)} and cannot be updated. Deleted the stack and try again."
    region = `aws configure get region`.strip rescue 'us-east-1'
    url = "https://console.aws.amazon.com/cloudformation/home?region=#{region}"
    puts "Here's the CloudFormation console url: #{url}"
    exit 1
  when /No updates are to be performed/
    puts "There are no updates to be performed. Exiting.".colorize(:yellow)
    exit 1
  else
    raise
  end
end

#parameters ⇒ Object 



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
 
# File 'lib/ufo/stack.rb', line 97

def parameters
  create_elb, elb_target_group = context.elb_options

  network = Setting::Profile.new(:network, settings[:network_profile]).data
  # pp network
  elb_subnets = network[:elb_subnets] && !network[:elb_subnets].empty? ?
                network[:elb_subnets] :
                network[:ecs_subnets]

  hash = {
    Vpc: network[:vpc],
    ElbSubnets: elb_subnets.join(','),
    EcsSubnets: network[:ecs_subnets].join(','),

    CreateElb: create_elb,
    ElbTargetGroup: elb_target_group,
    ElbEipIds: context.elb_eip_ids,

    EcsDesiredCount: current_desired_count,
    EcsTaskDefinition: task_definition_arn,
  }

  hash[:EcsSecurityGroups] = network[:ecs_security_groups].join(',') if network[:ecs_security_groups]
  hash[:ElbSecurityGroups] = network[:elb_security_groups].join(',') if network[:elb_security_groups]

  hash.map do |k,v|
    if v == :use_previous_value
      { parameter_key: k, use_previous_value: true }
    else
      { parameter_key: k, parameter_value: v }
    end
  end
end

#perform(action) ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/ufo/stack.rb', line 64

def perform(action)
  puts "#{action[0..-2].capitalize}ing stack #{@stack_name.colorize(:green)}..."
  # Example: cloudformation.send("update_stack", stack_options)
  cloudformation.send("#{action}_stack", stack_options)
rescue Aws::CloudFormation::Errors::ValidationError => e
  handle_stack_error(e)
end

#rollback_complete?(stack) ⇒ Boolean

Returns:

  • (Boolean) 


195
196
197
 
# File 'lib/ufo/stack.rb', line 195

def rollback_complete?(stack)
  stack.stack_status == 'ROLLBACK_COMPLETE'
end

#save_template ⇒ Object

Store template in tmp in case for debugging



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ufo/stack.rb', line 158

def save_template
  path = "/tmp/ufo/#{@stack_name}/stack.yml"
  FileUtils.mkdir_p(File.dirname(path))
  IO.write(path, template_body)
  puts "Generated template saved at: #{path}"

  path = "/tmp/ufo/#{@stack_name}/parameters.yml"
  IO.write(path, JSON.pretty_generate(parameters))
  puts "Generated parameters saved at: #{path}"
end

#stack_options ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ufo/stack.rb', line 84

def stack_options
  save_template
  if ENV['SAVE_TEMPLATE_EXIT']
    puts "Template saved. Exiting."
    exit 1
  end
  {
    parameters: parameters,
    stack_name: @stack_name,
    template_body: template_body,
  }
end

#task_definition_arn ⇒ Object 



151
152
153
154
 
# File 'lib/ufo/stack.rb', line 151

def task_definition_arn
  resp = ecs.describe_task_definition(task_definition: @task_definition)
  resp.task_definition.task_definition_arn
end

#template_body ⇒ Object

do not memoize template_body it can change for a rename retry



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ufo/stack.rb', line 73

def template_body
  custom_template = "#{Ufo.root}/.ufo/settings/cfn/stack.yml"
  path = if File.exist?(custom_template)
           custom_template
         else
           # built-in default
           File.expand_path("../cfn/stack.yml", File.dirname(__FILE__))
         end
  RenderMePretty.result(path, context: context.scope)
end

#updatable?(stack) ⇒ Boolean

Returns:

  • (Boolean) 


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

def updatable?(stack)
  stack.stack_status =~ /_COMPLETE$/
end