modules/mu/providers/cloudformation/loadbalancer.rb
# Copyright:: Copyright (c) 2016 eGlobalTech, Inc., all rights reserved
#
# Licensed under the BSD-3 license (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License in the root of the project or at
#
# http://egt-labs.com/mu/LICENSE.html
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module MU
class Cloud
class CloudFormation
# A load balancer as configured in {MU::Config::BasketofKittens::loadbalancers}
class LoadBalancer < MU::Cloud::LoadBalancer
@deploy = nil
@lb = nil
attr_reader :mu_name
attr_reader :config
attr_reader :cloud_id
attr_reader :cfm_template
attr_reader :cfm_name
# @param mommacat [MU::MommaCat]: A {MU::Mommacat} object containing the deploy of which this resource is/will be a member.
# @param kitten_cfg [Hash]: The fully parsed and resolved {MU::Config} resource descriptor as defined in {MU::Config::BasketofKittens::loadbalancers}
def initialize(mommacat: nil, kitten_cfg: nil, mu_name: nil, cloud_id: nil)
@deploy = mommacat
@config = kitten_cfg
@cloud_id ||= cloud_id
if !mu_name.nil?
@mu_name = mu_name
elsif @config['scrub_mu_isms']
@mu_name = @config['name'].dup
else
@mu_name = @deploy.getResourceName(@config["name"], max_length: 32, need_unique_string: true)
@mu_name.gsub!(/[^\-a-z0-9]/i, "-") # AWS ELB naming rules
end
end
# Populate @cfm_template with a resource description for this load
# balancer in CloudFormation language.
def create
@cfm_name, @cfm_template = MU::Cloud::CloudFormation.cloudFormationBase(self.class.cfg_name, self, tags: @config['tags'], scrub_mu_isms: @config['scrub_mu_isms']) if @cfm_template.nil?
if @config['override_name']
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "LoadBalancerName", @config['override_name'])
else
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "LoadBalancerName", @mu_name)
end
@config["cross_zone"] = !@config["cross_zone_unstickiness"]
@config["health_check"] = @config["healthcheck"]
@config["access_logging_policy"] = @config["access_log"]
["cross_zone", "health_check", "access_logging_policy"].each { |arg|
if !@config[arg].nil?
key = ""
val = @config[arg]
arg.split(/_/).each { |chunk| key = key + chunk.capitalize }
if val.is_a?(Hash)
val = {}
@config[arg].each_pair { |name, value|
newkey = ""
name.split(/_/).each { |chunk| newkey = newkey + chunk.capitalize }
val[newkey] = value
}
end
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], key, val)
end
}
if @config['add_firewall_rules']
@config['add_firewall_rules'].each { |acl|
if acl["rule_id"]
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "SecurityGroups", acl["rule_id"])
else
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "SecurityGroups", { "Ref" => @dependencies["firewall_rule"][acl["rule_name"]].cloudobj.cfm_name } )
end
}
end
@config['listeners'].each { |listener|
prop = {
"InstancePort" => listener['instance_port'].to_s,
"InstanceProtocol" => listener['instance_protocol'],
"LoadBalancerPort" => listener['lb_port'].to_s,
"Protocol" => listener['lb_protocol']
}
if !listener['ssl_certificate_id'].nil?
prop["SSLCertificateId"] = listener['ssl_certificate_id']
elsif !listener['ssl_certificate_name'].nil?
raise "Cannot use ssl_certificate_name when targeting CloudFormation, bust use ssl_certificate_id with full ARN"
end
MU::Cloud::CloudFormation.setCloudFormationProp(
@cfm_template[@cfm_name],
"Listeners",
prop
)
}
["lb_cookie_stickiness_policy", "app_cookie_stickiness_policy"].each { |policy|
if @config[policy]
key = ""
policy.split(/_/).each { |chunk| key = key + chunk.capitalize }
desc = { "PolicyName" => @config[policy]['name'] }
if @config[policy]['timeout']
desc["CookieExpirationPeriod"] = @config[policy]['timeout']
end
if @config[policy]['cookie']
desc["CookieName"] = @config[policy]['cookie']
end
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], key, desc)
end
}
if @config['idle_timeout']
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "ConnectionSettings", { "IdleTimeout" => @config['idle_timeout'] })
end
if @config['private']
if @config['private'].class.to_s == "MU::Config::Tail"
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "Scheme", @config['private'])
else
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "Scheme", "internal")
end
else
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "Scheme", "internet-facing")
end
if @config['connection_draining_timeout'] and @config['connection_draining_timeout'] >= 0
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "ConnectionDrainingPolicy", { "Enabled" => true, "Timeout" => @config['connection_draining_timeout'] })
end
if !@config['vpc'].nil? and !@config["vpc"]["subnets"].nil? and @config["vpc"]["subnets"].size > 0
@config["vpc"]["subnets"].each { |subnet|
if !subnet["subnet_id"].nil?
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "Subnets", subnet["subnet_id"])
elsif @dependencies.has_key?("vpc") and @dependencies["vpc"].has_key?(@config["vpc"]["vpc_name"])
@dependencies["vpc"][@config["vpc"]["vpc_name"]].subnets.each { |sibling_subnet|
if sibling_subnet.name == subnet['subnet_name'] and !sibling_subnet.cloudobj.nil?
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "DependsOn", sibling_subnet.cloudobj.cfm_name)
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "Subnets", { "Ref" => sibling_subnet.cloudobj.cfm_name } )
end
}
end
}
# XXX something about AZs
else
# Default to "sit in every possible AZ"
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "AvailabilityZones", { "Fn::GetAZs" => { "Ref" => "AWS::Region" } } )
end
end
# Return the metadata for this LoadBalancer
# @return [Hash]
def notify
{}
end
# Placeholder. This is a NOOP for CloudFormation, which doesn't build
# resources directly.
def self.find(*args)
MU.log "find() not implemented for CloudFormation layer", MU::DEBUG
nil
end
# Placeholder. This is a NOOP for CloudFormation, which doesn't build
# resources directly.
def self.cleanup(*args)
MU.log "cleanup() not implemented for CloudFormation layer", MU::DEBUG
nil
end
# Cloud-specific configuration properties.
# @param config [MU::Config]: The calling MU::Config object
# @return [Array<Array,Hash>]: List of required fields, and json-schema Hash of cloud-specific configuration parameters for this resource
def self.schema(config)
MU::Cloud.resourceClass("AWS", "LoadBalancer").schema(config)
end
# Cloud-specific pre-processing of {MU::Config::BasketofKittens::servers}, bare and unvalidated.
# @param server [Hash]: The resource to process and validate
# @param configurator [MU::Config]: The overall deployment configurator of which this resource is a member
# @return [Boolean]: True if validation succeeded, False otherwise
def self.validateConfig(server, configurator)
MU::Cloud.resourceClass("AWS", "LoadBalancer").validateConfig(server, configurator)
end
# Does this resource type exist as a global (cloud-wide) artifact, or
# is it localized to a region/zone?
# @return [Boolean]
def self.isGlobal?
MU::Cloud.resourceClass("AWS", "LoadBalancer").isGlobal?
end
end
end
end
end