Class: SafeDb::Terraform

Inherits:
UseCase show all
Defined in:
lib/usecase/terraform/terraform.rb

Overview

This terraform use case exports the AWS IAM user access key, secret key and region key into (very safe) environment variables and then runs terraform init, plan, apply or destroy.

This is both ultra secure and extremely convenient because the credentials do not leave the safe and exist within (environment variable) memory only for the duration of the terraform command.

It is safe because you do not need to expose your AWS credentials in plain text. It is convenient because switching IAM users and AWS regions is as easy as typing the now ubiquitous safe open command.

safe open <<chapter>> <<verse>>

Constant Summary collapse

TERRAFORM_EVAR_PREFIX =

This prefix is tagged onto environment variables which Terraform will read and convert for consumption into module input variables.

"TF_VAR_"

Constants inherited from UseCase

UseCase::APP_DIR_NAME, UseCase::COMMANDMENT, UseCase::ENV_VAR_KEY_NAME, UseCase::ENV_VAR_PREFIX_A, UseCase::ENV_VAR_PREFIX_B, UseCase::FILE_CONTENT_KEY, UseCase::FILE_KEY_PREFIX, UseCase::FILE_NAME_KEY

Instance Attribute Summary collapse

Attributes inherited from UseCase

#from_script

Instance Method Summary collapse

Methods inherited from UseCase

#check_post_conditions, #check_pre_conditions, #cleanup, #config_directory, #config_file, #flow_of_events, #get_master_database, #initialize, #post_validation, #pre_validation

Constructor Details

This class inherits a constructor from SafeDb::UseCase

Instance Attribute Details

#command=(value) ⇒ Object (writeonly)

Sets the attribute command



19
20
21
 
# File 'lib/usecase/terraform/terraform.rb', line 19

def command=(value)
  @command = value
end

Instance Method Details

#execute ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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/usecase/terraform/terraform.rb', line 25

def execute

  return unless ops_key_exists?
  master_db = get_master_database()
  return if unopened_envelope?( master_db )

  # Get the open chapter identifier (id).
  # Decide whether chapter already exists.
  # Then get (or instantiate) the chapter's hash data structure
  chapter_id = ENVELOPE_KEY_PREFIX + master_db[ ENV_PATH ]
  verse_id = master_db[ KEY_PATH ]
  chapter_exists = KeyApi.db_envelope_exists?( master_db[ chapter_id ] )


  # -- @todo begin
  # -- Throw an exception (error) if the chapter
  # -- either exists and is empty or does not exist.
  # -- @todo end


  # Unlock the chapter data structure by supplying
  # key/value mini-dictionary breadcrumbs sitting
  # within the master database at the section labelled
  # envelope@<<actual_chapter_id>>.
  chapter_data = KeyDb.from_json( KeyApi.content_unlock( master_db[ chapter_id ] ) )

  # Now read the three AWS IAM credentials @access.key, @secret.key and region.key
  # into the 3 environment variables terraform expects to find.

  # ############## | ############################################################
  # @todo refactor | ############################################################
  # -------------- | 000000000000000000000000000000000000000000000000000000000000
  # export-then-execute
  # -------------------
  # Put all the code above in a generic export-then-execute use case
  # Then you pass in a Key/Value Dictionary
  #
  # { "AWS_ACCESS_KEY_ID" => "@access_key",
  #   "AWS_SECRET_ACCESS_KEY" => "@secret_key",
  #   "AWS_DEFAULT_REGION" => "region_key"
  # }
  #
  # And pass in a command array [ "terraform #{command_name} #{auto_approve}", "terraform graph ..." ]
  #
  # Validation is done by the generic use case (which loops checking that every value exists
  # as a key at the opened location.
  #
  # If all good the generic use case exports the ENV vars and runs each command in the list.
  # PS - configure map in INI not code file
  #
  # The extra power will speed up generation of environment variable use cases including
  # ansible, s3 bucket operations, git interactions and more.
  #
  # ############## | ############################################################
  # ############## | ############################################################

  puts ""
  puts "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  puts ""

  ENV[ "AWS_ACCESS_KEY_ID"     ] = chapter_data[ verse_id ][ "@access.key" ]
  ENV[ "AWS_SECRET_ACCESS_KEY" ] = chapter_data[ verse_id ][ "@secret.key" ]
  ENV[ "AWS_DEFAULT_REGION"    ] = chapter_data[ verse_id ][ "region.key"  ]

  mini_dictionary = chapter_data[ verse_id ]
  mini_dictionary.each do | key_str, value_object |

    is_env_var = key_str.start_with?( ENV_VAR_PREFIX_A ) || key_str.start_with?( ENV_VAR_PREFIX_B )
    next unless is_env_var

    env_var_name = key_str[ ENV_VAR_PREFIX_A.length .. -1 ] if key_str.start_with? ENV_VAR_PREFIX_A
    env_var_name = key_str[ ENV_VAR_PREFIX_B.length .. -1 ] if key_str.start_with? ENV_VAR_PREFIX_B
    env_var_keyname = TERRAFORM_EVAR_PREFIX + env_var_name
    ENV[ env_var_keyname ] = value_object
    puts "Environment variable #{env_var_keyname} has been set."

  end

  puts ""
  puts "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  puts ""

  auto_approve = @command && @command.eql?( "plan" ) ? "" : "-auto-approve"
  command_name = @command ? @command : "apply"
  system "terraform #{command_name} #{auto_approve}"

  puts ""
  puts "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  puts ""

end