Follow the official TF module structure

Author: PacoVK

.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on: push
 
 defaults:
   run:
-    working-directory: test
+    working-directory: examples
 
 jobs:
   check:

.gitignore

@@ -4,6 +4,7 @@
 *.zip
 *tfstate
 *tfstate.backup
-test/functionbeat-*
+examples/functionbeat-*
 *.lock.hcl
 *.info
+functionbeat.yml

README.md

@@ -51,7 +51,7 @@ module "functionbeat" {
 
 ## Advanced example ##
 
-Head over to `test/main.tf` to get an more advanced example.
+Head over to `example/main.tf` to get an more advanced example.
 
 ## Usage ##
 

test/main.tf renamed to examples/main.tf

@@ -19,6 +19,11 @@ resource "aws_subnet" "subnet" {
   }
 }
 
+resource "aws_cloudwatch_log_group" "example_logs" {
+  name              = "MyExampleService"
+  retention_in_days = 1
+}
+
 resource "aws_security_group" "functionbeat_securitygroup" {
   name   = "Functionbeat"
   vpc_id = aws_vpc.vpc.id
@@ -55,6 +60,8 @@ module "functionbeat" {
     }
   }
 
+  loggroup_name = aws_cloudwatch_log_group.example_logs.name
+
   fb_extra_configuration = {
     fields = {
       env = "test",

functionbeat.tf renamed to main.tf

@@ -1,16 +1,17 @@
 # ================================== Required =====================================
 
 variable "application_name" {
-  type        = string
   description = "This value is added to any log in Kibana as a tag for filtering"
+  type        = string
 }
 
 variable "functionbeat_version" {
+  description = "Funtionbeat version to deploy"
   type        = string
-  description = "Funtionbeat version"
 }
 
 variable "lambda_config" {
+  description = "Minimal required configuration for Functionbeat lambda"
   type = object({
     name = string
     vpc_config = object({
@@ -57,7 +58,7 @@ variable "lambda_write_arn_to_ssm" {
 # ============================== Extra Functionbeat ===============================
 
 variable "fb_extra_configuration" {
-  description = "Tags to add to the resources"
+  description = "All valid Functionbeat configuration passed as valid HCL object. For configuration options head over to Functionbeat documentation."
   type        = any
   default     = {}
 }