REAME and variables Cleanup

Author: thathaneydude

README.md

@@ -1,11 +1,11 @@
-# terraform-aws-single-sensor (Early Access)
+# terraform-aws-single-sensor
 Deploy a single AWS Corelight EC2 instance Cloud Sensor. 
 
 ## Getting Started
 
 ### Initialize Terraform state
 ```shell 
-    terraform init
+terraform init
 ```
 
 ### Deployment Permissions
@@ -80,16 +80,16 @@ ebs_volume_size = "<your preferred EBS volume size in GB (number)" // default: 5
 
 ### Copy an example tfvars file and populate it with your details
 ```shell
-  cp minimal-example.tfvars foo.tfvars 
+cp minimal-example.tfvars foo.tfvars 
 ```
 
 ### Plan the deployment
 ```shell
-    terraform plan --var-file foo.tfvars -out=tfplan
+terraform plan --var-file foo.tfvars -out=tfplan
 ```
 
 ### Deploy the Plan
 If the plan looks good go ahead and deploy it
 ```shell
-    terraform apply tfplan
+terraform apply tfplan
 ```

variables.tf

@@ -9,7 +9,7 @@ variable "aws_key_pair_name" {
 }
 
 variable "fleet_community_string" {
-  description = "the Fleet Manager community string (api string)"
+  description = "the fleet manager community string (api string)"
   type        = string
   sensitive   = true
 }
@@ -51,7 +51,7 @@ variable "monitoring_interface_name" {
 }
 
 variable "monitoring_interface_subnet_id" {
-  description = ""
+  description = "Subnet where the monitoring ENI should reside"
   type        = string
   default     = ""
 }
@@ -63,19 +63,19 @@ variable "monitoring_security_group_id" {
 }
 
 variable "monitoring_security_group_name" {
-  description = ""
+  description = "Name of the security group the module will provision for the monitoring ENI"
   type        = string
   default     = "corelight-sensor-mon-sg"
 }
 
 variable "monitoring_security_group_description" {
-  description = ""
+  description = "Description of the monitoring ENI security group"
   type        = string
   default     = "Corelight Sensor Monitoring SG"
 }
 
 variable "monitoring_security_group_vpc_id" {
-  description = ""
+  description = "Security group VPC ID module will use to provision the monitoring ENI security group"
   type        = string
   default     = ""
 }
@@ -87,32 +87,32 @@ variable "management_security_group_id" {
 }
 
 variable "management_security_group_name" {
-  description = ""
+  description = "Name of the security group the module will provision for the management ENI"
   type        = string
   default     = "corelight-sensor-mgmt-sg"
 }
 
 variable "management_security_group_description" {
-  description = ""
+  description = "Description of the management ENI security group"
   type        = string
   default     = "Corelight Sensor Managment SG"
 }
 
 variable "management_security_group_vpc_id" {
-  description = ""
+  description = "Security group VPC ID module will use to provision the management ENI security group"
   type        = string
   default     = ""
 }
 
 variable "custom_sensor_user_data" {
-  description = "custom user data for a sensor if the default doesn't apply"
+  description = "Custom user data for a sensor if the default doesn't apply"
   type        = string
   default     = ""
 }
 
 variable "instance_name" {
+  description = "The name for the sensor EC2 instance"
   type        = string
-  description = "The instance name for the instance"
   default     = "corelight-sensor"
 }
 
@@ -123,7 +123,7 @@ variable "instance_type" {
 }
 
 variable "ebs_volume_size" {
-  description = "The size, in GB of the EBS volume to be attached to the instance"
+  description = "The size, in GB, of the EBS volume to be attached to the instance. Not recommended to set lower than 500GB"
   type        = number
   default     = 500
 }
@@ -143,63 +143,62 @@ variable "iam_instance_profile_name" {
 
 
 variable "fleet_token" {
+  description = "(optional) the pairing token from the Fleet UI. Must be set if 'fleet_url' is provided"
   type        = string
   default     = ""
   sensitive   = true
-  description = "(optional) the pairing token from the Fleet UI. Must be set if 'fleet_url' is provided"
 }
 
 variable "fleet_url" {
+  description = "(optional) the URL of the fleet instance from the Fleet UI. Must be set if 'fleet_token' is provided"
   type        = string
   default     = ""
-  description = "(optional) the URL of the fleet instance from the Fleet UI. Must be set if 'fleet_token' is provided"
 }
 
 variable "fleet_server_sslname" {
+  description = "(optional) the SSL hostname for the fleet server"
   type        = string
   default     = "1.broala.fleet.product.corelight.io"
-  description = "(optional) the SSL hostname for the fleet server"
-
 }
 
 variable "fleet_http_proxy" {
+  description = "(optional) the proxy URL for HTTP traffic from the fleet"
   type        = string
   default     = ""
-  description = "(optional) the proxy URL for HTTP traffic from the fleet"
 }
 
 variable "fleet_https_proxy" {
+  description = "(optional) the proxy URL for HTTPS traffic from the fleet"
   type        = string
   default     = ""
-  description = "(optional) the proxy URL for HTTPS traffic from the fleet"
 }
 
 variable "fleet_no_proxy" {
+  description = "(optional) hosts or domains to bypass the proxy for fleet traffic"
   type        = string
   default     = ""
-  description = "(optional) hosts or domains to bypass the proxy for fleet traffic"
 }
 
 variable "egress_allow_cidrs" {
-  description = ""
+  description = "The IP range allowed outbound for both network interfaces. Typically can be left as default"
   type        = list(string)
   default     = ["0.0.0.0/0"]
 }
 
 variable "ssh_allow_cidrs" {
-  description = ""
+  description = "List of IPs (/32) to grant access to port 22"
   type        = list(string)
   default     = []
 }
 
 variable "mirror_ingress_allow_cidrs" {
-  description = ""
+  description = "IP range to allow EC2 mirroring. Typically the CIDR of the VPC being monitored"
   type        = list(string)
   default     = ["0.0.0.0/0"]
 }
 
 variable "health_check_allow_cidrs" {
-  description = ""
+  description = "IP range to allow health checks. Typically the CIDR of the VPC being monitored"
   type        = list(string)
   default     = ["0.0.0.0/0"]
 }