docs: Added a note about using with Terraform Cloud Agents (#108)

Author: antonbabenko

.pre-commit-config.yaml

@@ -1,10 +1,25 @@
 repos:
   - repo: git://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.31.0
+    rev: v1.41.0
     hooks:
       - id: terraform_fmt
       - id: terraform_docs
+      - id: terraform_tflint
+        args:
+          - '--args=--only=terraform_deprecated_interpolation'
+          - '--args=--only=terraform_deprecated_index'
+          - '--args=--only=terraform_unused_declarations'
+          - '--args=--only=terraform_comment_syntax'
+          - '--args=--only=terraform_documented_outputs'
+          - '--args=--only=terraform_documented_variables'
+          - '--args=--only=terraform_typed_variables'
+          - '--args=--only=terraform_module_pinned_source'
+          - '--args=--only=terraform_naming_convention'
+          - '--args=--only=terraform_required_version'
+          - '--args=--only=terraform_required_providers'
+          - '--args=--only=terraform_standard_module_structure'
+          - '--args=--only=terraform_workspace_remote'
   - repo: git://github.com/pre-commit/pre-commit-hooks
-    rev: v3.1.0
+    rev: v3.2.0
     hooks:
       - id: check-merge-conflict

README.md

@@ -46,6 +46,17 @@ module "notify_slack" {
 
 Version 3 uses [Terraform AWS Lambda module](https://github.com/terraform-aws-modules/terraform-aws-lambda) to handle most of heavy-lifting related to Lambda packaging, roles, and permissions, while maintaining the same interface for the user of this module after many of resources will be recreated.
 
+## Using with Terraform Cloud Agents
+
+[Terraform Cloud Agents](https://www.terraform.io/docs/cloud/workspaces/agent.html) are a paid feature, available as part of the Terraform Cloud for Business upgrade package.
+
+This module requires Python 3.8. You can customize [tfc-agent](https://hub.docker.com/r/hashicorp/tfc-agent) to include Python using this sample `Dockerfile`:
+
+```
+FROM hashicorp/tfc-agent:latest
+RUN apt-get -y update && apt-get -y install python3.8 python3-pip
+ENTRYPOINT ["/bin/tfc-agent"]
+```
 
 ## Use existing SNS topic or create new
 
@@ -94,12 +105,12 @@ To run the tests:
 | create\_sns\_topic | Whether to create new SNS topic | `bool` | `true` | no |
 | iam\_role\_boundary\_policy\_arn | The ARN of the policy that is used to set the permissions boundary for the role | `string` | `null` | no |
 | iam\_role\_name\_prefix | A unique role name beginning with the specified prefix | `string` | `"lambda"` | no |
-| iam\_role\_policy\_name\_prefix | A unique policy name beginning with the specified prefix | `string` | `"lambda-policy-"` | no |
 | iam\_role\_tags | Additional tags for the IAM role | `map(string)` | `{}` | no |
 | kms\_key\_arn | ARN of the KMS key used for decrypting slack webhook url | `string` | `""` | no |
 | lambda\_description | The description of the Lambda function | `string` | `null` | no |
 | lambda\_function\_name | The name of the Lambda function to create | `string` | `"notify_slack"` | no |
 | lambda\_function\_tags | Additional tags for the Lambda function | `map(string)` | `{}` | no |
+| lambda\_role | IAM role attached to the Lambda Function.  If this is set then a role will not be created for you. | `string` | `""` | no |
 | log\_events | Boolean flag to enabled/disable logging of incoming events | `bool` | `false` | no |
 | reserved\_concurrent\_executions | The amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations | `number` | `-1` | no |
 | slack\_channel | The name of the channel in Slack for notifications | `string` | n/a | yes |

examples/cloudwatch-alerts-to-slack/README.md

@@ -58,13 +58,16 @@ Note that this example may create resources which can cost money. Run `terraform
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
-No requirements.
+| Name | Version |
+|------|---------|
+| terraform | >= 0.13.0, < 0.14 |
+| aws | >= 2.35, < 4.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| aws | n/a |
+| aws | >= 2.35, < 4.0 |
 
 ## Inputs
 

examples/cloudwatch-alerts-to-slack/main.tf

@@ -32,7 +32,7 @@ module "notify_slack" {
   }
 }
 
-resource "aws_cloudwatch_metric_alarm" "LambdaDuration" {
+resource "aws_cloudwatch_metric_alarm" "lambda_duration" {
   alarm_name          = "NotifySlackDuration"
   comparison_operator = "GreaterThanOrEqualToThreshold"
   evaluation_periods  = "1"

examples/cloudwatch-alerts-to-slack/variables.tf

@@ -0,0 +1,7 @@
+terraform {
+  required_version = ">= 0.13.0, < 0.14"
+
+  required_providers {
+    aws = ">= 2.35, < 4.0"
+  }
+}

examples/cloudwatch-alerts-to-slack/versions.tf

@@ -21,13 +21,16 @@ Note that this example may create resources which can cost money (AWS Elastic IP
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
-No requirements.
+| Name | Version |
+|------|---------|
+| terraform | >= 0.13.0, < 0.14 |
+| aws | >= 2.35, < 4.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| aws | n/a |
+| aws | >= 2.35, < 4.0 |
 
 ## Inputs
 

examples/notify-slack-simple/README.md

@@ -0,0 +1,7 @@
+terraform {
+  required_version = ">= 0.13.0, < 0.14"
+
+  required_providers {
+    aws = ">= 2.35, < 4.0"
+  }
+}

examples/notify-slack-simple/variables.tf

@@ -81,7 +81,7 @@ module "lambda" {
   kms_key_arn                    = var.kms_key_arn
   reserved_concurrent_executions = var.reserved_concurrent_executions
 
-  // If publish is disabled, there will be "Error adding new Lambda Permission for notify_slack: InvalidParameterValueException: We currently do not support adding policies for $LATEST."
+  # If publish is disabled, there will be "Error adding new Lambda Permission for notify_slack: InvalidParameterValueException: We currently do not support adding policies for $LATEST."
   publish = true
 
   environment_variables = {