Class: Terraspace::Compiler::Strategy::Tfvar::Layer

Inherits:
Object
  • Object
show all
Defined in:
lib/terraspace/compiler/strategy/tfvar/layer.rb

Instance Method Summary collapse

Constructor Details

#initialize(mod) ⇒ Layer

Returns a new instance of Layer.



3
4
5
 
# File 'lib/terraspace/compiler/strategy/tfvar/layer.rb', line 3

def initialize(mod)
  @mod = mod
end

Instance Method Details

#layer_levels(prefix = nil) ⇒ Object

adds prefix and to each layer pair that has base and Terraspace.env. IE:

"#{prefix}/base"
"#{prefix}/#{Terraspace.env}"



81
82
83
84
85
86
87
88
 
# File 'lib/terraspace/compiler/strategy/tfvar/layer.rb', line 81

def layer_levels(prefix=nil)
  levels = ["base", Terraspace.env, @mod.instance] # layer levels
  env_levels = levels.map { |l| "#{Terraspace.env}/#{l}" } # env folder also
  levels = levels + env_levels
  levels.map do |i|
    [prefix, i].compact.join('/')
  end
end

#layers ⇒ Object

Layers in order

Name / Pattern                 | Example
-------------------------------|---------------
base                           | base.tfvars
env                            | dev.tfvars
region/base                    | us-west-2/base.tfvars (provider specific)
region/env                     | us-west-2/dev.tfvars (provider specific)
namespace/base                 | 112233445566/base.tfvars (provider specific)
namespace/env                  | 112233445566/dev.tfvars (provider specific)
namespace/region/base          | 112233445566/us-west-2/base.tfvars (provider specific)
namespace/region/env           | 112233445566/us-west-2/dev.tfvars (provider specific)
provider/base                  | aws/base.tfvars (provider specific)
provider/env                   | aws/dev.tfvars (provider specific)
provider/region/base           | aws/us-west-2/base.tfvars (provider specific)
provider/region/env            | aws/us-west-2/dev.tfvars (provider specific)
provider/namespace/base        | aws/112233445566/base.tfvars (provider specific)
provider/namespace/env         | aws/112233445566/dev.tfvars (provider specific)
provider/namespace/region/base | aws/112233445566/us-west-2/base.tfvars (provider specific)
provider/namespace/region/env  | aws/112233445566/us-west-2/dev.tfvars (provider specific)

namespace and region depends on the provider. Here an example of the mapping:

          | AWS     | Azure        | Google
----------|---------|--------------|-------
namespace | account | subscription | project
region    | region  | location     | region



49
50
51
 
# File 'lib/terraspace/compiler/strategy/tfvar/layer.rb', line 49

def layers
  layer_levels + plugin_layers
end

#paths ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/terraspace/compiler/strategy/tfvar/layer.rb', line 7

def paths
  layer_paths = layers.map do |layer|
    [
      "#{tfvars_dir}/#{layer}.tfvars",
      "#{tfvars_dir}/#{layer}.rb",
    ]
  end.flatten

  layer_paths.select do |path|
    File.exist?(path)
  end
end

#plugin_layers ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/terraspace/compiler/strategy/tfvar/layer.rb', line 53

def plugin_layers
  layers = []
  Terraspace::Plugin.layer_classes.each do |klass|
    layer = klass.new

    # region is high up because its simpler and the more common case is a single provider
    layers += layer_levels(layer.region)

    # namespace is a simple way keep different tfvars between different engineers on different accounts
    layers += layer_levels(layer.namespace)
    layers += layer_levels("#{layer.namespace}/#{layer.region}")

    # in case using multiple providers and one region
    layers += layer_levels(layer.provider)
    layers += layer_levels("#{layer.provider}/#{layer.region}") # also in case another provider has colliding regions

    # Most general layering
    layers += layer_levels("#{layer.provider}/#{layer.namespace}")
    layers += layer_levels("#{layer.provider}/#{layer.namespace}/#{layer.region}")
  end
  layers
end

#tfvars_dir ⇒ Object

seed dir takes higher precedence than the tfvars folder within the stack module. Example:

seed/tfvars/stacks/demo (folder must have *.tfvars or *.rb files)
app/stacks/demo/tfvars

This allows user to take over the tfvars embedded in the stack if they need to. Generally, putting tfvars in within the app/stacks/MOD/tfvars folder seems cleaner and easier to follow.

Will also consider app/modules/demo/tfvars. Though modules to be reuseable and stacks is where business logic should go.



101
102
103
104
105
106
107
 
# File 'lib/terraspace/compiler/strategy/tfvar/layer.rb', line 101

def tfvars_dir
  seed_dir = "#{Terraspace.root}/seed/tfvars/#{@mod.build_dir(disable_instance: true)}"
  mod_dir = "#{@mod.root}/tfvars"

  empty = Dir.glob("#{seed_dir}/*").empty?
  empty ? mod_dir : seed_dir
end