modules/mu/providers/cloudformation/cache_cluster.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
# An ElastiCache node or cluster as configured in {MU::Config::BasketofKittens::cache_clusters}
class CacheCluster < MU::Cloud::CacheCluster
@deploy = 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::cache_clusters}
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']
else
@mu_name ||=
if @config["create_replication_group"]
@deploy.getResourceName(@config["name"], max_length: 16, need_unique_string: true)
else
@deploy.getResourceName(@config["name"], max_length: 20, need_unique_string: true)
end
@mu_name.gsub!(/(--|-$)/i, "")
end
end
# Populate @cfm_template with a resource description for this cache
# cluster in CloudFormation language.
def create
@config['identifier'] = @mu_name
sg_param_name = nil
if @config["create_replication_group"]
@cfm_name, @cfm_template = MU::Cloud::CloudFormation.cloudFormationBase("cache_repl_group", self, name: @config['identifier'], scrub_mu_isms: @config['scrub_mu_isms']) if @cfm_template.nil?
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "ReplicationGroupDescription", @mu_name)
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "NumCacheClusters", @config['node_count'].to_s)
sg_param_name = "SecurityGroupIds"
else
@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?
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "ClusterName", @mu_name)
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "AZMode", @config["az_mode"]) if @config["az_mode"]
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "NumCacheNodes", @config['node_count'].to_s)
sg_param_name = "VpcSecurityGroupIds"
end
if @config['add_firewall_rules']
@config['add_firewall_rules'].each { |acl|
if acl["rule_id"]
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], sg_param_name, acl["rule_id"])
else
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], sg_param_name, { "Ref" => @dependencies["firewall_rule"][acl["rule_name"]].cloudobj.cfm_name })
end
}
end
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "Engine", @config['engine'])
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "EngineVersion", @config['engine_version']) if @config['engine_version']
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "Port", @config['port'])
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "CacheNodeType", @config['size'])
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "PreferredMaintenanceWindow", @config["preferred_maintenance_window"]) if @config["preferred_maintenance_window"]
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "AutoMinorVersionUpgrade", @config["auto_minor_version_upgrade"])
if @config["notification_topic_arn"]
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "NotificationTopicArn", @config["notification_topic_arn"])
end
if @config["engine"] == "redis"
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "SnapshotArns", @config["snapshot_arn"]) if @config["snapshot_arn"]
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "SnapshotRetentionLimit", @config["snapshot_retention_limit"]) if @config["snapshot_retention_limit"]
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "SnapshotWindow", @config["snapshot_window"]) if @config["snapshot_window"]
if !@config["create_replication_group"]
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "SnapshotName", @config["snapshot_id"]) if @config["snapshot_id"]
end
end
if @config.has_key?("parameter_group_family")
# XXX
# @config["parameter_group_name"] = @mu_name.downcase
# createParameterGroup
# config_struct[:cache_parameter_group_name] = @config["parameter_group_name"]
end
if !@config['vpc'].nil?
subnets_name, subnets_template = MU::Cloud::CloudFormation.cloudFormationBase("cache_subnets", name: @mu_name, scrub_mu_isms: @config['scrub_mu_isms'])
if !@config['vpc']['subnets'].nil?
@config['vpc']['subnets'].each { |subnet|
if !subnet["subnet_id"].nil?
MU::Cloud::CloudFormation.setCloudFormationProp(subnets_template[subnets_name], "SubnetIds", 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 { |subnet_obj|
if subnet_obj.name == subnet['subnet_name']
MU::Cloud::CloudFormation.setCloudFormationProp(subnets_template[subnets_name], "DependsOn", subnet_obj.cfm_name)
MU::Cloud::CloudFormation.setCloudFormationProp(subnets_template[subnets_name], "SubnetIds", { "Ref" => subnet_obj.cfm_name } )
end
}
end
}
end
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "CacheSubnetGroupName", { "Ref" => subnets_name } )
MU::Cloud::CloudFormation.setCloudFormationProp(@cfm_template[@cfm_name], "DependsOn", subnets_name)
@cfm_template.merge!(subnets_template)
end
end
# Placeholder. This is a NOOP for CloudFormation, which doesn't build
# resources directly.
# @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", "CacheCluster").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", "CacheCluster").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", "CacheCluster").isGlobal?
end
end
end
end
end