search

lacework / terraform-aws-config

Terraform module for configuring an integration with Lacework and AWS for cloud resource configuration assessment
6 stars 15 forks source link

feat: #99

Closed heathsnow closed 5 months ago

heathsnow commented 5 months ago

Feature Request

Describe the Feature Request

Typically, Terraform community modules should have an example module configuration listed in the default branch README.md. In this repository there's no clear indication of how to call this module. Additionally, there's no reference to this module from the Hashicorp Terraform Registry^1.

Is your feature request related to a problem? Please describe

The problem is that users of the module must determine the correct path for the source since the examples directory only reference relative paths.

In this case source = "lacework/config/aws" works but without existing in the the registry^1 one could also think it has to be called like source = "git::https://github.com/lacework/terraform-aws-config?ref=tags/<version>.

Describe Preferred Solution

There should be a Usage section describing a typical execution of the module.

Additional Context

See any of the modules here: https://github.com/terraform-aws-modules for reference.

heathsnow commented 5 months ago

I stand corrected :) I found it here: https://registry.terraform.io/modules/lacework/config/aws/latest

Although I think a Usage section would be valuable in the README it's provision instructions are listed in the registry.