Module: MovableInk::AWS::EC2

Included in:
MovableInk::AWS
Defined in:
lib/movable_ink/aws/ec2.rb

Instance Method Summary collapse

Instance Method Details

#all_instances(region: my_region, no_filter: false, client: nil) ⇒ Object 



42
43
44
45
 
# File 'lib/movable_ink/aws/ec2.rb', line 42

def all_instances(region: my_region, no_filter: false, client: nil)
  @all_instances ||= {}
  @all_instances[region] ||= load_all_instances(region, no_filter: no_filter, client: client)
end

#assign_ip_address(role:) ⇒ Object 



251
252
253
254
255
256
257
258
 
# File 'lib/movable_ink/aws/ec2.rb', line 251

def assign_ip_address(role:)
  run_with_backoff do
    ec2.associate_address({
      instance_id: instance_id,
      allocation_id: available_elastic_ips(role: role).sample.allocation_id
    })
  end
end

#available_elastic_ips(role:) ⇒ Object 



247
248
249
 
# File 'lib/movable_ink/aws/ec2.rb', line 247

def available_elastic_ips(role:)
  unassigned_elastic_ips.select { |address| address.tags.detect { |t| t.key == 'mi:roles' && t.value == role } }
end

#default_filter ⇒ Object 



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/movable_ink/aws/ec2.rb', line 47

def default_filter
  [{
    name: 'instance-state-name',
    values: ['running']
  },
  {
    name: 'tag:mi:env',
    values: [mi_env]
  }]
end

#ec2(region: my_region, client: nil) ⇒ Object 



8
9
10
11
 
# File 'lib/movable_ink/aws/ec2.rb', line 8

def ec2(region: my_region, client: nil)
  @ec2_client ||= {}
  @ec2_client[region] ||= (client) ? client : Aws::EC2::Client.new(region: region)
end

#elastic_ip_address_exist?(public_ip:) ⇒ Boolean

Returns:

  • (Boolean) 


260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/movable_ink/aws/ec2.rb', line 260

def elastic_ip_address_exist?(public_ip:)
  expected_errors = [
    MovableInk::AWS::Errors::ExpectedError.new(Aws::EC2::Errors::InvalidAddressNotFound, [/Address \'#{public_ip}\' not found./])
  ]
  begin
    run_with_backoff(expected_errors: expected_errors) do
      ec2.describe_addresses({
        public_ips: [public_ip]
      })
      return true
    end
  rescue MovableInk::AWS::Errors::ServiceError, Aws::EC2::Errors::InvalidAddressNotFound
    return false
  end
  # returns false if it ran out of API retries
  return false
end

#elastic_ips ⇒ Object 



237
238
239
240
241
 
# File 'lib/movable_ink/aws/ec2.rb', line 237

def elastic_ips
  @all_elastic_ips ||= run_with_backoff do
    ec2.describe_addresses.addresses
  end
end

#get_managed_prefix_list_entries(managed_prefix_list_name) ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/movable_ink/aws/ec2.rb', line 278

def get_managed_prefix_list_entries(managed_prefix_list_name)
  entries = []
  run_with_backoff do
    result = ec2.describe_managed_prefix_lists({filters: [{name: "prefix-list-name", values: [managed_prefix_list_name]}]})
    raise MovableInk::AWS::Errors::ServiceError if result.prefix_lists.nil? || result.prefix_lists[0].nil?
    prefix_list_id = result.prefix_lists[0].prefix_list_id
    result = ec2.get_managed_prefix_list_entries({prefix_list_id: prefix_list_id})
    entries = result.data.entries.map {|e| e.cidr}
  end
  return entries
end

#instance_ip_addresses_by_role(role:, exclude_roles: [], region: my_region, availability_zone: nil, exact_match: false, use_cache: true) ⇒ Object 



204
205
206
 
# File 'lib/movable_ink/aws/ec2.rb', line 204

def instance_ip_addresses_by_role(role:, exclude_roles: [], region: my_region, availability_zone: nil, exact_match: false, use_cache: true)
  private_ip_addresses(instances(role: role, exclude_roles: exclude_roles, region: region, availability_zone: availability_zone, exact_match: exact_match, use_cache: use_cache))
end

#instance_ip_addresses_by_role_ordered(role:, exclude_roles: [], region: my_region, exact_match: false) ⇒ Object 



208
209
210
211
212
213
 
# File 'lib/movable_ink/aws/ec2.rb', line 208

def instance_ip_addresses_by_role_ordered(role:, exclude_roles: [], region: my_region, exact_match: false)
  instances = instances(role: role, exclude_roles: exclude_roles, region: region, exact_match: exact_match)
  instances_in_my_az = instances.select { |instance| instance.placement.availability_zone == availability_zone }
  ordered_instances = instances_in_my_az.shuffle + (instances - instances_in_my_az).shuffle
  private_ip_addresses(ordered_instances)
end

#instance_tags ⇒ Object 



68
69
70
71
72
73
74
 
# File 'lib/movable_ink/aws/ec2.rb', line 68

def instance_tags
  @instance_tags ||= run_with_backoff(quiet: true) do
    ec2.describe_tags({
      filters: [{ name: 'resource-id', values: [instance_id] } ]
    }).tags
  end
end

#instances(role:, exclude_roles: [], region: my_region, availability_zone: nil, exact_match: false, use_cache: true, discovery_type: 'ec2') ⇒ Object 



182
183
184
185
186
187
188
189
190
 
# File 'lib/movable_ink/aws/ec2.rb', line 182

def instances(role:, exclude_roles: [], region: my_region, availability_zone: nil, exact_match: false, use_cache: true, discovery_type: 'ec2')
  if discovery_type == 'ec2'
    instances_with_ec2_discovery(role: role, exclude_roles: exclude_roles, region: region, availability_zone: availability_zone, exact_match: exact_match, use_cache: use_cache)
  elsif discovery_type == 'consul'
    instances_with_consul_discovery(role: role, region: region, availability_zone: availability_zone)
  else
    raise MovableInk::AWS::Errors::InvalidDiscoveryTypeError
  end
end

#instances_with_consul_discovery(role:, region: my_region, availability_zone: nil) ⇒ Object 



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/movable_ink/aws/ec2.rb', line 111

def instances_with_consul_discovery(role:, region: my_region, availability_zone: nil)
  if role == nil || role == ''
    raise MovableInk::AWS::Errors::RoleNameRequiredError
  end

  consul_service_options = {
    dc: datacenter(region: region),
    stale: true,
    cached: true,
    passing: true,
  }
  consul_service_options[:node_meta] = "availability_zone:#{availability_zone}" unless availability_zone.nil?

  # We replace underscores with dashes in the role name in order to comply with
  # consul service naming conventions while still retaining the role name we use
  # within MI configuration
  Diplomat::Health.service(role.gsub('_', '-'), consul_service_options).map { |endpoint|
    if endpoint.Node.dig('Meta', 'external-source') == 'kubernetes'
      map_k8s_consul_endpoint(endpoint, role)
    else
      map_ec2_consul_endpoint(endpoint)
    end
  }
end

#instances_with_ec2_discovery(role:, exclude_roles: [], region: my_region, availability_zone: nil, exact_match: false, use_cache: true) ⇒ Object 



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
 
# File 'lib/movable_ink/aws/ec2.rb', line 80

def instances_with_ec2_discovery(role:, exclude_roles: [], region: my_region, availability_zone: nil, exact_match: false, use_cache: true)
  roles = role.split(/\s*,\s*/)
  if use_cache == false
    filter = default_filter.push({
      name: 'tag:mi:roles',
      values: roles
    })
    instances = load_all_instances(region, filter: filter)
  else
    instances = all_instances(region: region).select { |instance|
      instance.tags.select{ |tag| tag.key == 'mi:roles' }.detect { |tag|
        tag_roles = tag.value.split(/\s*,\s*/)
        if exact_match
          tag_roles == roles
        else
          exclude_roles.push('decommissioned')
          tag_roles.any? { |tag_role| roles.include?(tag_role) } && !tag_roles.any? { |role| exclude_roles.include?(role) }
        end
      }
    }
  end

  if availability_zone
    instances.select { |instance|
      instance.placement.availability_zone == availability_zone
    }
  else
    instances
  end
end

#load_all_instances(region, no_filter: false, filter: nil, client: nil) ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'lib/movable_ink/aws/ec2.rb', line 58

def load_all_instances(region, no_filter: false, filter: nil, client: nil)
  filters = no_filter ? nil : (filter || default_filter)

  run_with_backoff do
    ec2(region: region, client: client).describe_instances(filters: filters).flat_map do |resp|
      resp.reservations.flat_map(&:instances)
    end
  end
end

#load_mi_env ⇒ Object 



26
27
28
29
30
31
32
 
# File 'lib/movable_ink/aws/ec2.rb', line 26

def load_mi_env
  instance_tags
    .detect { |tag| tag.key == 'mi:env' }
    .value
rescue NoMethodError
  raise MovableInk::AWS::Errors::NoEnvironmentTagError
end

#map_ec2_consul_endpoint(endpoint) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/movable_ink/aws/ec2.rb', line 158

def map_ec2_consul_endpoint(endpoint)
  OpenStruct.new ({
    private_ip_address: endpoint.Node.dig('Address'),
    instance_id: endpoint.Node.dig('Meta', 'instance_id'),
    tags: [
      {
        key: 'Name',
        value: endpoint.Node.dig('Node')
      },
      {
        key: 'mi:roles',
        value: endpoint.Node.dig('Meta', 'mi_roles')
      },
      {
        key: 'mi:monitoring_roles',
        value: endpoint.Node.dig('Meta', 'mi_monitoring_roles')
      }
    ],
    placement: {
      availability_zone: endpoint.Node.dig('Meta', 'availability_zone')
    }
  })
end

#map_k8s_consul_endpoint(endpoint, role) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/movable_ink/aws/ec2.rb', line 136

def map_k8s_consul_endpoint(endpoint, role)
  OpenStruct.new ({
    private_ip_address: endpoint.Service.dig('Address'),
    instance_id: nil,
    tags: [
      {
        key: 'Name',
        value: endpoint.Service.dig('ID')
      },
      {
        key: 'mi:roles',
        value: role
      },
      {
        key: 'mi:monitoring_roles',
        value: role
      }
    ],
    placement: { availability_zone: nil }
  })
end

#me ⇒ Object 



76
77
78
 
# File 'lib/movable_ink/aws/ec2.rb', line 76

def me
  @me ||= all_instances.select{|instance| instance.instance_id == instance_id}.first rescue nil
end

#mi_env ⇒ Object 



17
18
19
20
21
22
23
24
 
# File 'lib/movable_ink/aws/ec2.rb', line 17

def mi_env
  @mi_env ||= if File.exist?(mi_env_cache_file_path)
    environments = JSON.parse(File.read(mi_env_cache_file_path))
    environments[my_region] || load_mi_env
  else
    load_mi_env
  end
end

#mi_env_cache_file_path ⇒ Object 



13
14
15
 
# File 'lib/movable_ink/aws/ec2.rb', line 13

def mi_env_cache_file_path
  '/etc/movableink/environments.json'
end

#private_ip_addresses(instances) ⇒ Object 



200
201
202
 
# File 'lib/movable_ink/aws/ec2.rb', line 200

def private_ip_addresses(instances)
  instances.map(&:private_ip_address)
end

#redis(host, port) ⇒ Object 



222
223
224
 
# File 'lib/movable_ink/aws/ec2.rb', line 222

def redis(host, port)
  {"host" => host, "port" => port}
end

#redis_by_role(role, port, availability_zones = []) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/movable_ink/aws/ec2.rb', line 215

def redis_by_role(role, port, availability_zones = [])
  if availability_zones.class != Array
    raise MovableInk::AWS::Errors::AvailabilityZonesListInvalidError
  end

  redis_instances = []

  def redis(host, port)
    {"host" => host, "port" => port}
  end

  if availability_zones.length > 0
    availability_zones.each do |az|
      redis_instances << instance_ip_addresses_by_role(role: role, availability_zone: az).inject([]) { |redii, instance| redii.push(redis(instance, port)) }
    end
  else
    redis_instances << instance_ip_addresses_by_role(role: role).inject([]) { |redii, instance| redii.push(redis(instance, port)) }
  end

  redis_instances.flatten.shuffle
end

#statsd_host ⇒ Object 



196
197
198
 
# File 'lib/movable_ink/aws/ec2.rb', line 196

def statsd_host
  instance_ip_addresses_by_role(role: 'statsd', availability_zone: availability_zone, use_cache: false).sample
end

#thopter ⇒ Object 



192
193
194
 
# File 'lib/movable_ink/aws/ec2.rb', line 192

def thopter
  private_ip_addresses(thopter_instance).first
end

#thopter_instance ⇒ Object 



34
35
36
37
38
39
40
 
# File 'lib/movable_ink/aws/ec2.rb', line 34

def thopter_instance
  @thopter_instance ||= all_instances(region: 'us-east-1').select do |instance|
    instance.tags.select{ |tag| tag.key == 'mi:roles' }.detect do |tag|
      tag.value.include?('thopter')
    end
  end
end

#unassigned_elastic_ips ⇒ Object 



243
244
245
 
# File 'lib/movable_ink/aws/ec2.rb', line 243

def unassigned_elastic_ips
  @unassigned_elastic_ips ||= elastic_ips.select { |address| address.association_id.nil? }
end