Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate Terraform config from policy templates #236

4 changes: 4 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,7 @@ RSpec/ExampleLength:

RSpec/MultipleExpectations:
Enabled: false

RSpec/NestedGroups:
Enabled: true
Max: 5
13 changes: 13 additions & 0 deletions lib/command/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,19 @@ def self.add_app_identity_option(required: false)
}
}
end

def self.dir_option(required: false)
{
name: :dir,
params: {
banner: "DIR",
desc: "Output directory",
type: :string,
required: required
}
}
end

# rubocop:enable Metrics/MethodLength

def self.all_options
Expand Down
76 changes: 70 additions & 6 deletions lib/command/terraform/generate.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,90 @@ module Terraform
class Generate < Base
SUBCOMMAND_NAME = "terraform"
NAME = "generate"
OPTIONS = [
app_option(required: false),
dir_option(required: false)
].freeze
DESCRIPTION = "Generates terraform configuration files"
LONG_DESCRIPTION = <<~DESC
- Generates terraform configuration files based on `controlplane.yml` and `templates/` config
DESC
WITH_INFO_HEADER = false
VALIDATIONS = [].freeze

def call
File.write(terraform_dir.join("providers.tf"), cpln_provider.to_tf)
generate_common_configs
generate_app_configs
end

private

def cpln_provider
TerraformConfig::RequiredProvider.new("cpln", source: "controlplane-com/cpln", version: "~> 1.0")
def generate_common_configs
cpln_provider = TerraformConfig::RequiredProvider.new(
"cpln",
source: "controlplane-com/cpln",
version: "~> 1.0"
)

File.write(terraform_dir.join("providers.tf"), cpln_provider.to_tf)
end

def generate_app_configs
Array(config.app || config.apps.keys).each do |app|
generate_app_config(app.to_s)
end
end

def generate_app_config(app)
config.class.define_method(:app) { app }

terraform_app_dir = recreate_terraform_app_dir(app)

templates.each do |template|
generator = TerraformConfig::Generator.new(config: config, template: template)

# TODO: Delete line below after all template kinds are supported
next unless %w[gvc identity secret policy].include?(template["kind"])

File.write(terraform_app_dir.join(generator.filename), generator.tf_config.to_tf, mode: "a+")
end
end

def recreate_terraform_app_dir(app_path)
full_path = terraform_dir.join(app_path)

unless File.expand_path(full_path).include?(Cpflow.root_path.to_s)
Shell.abort("Directory to save terraform configuration files cannot be outside of current directory")
end

FileUtils.rm_rf(full_path)
FileUtils.mkdir_p(full_path)

full_path
end

def templates
parser = TemplateParser.new(self)
template_files = Dir["#{parser.template_dir}/*.yml"]

if template_files.empty?
Shell.warn "No templates found in #{parser.template_dir}"
return []
end

parser.parse(template_files)
rescue StandardError => e
Shell.warn "Error parsing templates: #{e.message}"
[]
end

def terraform_dir
@terraform_dir ||= Cpflow.root_path.join("terraform").tap do |path|
FileUtils.mkdir_p(path)
@terraform_dir ||= begin
full_path = config.options.fetch(:dir, Cpflow.root_path.join("terraform"))
Pathname.new(full_path).tap do |path|
FileUtils.mkdir_p(path)
rescue StandardError => e
Shell.abort("Invalid directory: #{e.message}")
end
end
end
end
Expand Down
19 changes: 10 additions & 9 deletions lib/core/terraform_config/dsl.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ module TerraformConfig
module Dsl
extend Forwardable

REFERENCE_PATTERN = /^(var|locals|cpln_\w+)\./.freeze

def_delegators :current_context, :put, :output

def block(name, *labels)
Expand Down Expand Up @@ -32,19 +34,18 @@ def argument(name, value, optional: false)

private

def tf_value(value)
def tf_value(value, heredoc_delimiter: "EOF", multiline_indent: 2)
value = value.to_s if value.is_a?(Symbol)

case value
when String
expression?(value) ? value : "\"#{value}\""
else
value
end
return value unless value.is_a?(String)
return value if expression?(value)
return "\"#{value}\"" unless value.include?("\n")

"#{heredoc_delimiter}\n#{value.indent(multiline_indent)}\n#{heredoc_delimiter}"
end

def expression?(value)
value.start_with?("var.") || value.start_with?("locals.")
value.match?(REFERENCE_PATTERN)
end

def block_declaration(name, labels)
Expand All @@ -62,7 +63,7 @@ def initialize
end

def put(content, indent: 0)
@output += content.indent(indent)
@output += content.to_s.indent(indent)
end
end

Expand Down
121 changes: 121 additions & 0 deletions lib/core/terraform_config/generator.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# frozen_string_literal: true

module TerraformConfig
class Generator
attr_reader :config, :template

def initialize(config:, template:)
@config = config
@template = template
end

# rubocop:disable Metrics/MethodLength
zzaakiirr marked this conversation as resolved.
Show resolved Hide resolved
def filename
case template["kind"]
when "gvc"
"gvc.tf"
when "secret"
"secrets.tf"
when "identity"
"identities.tf"
when "policy"
"policies.tf"
else
raise "Unsupported template kind - #{template['kind']}"
end
end
# rubocop:enable Metrics/MethodLength

def tf_config
method_name = :"#{template['kind']}_config"
raise "Unsupported template kind - #{template['kind']}" unless self.class.private_method_defined?(method_name)

send(method_name)
end

private

# rubocop:disable Metrics/MethodLength
def gvc_config
pull_secrets = template.dig("spec", "pullSecretLinks")&.map do |secret_link|
secret_name = secret_link.split("/").last
"cpln_secret.#{secret_name}.name"
end

load_balancer = template.dig("spec", "loadBalancer")

TerraformConfig::Gvc.new(
name: template["name"],
description: template["description"],
tags: template["tags"],
domain: template.dig("spec", "domain"),
env: env,
pull_secrets: pull_secrets,
locations: locations,
load_balancer: load_balancer
)
end
# rubocop:enable Metrics/MethodLength

def identity_config
TerraformConfig::Identity.new(
gvc: gvc,
name: template["name"],
description: template["description"],
tags: template["tags"]
)
end

def secret_config
TerraformConfig::Secret.new(
name: template["name"],
description: template["description"],
type: template["type"],
data: template["data"],
tags: template["tags"]
)
end

# rubocop:disable Metrics/MethodLength
def policy_config
# //secret/secret-name -> secret-name
target_links = template["targetLinks"]&.map do |target_link|
target_link.split("/").last
end

# //group/viewers -> group/viewers
bindings = template["bindings"]&.map do |data|
principal_links = data.delete("principalLinks")&.map { |link| link.delete_prefix("//") }
data.merge("principalLinks" => principal_links)
end

TerraformConfig::Policy.new(
name: template["name"],
description: template["description"],
tags: template["tags"],
target: template["target"],
target_kind: template["targetKind"],
target_query: template["targetQuery"],
target_links: target_links,
gvc: gvc,
bindings: bindings
)
end
# rubocop:enable Metrics/MethodLength
zzaakiirr marked this conversation as resolved.
Show resolved Hide resolved

# GVC name matches application name
def gvc
"cpln_gvc.#{config.app}.name"
end

def env
template.dig("spec", "env").to_h { |env_var| [env_var["name"], env_var["value"]] }
end

def locations
template.dig("spec", "staticPlacement", "locationLinks")&.map do |location_link|
location_link.split("/").last
end
end
end
end
57 changes: 57 additions & 0 deletions lib/core/terraform_config/gvc.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# frozen_string_literal: true

module TerraformConfig
class Gvc < Base
attr_reader :name, :description, :tags, :domain, :locations, :pull_secrets, :env, :load_balancer

# rubocop:disable Metrics/ParameterLists
def initialize(
name:,
description: nil,
tags: nil,
domain: nil,
locations: nil,
pull_secrets: nil,
env: nil,
load_balancer: nil
)
super()

@name = name
@description = description
@tags = tags
@domain = domain
@locations = locations
@pull_secrets = pull_secrets
@env = env
@load_balancer = load_balancer&.deep_underscore_keys&.deep_symbolize_keys
end
# rubocop:enable Metrics/ParameterLists

def to_tf
block :resource, :cpln_gvc, name do
argument :name, name
argument :description, description, optional: true
argument :tags, tags, optional: true

argument :domain, domain, optional: true
argument :locations, locations, optional: true
argument :pull_secrets, pull_secrets, optional: true
argument :env, env, optional: true

load_balancer_tf
end
end

private

def load_balancer_tf
return if load_balancer.nil?

block :load_balancer do
argument :dedicated, load_balancer.fetch(:dedicated)
argument :trusted_proxies, load_balancer.fetch(:trusted_proxies, nil), optional: true
end
end
end
end
27 changes: 27 additions & 0 deletions lib/core/terraform_config/identity.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# frozen_string_literal: true

module TerraformConfig
class Identity < Base
attr_reader :gvc, :name, :description, :tags

def initialize(gvc:, name:, description: nil, tags: nil)
super()

@gvc = gvc
@name = name
@description = description
@tags = tags
end

def to_tf
block :resource, :cpln_identity, name do
argument :gvc, gvc

argument :name, name
argument :description, description, optional: true

argument :tags, tags, optional: true
end
end
end
end
Loading
Loading