Class: Ufo::Stack::Context

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Ufo::Settings

#cfn, #network, #settings

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) ⇒ Context

Returns a new instance of Context.



8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/ufo/stack/context.rb', line 8

def initialize(options)
  @options = options
  @task_definition = options[:task_definition]
  @service = options[:service]
  # no need to adjust @cluster or @stack_name because it was adjusted in Stack#initialize
  @cluster = options[:cluster].dup # Thor options are frozen, we thaw it because CustomProperties#substitute_variables does a sub!
  @stack_name = options[:stack_name]

  @stack = options[:stack]
  @new_stack = !@stack
end

Instance Attribute Details

#stack_name ⇒ Object (readonly)

Returns the value of attribute stack_name.



7
8
9
 
# File 'lib/ufo/stack/context.rb', line 7

def stack_name
  @stack_name
end

Instance Method Details

#build_subnet_mappings(allocations) ⇒ Object 



211
212
213
214
215
216
217
 
# File 'lib/ufo/stack/context.rb', line 211

def build_subnet_mappings(allocations)
  mappings = []
  allocations.sort.each_with_index do |allocation_id, i|
    mappings << [allocation_id, network[:elb_subnets][i]]
  end
  mappings
end

#build_subnet_mappings!(allocations) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/ufo/stack/context.rb', line 198

def build_subnet_mappings!(allocations)
  unless allocations.size == network[:elb_subnets].size
    puts "ERROR: The allocation_ids must match in length to the subnets.".color(:red)
    puts "Please double check that .ufo/settings/network/#{settings.network_profile} has the same number of subnets as the eip allocation ids are you specifying."
    subnets = network[:elb_subnets]
    puts "Conigured subnets: #{subnets.inspect}"
    puts "Specified allocation ids: #{allocations.inspect}"
    exit 1
  end

  build_subnet_mappings(allocations)
end

#container ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/ufo/stack/context.rb', line 124

def container
  task_definition = Builder::Resources::TaskDefinition::Reconstructor.new(@task_definition, @options[:rollback]).reconstruct

  container_def = task_definition["ContainerDefinitions"].first
  requires_compatibilities = task_definition["RequiresCompatibilities"]
  fargate = requires_compatibilities && requires_compatibilities == ["FARGATE"]
  network_mode = task_definition["NetworkMode"]

  mappings = container_def["PortMappings"] || []
  unless mappings.empty?
    port = mappings.first["ContainerPort"]
  end

  result =  {
    name: container_def["Name"],
    fargate: fargate,
    network_mode: network_mode, # awsvpc, bridge, etc
  }
  result[:port] = port if port
  result
end

#create_elb? ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
78
 
# File 'lib/ufo/stack/context.rb', line 75

def create_elb?
  create_elb, _ = elb_options
  create_elb == "true" # convert to boolean
end

#create_listener_ssl? ⇒ Boolean

if the configuration is set to anything then enable it

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/ufo/stack/context.rb', line 71

def create_listener_ssl?
  cfn.dig(:ListenerSsl, :Port) || cfn.dig(:listener_ssl, :port) # backwards compatiblity
end

#default_elb_options ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/ufo/stack/context.rb', line 108

def default_elb_options
  # cannot use :use_previous_value because need to know the create_elb value to
  # compile a template with the right DependsOn for the Ecs service
  unless @new_stack
    create_elb = get_parameter_value(@stack, "CreateElb")
    elb_target_group = get_parameter_value(@stack, "ElbTargetGroup")
    return [create_elb, elb_target_group]
  end

  # default is to create the load balancer is if container name is web
  # and no --elb option is provided
  create_elb = container[:name] == "web" ? "true" : "false"
  elb_target_group = ""
  [create_elb, elb_target_group]
end

#default_listener_protocol ⇒ Object 



57
58
59
60
61
62
63
64
 
# File 'lib/ufo/stack/context.rb', line 57

def default_listener_protocol
  port = cfn.dig(:Listener, :Port) || cfn.dig(:listener, :port) # backwards compatiblity
  if elb_type == 'network'
    port == 443 ? 'TLS' : 'TCP'
  else
    port == 443 ? 'HTTPS' : 'HTTP'
  end
end

#default_listener_ssl_protocol ⇒ Object 



66
67
68
 
# File 'lib/ufo/stack/context.rb', line 66

def default_listener_ssl_protocol
  elb_type == 'network' ? 'TLS' : 'HTTPS'
end

#default_target_group_protocol ⇒ Object 



52
53
54
55
 
# File 'lib/ufo/stack/context.rb', line 52

def default_target_group_protocol
  return 'TCP' if elb_type == 'network'
  'HTTP'
end

#elb_eip_ids ⇒ Object

Returns string, used as CloudFormation parameter.



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/ufo/stack/context.rb', line 185

def elb_eip_ids
  return '' if reset_empty_eip_ids?

  elb_eip_ids = normalize_elb_eip_ids
  return elb_eip_ids.join(',') unless elb_eip_ids.empty?

  unless @new_stack
    return get_parameter_value(@stack, "ElbEipIds")
  end

  ''
end

#elb_options ⇒ Object

If –elb is not set at all and is nil, then it defaults to creating the load balancer if the ecs service has a container name “web”.

–elb ” - will not crete an elb –elb ‘auto’ - creates an elb –elb arn:… - will not create elb and use the existing target group



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/ufo/stack/context.rb', line 87

def elb_options
  case @options[:elb]
  when "auto", "true", "yes"
    create_elb = "true"
    elb_target_group = ""
  when "false", "0", "no"
    create_elb = "false"
    elb_target_group = ""
  when /^arn:aws:elasticloadbalancing.*targetgroup/
    create_elb = "false"
    elb_target_group = @options[:elb]
  when "", nil
    create_elb, elb_target_group = default_elb_options
  else
    puts "Invalid --elb option provided: #{@options[:elb].inspect}".color(:red)
    puts "Exiting."
    exit 1
  end
  [create_elb, elb_target_group]
end

#elb_type ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/ufo/stack/context.rb', line 219

def elb_type
  # if option explicitly specified then change the elb type
  return @options[:elb_type] if @options[:elb_type]
  # user is trying to create a network load balancer if --elb-eip-ids is used
  elb_eip_ids = normalize_elb_eip_ids
  if !elb_eip_ids.empty?
    return "network"
  end

  # if not explicitly set, new stack will defeault to application load balancer
  if @new_stack # default for new stack
    return "application"
  end

  # find existing load balancer for type
  resp = cloudformation.describe_stack_resources(stack_name: @stack_name)
  resources = resp.stack_resources
  elb_resource = resources.find do |resource|
    resource.logical_resource_id == "Elb"
  end

  # In the case when stack exists and there is no elb resource, the elb type
  # doesnt really matter because the elb wont be created since the CreateElb
  # parameter is set to false. The elb type only needs to be set for the
  # template to validate.
  return "application" unless elb_resource

  resp = elb.describe_load_balancers(load_balancer_arns: [elb_resource.physical_resource_id])
  load_balancer = resp.load_balancers.first
  load_balancer.type
end

#get_parameter_value(stack, key) ⇒ Object 



147
148
149
150
151
152
 
# File 'lib/ufo/stack/context.rb', line 147

def get_parameter_value(stack, key)
  param = stack.parameters.find do |p|
    p.parameter_key == key
  end
  param.parameter_value if param
end

#has_dns_name? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/ufo/stack/context.rb', line 48

def has_dns_name?
  cfn.dig(:Dns, :Name) || cfn.dig(:dns, :name) # backwards compatiblity
end

#normalize_elb_eip_ids ⇒ Object 



178
179
180
181
182
 
# File 'lib/ufo/stack/context.rb', line 178

def normalize_elb_eip_ids
  elb_eip_ids = @options[:elb_eip_ids] || []
  elb_eip_ids.uniq!
  elb_eip_ids
end

#reset_empty_eip_ids? ⇒ Boolean

Returns:

  • (Boolean) 


161
162
163
164
 
# File 'lib/ufo/stack/context.rb', line 161

def reset_empty_eip_ids?
  # reset and remove eip allocation ids check
  @options[:elb_eip_ids] && @options[:elb_eip_ids].detect { |x| [' ', 'empty'].include?(x) }
end

#scheduling_strategy ⇒ Object 



154
155
156
157
158
159
 
# File 'lib/ufo/stack/context.rb', line 154

def scheduling_strategy
  unless @new_stack
    scheduling_strategy = get_parameter_value(@stack, "EcsSchedulingStrategy")
  end
  scheduling_strategy || 'REPLICA' # defaults to REPLICA
end

#scope ⇒ Object 



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

def scope
  scope = Ufo::TemplateScope.new(Ufo::DSL::Helper.new, nil)
  # Add additional variable to scope for CloudFormation template.
  # Dirties the scope but needed.
  vars = {
    service: @service,
    cluster: @cluster,
    stack_name: @stack_name, # used in custom_properties
    container: container,
    # to reconstruct TaskDefinition in the CloudFormation template
    task_definition: @task_definition,
    rollback_definition_arn: @options[:rollback_definition_arn],
    # elb options remember that their 'state'
    create_elb: create_elb?, # helps set Ecs DependsOn
    elb_type: elb_type,
    subnet_mappings: subnet_mappings,
    create_route53: create_elb? && has_dns_name?,
    default_target_group_protocol: default_target_group_protocol,
    default_listener_protocol: default_listener_protocol,
    default_listener_ssl_protocol: default_listener_ssl_protocol,
    create_listener_ssl: create_listener_ssl?,
  }

  scope.assign_instance_variables(vars)
  scope
end

#subnet_mappings ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/ufo/stack/context.rb', line 166

def subnet_mappings
  return [] if reset_empty_eip_ids?

  elb_eip_ids = normalize_elb_eip_ids
  return build_subnet_mappings!(elb_eip_ids) unless elb_eip_ids.empty?

  unless @new_stack
    elb_eip_ids = get_parameter_value(@stack, "ElbEipIds").split(',')
    build_subnet_mappings(elb_eip_ids)
  end
end