Module: SparkleFormation::Provider::Heat

Defined in:
lib/sparkle_formation/provider/heat.rb

Overview

Heat specific implementation

Instance Method Summary collapse

Instance Method Details

#apply_deep_nesting(*args) {|stack, resource, s_name| ... } ⇒ SparkleFormation::SparkleStruct

Apply deeply nested stacks. This is the new nesting approach and does not bubble parameters up to the root stack. Parameters are isolated to the stack resource itself and output mapping is automatically applied.

Yield Parameters:

  • stack (SparkleFormation) —

    stack instance

  • resource (AttributeStruct) —

    the stack resource

  • s_name (String) —

    stack resource name

Yield Returns:

  • (Hash) —

    key/values to be merged into resource properties

Returns:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/sparkle_formation/provider/heat.rb', line 30

def apply_deep_nesting(*args, &block)
  outputs = collect_outputs
  nested_stacks(:with_resource).each do |stack, resource|
    unless stack.nested_stacks.empty?
      stack.apply_deep_nesting(*args)
    end
    stack.compile.parameters.keys!.each do |parameter_name|
      if output_name = output_matched?(parameter_name, outputs.keys)
        next if outputs[output_name] == stack
        stack_output = stack.make_output_available(output_name, outputs)
        resource.properties.parameters._set(parameter_name, stack_output)
      end
    end
  end
  if block_given?
    extract_templates(&block)
  end
  compile
end

#apply_shallow_nesting(*args) {|resource_name, stack| ... } ⇒ SparkleFormation::SparkleStruct

Apply shallow nesting. This style of nesting will bubble parameters up to the root stack. This type of nesting is the original and now deprecated, but remains for compat issues so any existing usage won’t be automatically busted.

Yield Parameters:

  • resource_name (String) —

    name of stack resource

  • stack (SparkleFormation) —

    nested stack

Yield Returns:

  • (String) —

    Remote URL storage for template

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/sparkle_formation/provider/heat.rb', line 59

def apply_shallow_nesting(*args, &block)
  parameters = compile.parameters
  output_map = {}
  nested_stacks(:with_resource, :with_name).each do |_stack, stack_resource, stack_name|
    remap_nested_parameters(compile, parameters, stack_name, stack_resource, output_map)
  end
  extract_templates(&block)
  if args.include?(:bubble_outputs)
    output_map.each do |o_name, o_val|
      compile.outputs._set(o_name).value compile._stack_output(*o_val)
    end
  end
  compile
end

#generate_policy ⇒ Hash

Generate policy for stack

Returns:

  • (Hash) 


16
17
18
 
# File 'lib/sparkle_formation/provider/heat.rb', line 16

def generate_policy
  {}
end

#make_output_available(output_name, outputs) ⇒ Object

Extract output to make available for stack parameter usage at the current depth

Parameters:

  • output_name (String) —

    name of output

  • outputs (Hash) —

    listing of outputs



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
110
111
112
113
114
115
 
# File 'lib/sparkle_formation/provider/heat.rb', line 80

def make_output_available(output_name, outputs)
  bubble_path = outputs[output_name].root_path - root_path
  drip_path = root_path - outputs[output_name].root_path
  bubble_path.each_slice(2) do |base_sparkle, ref_sparkle|
    next unless ref_sparkle
    base_sparkle.compile.outputs._set(output_name)._set(
      :value, base_sparkle.compile._stack_output(
        ref_sparkle.name, output_name
      )
    )
  end
  if bubble_path.empty?
    if drip_path.size == 1
      parent = drip_path.first.parent
      if parent && !parent.compile.parameters._set(output_name).nil?
        return compile.parameter!(output_name)
      end
    end
    raise ArgumentError.new "Failed to detect available bubbling path for output `#{output_name}`. " <<
                              "This may be due to a circular dependency! " <<
                              "(Output Path: #{outputs[output_name].root_path.map(&:name).join(" > ")} " <<
                              "Requester Path: #{root_path.map(&:name).join(" > ")})"
  end
  result = compile._stack_output(bubble_path.first.name, output_name)
  if drip_path.size > 1
    parent = drip_path.first.parent
    drip_path.unshift(parent) if parent
    drip_path.each_slice(2) do |base_sparkle, ref_sparkle|
      next unless ref_sparkle
      base_sparkle.compile.resources[ref_sparkle.name].properties.parameters._set(output_name, result)
      ref_sparkle.compile.parameters._set(output_name).type "string" # TODO: <<<<------ type check and prop
      result = compile._parameter(output_name)
    end
  end
  result
end

#remap_nested_parameters(template, parameters, stack_name, stack_resource, output_map) ⇒ TrueClass

Note:

if parameter has includes ‘StackUnique` a new parameter will be added to container stack and it will not use outputs

Extract parameters from nested stacks. Check for previous nested stack outputs that match parameter. If match, set parameter to use output. If no match, check container stack parameters for match. If match, set to use ref. If no match, add parameter to container stack parameters and set to use ref.

Parameters:

  • template (Hash) —

    template being processed

  • parameters (Hash) —

    top level parameter set being built

  • stack_name (String) —

    name of stack resource

  • stack_resource (Hash) —

    duplicate of stack resource contents

  • output_map (Hash) —

    mapping of output names to required stack output access

Returns:

  • (TrueClass) 


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/sparkle_formation/provider/heat.rb', line 131

def remap_nested_parameters(template, parameters, stack_name, stack_resource, output_map)
  nested_template = stack_resource.properties.stack.compile
  stack_parameters = nested_template.parameters
  unless stack_parameters.nil?
    stack_parameters._keys.each do |pname|
      pval = stack_parameters[pname]
      unless pval.stack_unique.nil?
        check_name = [stack_name, pname].join
      else
        check_name = pname
      end
      if !parameters._set(check_name).nil?
        template.resources._set(stack_name).properties.parameters._set(pname, template._parameter(check_name))
      elsif output_map[check_name]
        template.resources._set(stack_name).properties.parameters._set(pname)
        template._stack_output(*output_map[check_name])
      else
        parameters._set(check_name, pval)
        template.resources._set(stack_name).properties.parameters._set(pname, template._parameter(check_name))
      end
    end
  end
  unless nested_template.outputs.nil?
    nested_template.outputs.keys!.each do |oname|
      output_map[oname] = [stack_name, oname]
    end
  end
  true
end

#stack_resource_type ⇒ String

Returns Type string for OpenStack HEAT stack resource.

Returns:

  • (String) —

    Type string for OpenStack HEAT stack resource



9
10
11
 
# File 'lib/sparkle_formation/provider/heat.rb', line 9

def stack_resource_type
  "OS::Heat::Stack"
end