Terraform

Terraform lets you describe the infrastructure you want and automatically creates, deletes, and modifies your existing infrastructure to match. OPA makes it possible to write policies that test the changes Terraform is about to make before it makes them. Such tests help in different ways:

  • tests help individual developers sanity check their Terraform changes
  • tests can auto-approve run-of-the-mill infrastructure changes and reduce the burden of peer-review
  • tests can help catch problems that arise when applying Terraform to production after applying it to staging

Goals

In this tutorial, you’ll learn how to use OPA to implement unit tests for Terraform plans that create and delete auto-scaling groups and servers.

Prerequisites

This tutorial requires

(This tutorial should also work with the latest version of Terraform, but it is untested. Contributions welcome!)

Getting Started

Steps

1. Create and save a Terraform plan

Create a Terraform file that includes an auto-scaling group and a server on AWS. (You will need to modify the shared_credentials_file to point to your AWS credentials.)

  1. cat >main.tf <<EOF
  2. provider "aws" {
  3.     region = "us-west-1"
  4. }
  5. resource "aws_instance" "web" {
  6.   instance_type = "t2.micro"
  7.   ami = "ami-09b4b74c"
  8. }
  9. resource "aws_autoscaling_group" "my_asg" {
  10.   availability_zones        = ["us-west-1a"]
  11.   name                      = "my_asg"
  12.   max_size                  = 5
  13.   min_size                  = 1
  14.   health_check_grace_period = 300
  15.   health_check_type         = "ELB"
  16.   desired_capacity          = 4
  17.   force_delete              = true
  18.   launch_configuration      = "my_web_config"
  19. }
  20. resource "aws_launch_configuration" "my_web_config" {
  21.     name = "my_web_config"
  22.     image_id = "ami-09b4b74c"
  23.     instance_type = "t2.micro"
  24. }
  25. EOF

Then initialize Terraform and ask it to calculate what changes it will make and store the output in plan.binary.

  1. terraform init
  2. terraform plan --out tfplan.binary

2. Convert the Terraform plan into JSON

Use the command terraform show to convert the Terraform plan into JSON so that OPA can read the plan.

  1. terraform show -json tfplan.binary > tfplan.json

Here is the expected contents of tfplan.json.

Terraform - 图1

  1. {
  2.   "format_version": "0.1",
  3.   "terraform_version": "0.12.6",
  4.   "planned_values": {
  5.     "root_module": {
  6.       "resources": [
  7.         {
  8.           "address": "aws_autoscaling_group.my_asg",
  9.           "mode": "managed",
  10.           "type": "aws_autoscaling_group",
  11.           "name": "my_asg",
  12.           "provider_name": "aws",
  13.           "schema_version": 0,
  14.           "values": {
  15.             "availability_zones": [
  16.               "us-west-1a"
  17.             ],
  18.             "desired_capacity": 4,
  19.             "enabled_metrics": null,
  20.             "force_delete": true,
  21.             "health_check_grace_period": 300,
  22.             "health_check_type": "ELB",
  23.             "initial_lifecycle_hook": [],
  24.             "launch_configuration": "my_web_config",
  25.             "launch_template": [],
  26.             "max_size": 5,
  27.             "metrics_granularity": "1Minute",
  28.             "min_elb_capacity": null,
  29.             "min_size": 1,
  30.             "mixed_instances_policy": [],
  31.             "name": "my_asg",
  32.             "name_prefix": null,
  33.             "placement_group": null,
  34.             "protect_from_scale_in": false,
  35.             "suspended_processes": null,
  36.             "tag": [],
  37.             "tags": null,
  38.             "termination_policies": null,
  39.             "timeouts": null,
  40.             "wait_for_capacity_timeout": "10m",
  41.             "wait_for_elb_capacity": null
  42.           }
  43.         },
  44.         {
  45.           "address": "aws_instance.web",
  46.           "mode": "managed",
  47.           "type": "aws_instance",
  48.           "name": "web",
  49.           "provider_name": "aws",
  50.           "schema_version": 1,
  51.           "values": {
  52.             "ami": "ami-09b4b74c",
  53.             "credit_specification": [],
  54.             "disable_api_termination": null,
  55.             "ebs_optimized": null,
  56.             "get_password_data": false,
  57.             "iam_instance_profile": null,
  58.             "instance_initiated_shutdown_behavior": null,
  59.             "instance_type": "t2.micro",
  60.             "monitoring": null,
  61.             "source_dest_check": true,
  62.             "tags": null,
  63.             "timeouts": null,
  64.             "user_data": null,
  65.             "user_data_base64": null
  66.           }
  67.         },
  68.         {
  69.           "address": "aws_launch_configuration.my_web_config",
  70.           "mode": "managed",
  71.           "type": "aws_launch_configuration",
  72.           "name": "my_web_config",
  73.           "provider_name": "aws",
  74.           "schema_version": 0,
  75.           "values": {
  76.             "associate_public_ip_address": false,
  77.             "enable_monitoring": true,
  78.             "ephemeral_block_device": [],
  79.             "iam_instance_profile": null,
  80.             "image_id": "ami-09b4b74c",
  81.             "instance_type": "t2.micro",
  82.             "name": "my_web_config",
  83.             "name_prefix": null,
  84.             "placement_tenancy": null,
  85.             "security_groups": null,
  86.             "spot_price": null,
  87.             "user_data": null,
  88.             "user_data_base64": null,
  89.             "vpc_classic_link_id": null,
  90.             "vpc_classic_link_security_groups": null
  91.           }
  92.         }
  93.       ]
  94.     }
  95.   },
  96.   "resource_changes": [
  97.     {
  98.       "address": "aws_autoscaling_group.my_asg",
  99.       "mode": "managed",
  100.       "type": "aws_autoscaling_group",
  101.       "name": "my_asg",
  102.       "provider_name": "aws",
  103.       "change": {
  104.         "actions": [
  105.           "create"
  106.         ],
  107.         "before": null,
  108.         "after": {
  109.           "availability_zones": [
  110.             "us-west-1a"
  111.           ],
  112.           "desired_capacity": 4,
  113.           "enabled_metrics": null,
  114.           "force_delete": true,
  115.           "health_check_grace_period": 300,
  116.           "health_check_type": "ELB",
  117.           "initial_lifecycle_hook": [],
  118.           "launch_configuration": "my_web_config",
  119.           "launch_template": [],
  120.           "max_size": 5,
  121.           "metrics_granularity": "1Minute",
  122.           "min_elb_capacity": null,
  123.           "min_size": 1,
  124.           "mixed_instances_policy": [],
  125.           "name": "my_asg",
  126.           "name_prefix": null,
  127.           "placement_group": null,
  128.           "protect_from_scale_in": false,
  129.           "suspended_processes": null,
  130.           "tag": [],
  131.           "tags": null,
  132.           "termination_policies": null,
  133.           "timeouts": null,
  134.           "wait_for_capacity_timeout": "10m",
  135.           "wait_for_elb_capacity": null
  136.         },
  137.         "after_unknown": {
  138.           "arn": true,
  139.           "availability_zones": [
  140.             false
  141.           ],
  142.           "default_cooldown": true,
  143.           "id": true,
  144.           "initial_lifecycle_hook": [],
  145.           "launch_template": [],
  146.           "load_balancers": true,
  147.           "mixed_instances_policy": [],
  148.           "service_linked_role_arn": true,
  149.           "tag": [],
  150.           "target_group_arns": true,
  151.           "vpc_zone_identifier": true
  152.         }
  153.       }
  154.     },
  155.     {
  156.       "address": "aws_instance.web",
  157.       "mode": "managed",
  158.       "type": "aws_instance",
  159.       "name": "web",
  160.       "provider_name": "aws",
  161.       "change": {
  162.         "actions": [
  163.           "create"
  164.         ],
  165.         "before": null,
  166.         "after": {
  167.           "ami": "ami-09b4b74c",
  168.           "credit_specification": [],
  169.           "disable_api_termination": null,
  170.           "ebs_optimized": null,
  171.           "get_password_data": false,
  172.           "iam_instance_profile": null,
  173.           "instance_initiated_shutdown_behavior": null,
  174.           "instance_type": "t2.micro",
  175.           "monitoring": null,
  176.           "source_dest_check": true,
  177.           "tags": null,
  178.           "timeouts": null,
  179.           "user_data": null,
  180.           "user_data_base64": null
  181.         },
  182.         "after_unknown": {
  183.           "arn": true,
  184.           "associate_public_ip_address": true,
  185.           "availability_zone": true,
  186.           "cpu_core_count": true,
  187.           "cpu_threads_per_core": true,
  188.           "credit_specification": [],
  189.           "ebs_block_device": true,
  190.           "ephemeral_block_device": true,
  191.           "host_id": true,
  192.           "id": true,
  193.           "instance_state": true,
  194.           "ipv6_address_count": true,
  195.           "ipv6_addresses": true,
  196.           "key_name": true,
  197.           "network_interface": true,
  198.           "network_interface_id": true,
  199.           "password_data": true,
  200.           "placement_group": true,
  201.           "primary_network_interface_id": true,
  202.           "private_dns": true,
  203.           "private_ip": true,
  204.           "public_dns": true,
  205.           "public_ip": true,
  206.           "root_block_device": true,
  207.           "security_groups": true,
  208.           "subnet_id": true,
  209.           "tenancy": true,
  210.           "volume_tags": true,
  211.           "vpc_security_group_ids": true
  212.         }
  213.       }
  214.     },
  215.     {
  216.       "address": "aws_launch_configuration.my_web_config",
  217.       "mode": "managed",
  218.       "type": "aws_launch_configuration",
  219.       "name": "my_web_config",
  220.       "provider_name": "aws",
  221.       "change": {
  222.         "actions": [
  223.           "create"
  224.         ],
  225.         "before": null,
  226.         "after": {
  227.           "associate_public_ip_address": false,
  228.           "enable_monitoring": true,
  229.           "ephemeral_block_device": [],
  230.           "iam_instance_profile": null,
  231.           "image_id": "ami-09b4b74c",
  232.           "instance_type": "t2.micro",
  233.           "name": "my_web_config",
  234.           "name_prefix": null,
  235.           "placement_tenancy": null,
  236.           "security_groups": null,
  237.           "spot_price": null,
  238.           "user_data": null,
  239.           "user_data_base64": null,
  240.           "vpc_classic_link_id": null,
  241.           "vpc_classic_link_security_groups": null
  242.         },
  243.         "after_unknown": {
  244.           "ebs_block_device": true,
  245.           "ebs_optimized": true,
  246.           "ephemeral_block_device": [],
  247.           "id": true,
  248.           "key_name": true,
  249.           "root_block_device": true
  250.         }
  251.       }
  252.     }
  253.   ],
  254.   "configuration": {
  255.     "provider_config": {
  256.       "aws": {
  257.         "name": "aws",
  258.         "expressions": {
  259.           "region": {
  260.             "constant_value": "us-west-1"
  261.           }
  262.         }
  263.       }
  264.     },
  265.     "root_module": {
  266.       "resources": [
  267.         {
  268.           "address": "aws_autoscaling_group.my_asg",
  269.           "mode": "managed",
  270.           "type": "aws_autoscaling_group",
  271.           "name": "my_asg",
  272.           "provider_config_key": "aws",
  273.           "expressions": {
  274.             "availability_zones": {
  275.               "constant_value": [
  276.                 "us-west-1a"
  277.               ]
  278.             },
  279.             "desired_capacity": {
  280.               "constant_value": 4
  281.             },
  282.             "force_delete": {
  283.               "constant_value": true
  284.             },
  285.             "health_check_grace_period": {
  286.               "constant_value": 300
  287.             },
  288.             "health_check_type": {
  289.               "constant_value": "ELB"
  290.             },
  291.             "launch_configuration": {
  292.               "constant_value": "my_web_config"
  293.             },
  294.             "max_size": {
  295.               "constant_value": 5
  296.             },
  297.             "min_size": {
  298.               "constant_value": 1
  299.             },
  300.             "name": {
  301.               "constant_value": "my_asg"
  302.             }
  303.           },
  304.           "schema_version": 0
  305.         },
  306.         {
  307.           "address": "aws_instance.web",
  308.           "mode": "managed",
  309.           "type": "aws_instance",
  310.           "name": "web",
  311.           "provider_config_key": "aws",
  312.           "expressions": {
  313.             "ami": {
  314.               "constant_value": "ami-09b4b74c"
  315.             },
  316.             "instance_type": {
  317.               "constant_value": "t2.micro"
  318.             }
  319.           },
  320.           "schema_version": 1
  321.         },
  322.         {
  323.           "address": "aws_launch_configuration.my_web_config",
  324.           "mode": "managed",
  325.           "type": "aws_launch_configuration",
  326.           "name": "my_web_config",
  327.           "provider_config_key": "aws",
  328.           "expressions": {
  329.             "image_id": {
  330.               "constant_value": "ami-09b4b74c"
  331.             },
  332.             "instance_type": {
  333.               "constant_value": "t2.micro"
  334.             },
  335.             "name": {
  336.               "constant_value": "my_web_config"
  337.             }
  338.           },
  339.           "schema_version": 0
  340.         }
  341.       ]
  342.     }
  343.   }
  344. }

The json plan output produced by terraform contains a lot of information. For this tutorial, we will be interested by:

  • .resource_changes: array containing all the actions that terraform will apply on the infrastructure.
  • .resource_changes[].type: the type of resource (eg aws_instance , aws_iam …)
  • .resource_changes[].change.actions: array of actions applied on the resource (create, update, delete…)

For more information about the json plan representation, please check the terraform documentation

3. Write the OPA policy to check the plan

The policy computes a score for a Terraform that combines

  • The number of deletions of each resource type
  • The number of creations of each resource type
  • The number of modifications of each resource type

The policy authorizes the plan when the score for the plan is below a threshold and there are no changes made to any IAM resources. (For simplicity, the threshold in this tutorial is the same for everyone, but in practice you would vary the threshold depending on the user.)

terraform.rego:

  1. package terraform.analysis
  3. import input as tfplan
  5. ########################
  6. # Parameters for Policy
  7. ########################
  9. # acceptable score for automated authorization
  10. blast_radius = 30
  12. # weights assigned for each operation on each resource-type
  13. weights = {
  14.     "aws_autoscaling_group": {"delete": 100, "create": 10, "modify": 1},
  15.     "aws_instance": {"delete": 10, "create": 1, "modify": 1}
  16. }
  18. # Consider exactly these resource types in calculations
  19. resource_types = {"aws_autoscaling_group", "aws_instance", "aws_iam", "aws_launch_configuration"}
  21. #########
  22. # Policy
  23. #########
  25. # Authorization holds if score for the plan is acceptable and no changes are made to IAM
  26. default authz = false
  27. authz {
  28.     score < blast_radius
  29.     not touches_iam
  30. }
  32. # Compute the score for a Terraform plan as the weighted sum of deletions, creations, modifications
  33. score = s {
  34.     all := [ x |
  35.             some resource_type
  36.             crud := weights[resource_type];
  37.             del := crud["delete"] * num_deletes[resource_type];
  38.             new := crud["create"] * num_creates[resource_type];
  39.             mod := crud["modify"] * num_modifies[resource_type];
  40.             x := del + new + mod
  41.     ]
  42.     s := sum(all)
  43. }
  45. # Whether there is any change to IAM
  46. touches_iam {
  47.     all := resources["aws_iam"]
  48.     count(all) > 0
  49. }
  51. ####################
  52. # Terraform Library
  53. ####################
  55. # list of all resources of a given type
  56. resources[resource_type] = all {
  57.     some resource_type
  58.     resource_types[resource_type]
  59.     all := [name |
  60.         name:= tfplan.resource_changes[_]
  61.         name.type == resource_type
  62.     ]
  63. }
  65. # number of creations of resources of a given type
  66. num_creates[resource_type] = num {
  67.     some resource_type
  68.     resource_types[resource_type]
  69.     all := resources[resource_type]
  70.     creates := [res |  res:= all[_]; res.change.actions[_] == "create"]
  71.     num := count(creates)
  72. }
  75. # number of deletions of resources of a given type
  76. num_deletes[resource_type] = num {
  77.     some resource_type
  78.     resource_types[resource_type]
  79.     all := resources[resource_type]
  80.     deletions := [res |  res:= all[_]; res.change.actions[_] == "delete"]
  81.     num := count(deletions)
  82. }
  84. # number of modifications to resources of a given type
  85. num_modifies[resource_type] = num {
  86.     some resource_type
  87.     resource_types[resource_type]
  88.     all := resources[resource_type]
  89.     modifies := [res |  res:= all[_]; res.change.actions[_] == "update"]
  90.     num := count(modifies)
  91. }

4. Evaluate the OPA policy on the Terraform plan

To evaluate the policy against that plan, you hand OPA the policy, the Terraform plan as input, and ask it to evaluate data.terraform.analysis.authz.

  1. opa eval --format pretty --data terraform.rego --input tfplan.json "data.terraform.analysis.authz"

Terraform - 图2

  1. data.terraform.analysis.authz

Terraform - 图3

  1. true

If you’re curious, you can ask for the score that the policy used to make the authorization decision. In our example, it is 11 (10 for the creation of the auto-scaling group and 1 for the creation of the server).

  1. opa eval --format pretty --data terraform.rego --input tfplan.json "data.terraform.analysis.score"

Terraform - 图4

  1. data.terraform.analysis.score

Terraform - 图5

  1. 11

If as suggested in the previous step, you want to modify your policy to make an authorization decision based on both the user and the Terraform plan, the input you would give to OPA would take the form {"user": <user>, "plan": <plan>}, and your policy would reference the user with input.user and the plan with input.plan. You could even go so far as to provide the Terraform state file and the AWS EC2 data to OPA and write policy using all of that context.

5. Create a Large Terraform plan and Evaluate it

Create a Terraform plan that creates enough resources to exceed the blast-radius permitted by policy.

  1. cat >main.tf <<EOF
  2. provider "aws" {
  3.     region = "us-west-1"
  4. }
  5. resource "aws_instance" "web" {
  6.   instance_type = "t2.micro"
  7.   ami = "ami-09b4b74c"
  8. }
  9. resource "aws_autoscaling_group" "my_asg" {
  10.   availability_zones        = ["us-west-1a"]
  11.   name                      = "my_asg"
  12.   max_size                  = 5
  13.   min_size                  = 1
  14.   health_check_grace_period = 300
  15.   health_check_type         = "ELB"
  16.   desired_capacity          = 4
  17.   force_delete              = true
  18.   launch_configuration      = "my_web_config"
  19. }
  20. resource "aws_launch_configuration" "my_web_config" {
  21.     name = "my_web_config"
  22.     image_id = "ami-09b4b74c"
  23.     instance_type = "t2.micro"
  24. }
  25. resource "aws_autoscaling_group" "my_asg2" {
  26.   availability_zones        = ["us-west-2a"]
  27.   name                      = "my_asg2"
  28.   max_size                  = 6
  29.   min_size                  = 1
  30.   health_check_grace_period = 300
  31.   health_check_type         = "ELB"
  32.   desired_capacity          = 4
  33.   force_delete              = true
  34.   launch_configuration      = "my_web_config"
  35. }
  36. resource "aws_autoscaling_group" "my_asg3" {
  37.   availability_zones        = ["us-west-2b"]
  38.   name                      = "my_asg3"
  39.   max_size                  = 7
  40.   min_size                  = 1
  41.   health_check_grace_period = 300
  42.   health_check_type         = "ELB"
  43.   desired_capacity          = 4
  44.   force_delete              = true
  45.   launch_configuration      = "my_web_config"
  46. }
  47. EOF

Generate the Terraform plan and convert it to JSON.

  1. terraform init
  2. terraform plan --out tfplan_large.binary
  3. terraform show -json tfplan_large.binary > tfplan_large.json

Evaluate the policy to see that it fails the policy tests and check the score.

  1. opa eval --data terraform.rego --input tfplan_large.json "data.terraform.analysis.authz"
  2. opa eval --data terraform.rego --input tfplan_large.json "data.terraform.analysis.score"

6. (Optional) Run OPA as a daemon and evaluate policy

In addition to running OPA from the command-line, you can run it as a daemon loaded with the Terraform policy and then interact with it using its HTTP API. First, start the daemon:

  1. opa run -s terraform.rego

Then in a separate terminal, use OPA’s HTTP API to evaluate the policy against the two Terraform plans.

  1. curl localhost:8181/v0/data/terraform/analysis/authz -d @tfplan.json
  2. curl localhost:8181/v0/data/terraform/analysis/authz -d @tfplan_large.json

Wrap Up

Congratulations for finishing the tutorial!

You learned a number of things about Terraform Testing with OPA:

  • OPA gives you fine-grained policy control over Terraform plans.
  • You can use data other than the plan itself (e.g. the user) when writing authorization policies.

Keep in mind that it’s up to you to decide how to use OPA’s Terraform tests and authorization decision. Here are some ideas.

  • Add it as part of your Terraform wrapper to implement unit tests on Terraform plans
  • Use it to automatically approve run-of-the-mill Terraform changes to reduce the burden of peer-review
  • Embed it into your deployment system to catch problems that arise when applying Terraform to production after applying it to staging

If you’d like to explore an additional example that uses terraform modules please continue below.

Working with Modules

Module Steps

1. Create and save Terraform module plan

Create a new Terraform file that includes a security group and security group from a module. (This example uses the module from https://github.com/terraform-aws-modules/terraform-aws-security-group)

  1. cat >main.tf <<EOF
  2. provider "aws" {
  3.   region = "us-east-1"
  4. }
  6. data "aws_vpc" "default" {
  7.   default = true
  8. }
  10. module "http_sg" {
  11.   source = "git::https://github.com/terraform-aws-modules/terraform-aws-security-group.git?ref=v3.10.0"
  13.   name        = "http-sg"
  14.   description = "Security group with HTTP ports open for everybody (IPv4 CIDR), egress ports are all world open"
  15.   vpc_id      = data.aws_vpc.default.id
  17.   ingress_cidr_blocks = ["0.0.0.0/0"]
  18. }
  21. resource "aws_security_group" "allow_tls" {
  22.   name        = "allow_tls"
  23.   description = "Allow TLS inbound traffic"
  24.   vpc_id      = data.aws_vpc.default.id
  26.   ingress {
  27.     description = "TLS from VPC"
  28.     from_port   = 443
  29.     to_port     = 443
  30.     protocol    = "tcp"
  31.     cidr_blocks = ["10.0.0.0/8"]
  32.   }
  34.   egress {
  35.     from_port   = 0
  36.     to_port     = 0
  37.     protocol    = "-1"
  38.     cidr_blocks = ["0.0.0.0/0"]
  39.   }
  41.   tags = {
  42.     Name = "allow_tls"
  43.   }
  44. }
  45. EOF

Then initialize Terraform and ask it to calculate what changes it will make and store the output in tfplan.binary.

  1. terraform init
  2. terraform plan --out tfplan.binary

2. Convert the new Terraform plan into JSON

Use the Terraform show command to produce the json representation of the terraform plan

  1. terraform show -json tfplan.binary > tfplan2.json

3. Write the OPA policy to collect resources

The policy evaluates if a security group is valid based on the contents of it’s description:

  • Resources can be specified under the root module or in child modules
  • We want to evaluate against the combined group of these resources
  • This example is scoped to the planned changes section of the json representation

The policy uses the walk keyword to explore the json structure, and uses conditions to filter for the specific paths where resources would be found.

terraform_module.rego:

  1. package terraform.module
  3. deny[msg] {
  4.   desc := resources[r].values.description
  5.   contains(desc, "HTTP")
  6.   msg = sprintf("No security groups should be using HTTP. Resource in violation: %v",[r.address])
  7. }
  9. resources := { r |
  10.   some path, value
  12.   # Walk over the JSON tree and check if the node we are
  13.   # currently on is a module (either root or child) resources
  14.   # value.
  15.   walk(input.planned_values, [path, value])
  17.   # Look for resources in the current value based on path
  18.   rs := module_resources(path, value)
  20.   # Aggregate them into `resources`
  21.   r := rs[_]
  22. }
  24. # Variant to match root_module resources
  25. module_resources(path, value) = rs {
  27.   # Expect something like:
  28.   #     
  29.   #     {
  30.   #         "root_module": {
  31.   #             "resources": [...],
  32.   #             ...
  33.   #         }
  34.   #         ...
  35.   #     }
  36.   #
  37.   # Where the path is [..., "root_module", "resources"]
  39.   reverse_index(path, 1) == "resources"
  40.   reverse_index(path, 2) == "root_module"
  41.   rs := value
  42. }
  44. # Variant to match child_modules resources
  45. module_resources(path, value) = rs {
  47.   # Expect something like:
  48.   #     
  49.   #     {
  50.   #         ...
  51.   #         "child_modules": [
  52.   #             {
  53.   #                 "resources": [...],
  54.   #                 ...
  55.   #             },
  56.   #             ...
  57.   #         ]
  58.   #         ...
  59.   #     }
  60.   #
  61.   # Where the path is [..., "child_modules", 0, "resources"]
  62.   # Note that there will always be an index int between `child_modules`
  63.   # and `resources`. We know that walk will only visit each one once,
  64.   # so we shouldn't need to keep track of what the index is.
  66.   reverse_index(path, 1) == "resources"
  67.   reverse_index(path, 3) == "child_modules"
  68.   rs := value
  69. }
  71. reverse_index(path, idx) = value {
  72.     value := path[count(path) - idx]
  73. }

4. Evaluate the OPA policy on the Terraform module plan

To evaluate the policy against that plan, you hand OPA the policy, the Terraform plan as input, and ask it to evaluate data.terraform.module.deny.

  1. opa eval --format pretty --data terraform_module.rego --input tfplan2.json "data.terraform.module.deny"

This should return one of the two resources. The security group created by the module uses HTTP in its description and therefore fails the evaluation.

  1. [
  2. "No security groups should be using HTTP. Resource in violation: module.http_sg.aws_security_group.this_name_prefix[0]"
  3. ]

Module Wrap Up

Congratulations for finishing the tutorial!

You learned OPA can be used to determine if a proposed configuration is authorized.

Additional use cases might include:

  • Ensuring all resources have tags before they are created
  • Making sure naming standards for resources are followed
  • Security or operational requirements