Add descriptions to variables, outputs. Update README.

vandot · Mar 6, 2019 · 46fe978 · 46fe978
1 parent f12683c
commit 46fe978
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -20,9 +20,8 @@ Before using this module, you'll need to generate a key pair for your server and
 |`public_subnet_ids`|`list`|Yes|A list of subnets for the Autoscaling Group to use for launching instances. May be a single subnet, but it must be an element in a list.|
 |`ssh_key_id`|`string`|Yes|A SSH public key ID to add to the VPN instance.|
 |`vpc_id`|`string`|Yes|The VPC ID in which Terraform will launch the resources.|
-|`ingress_security_group_id`|`string`|Yes|The ID of the Security Group to allow SSH access from.|
 |`ami_id`|`string`|No. Defaults to Ubuntu 16.04 AMI in us-east-1|The AMI ID to use.|
-|`env`|`string`|No. Defaults "prod"|The environment for WireGuard|
+|`env`|`string`|No. Defaults "prod"|The name of environment for WireGuard. Used to differentiate multiple deployments.|
 |`wg_client_public_keys`|`list`|Yes.|List of maps of client IPs and public keys. See Usage for details.|
 
 ## Usage

diff --git a/outputs.tf b/outputs.tf
@@ -1,7 +1,9 @@
 output "vpn_ip" {
   value = "${aws_eip.wireguard_eip.public_ip}"
+  description = "The public IPv4 address of the AWS Elastic IP assigned to the instance."
 }
 
 output "vpn_sg_id" {
   value = "${aws_security_group.sg_wireguard_admin.id}"
+  description = "ID of the internal Security Group to associate with other resources needing to be accessed on VPN."
 }
diff --git a/variables.tf b/variables.tf
@@ -1,19 +1,27 @@
-variable "ssh_key_id" {}
+variable "ssh_key_id" {
+  description = "A SSH public key ID to add to the VPN instance."
+}
 
-variable "vpc_id" {}
+variable "vpc_id" {
+  description = "The VPC ID in which Terraform will launch the resources."
+}
 
 variable "ami_id" {
   default = "ami-da05a4a0"
+  description = "The AMI ID to use."
 }
 
 variable "public_subnet_ids" {
   type = "list"
+  description = "A list of subnets for the Autoscaling Group to use for launching instances. May be a single subnet, but it must be an element in a list."
 }
 
 variable "wg_client_public_keys" {
   type = "list"
+  description = "List of maps of client IPs and public keys. See Usage in README for details."
 }
 
 variable "env" {
   default = "prod"
+  description = "The name of environment for WireGuard. Used to differentiate multiple deployments"
 }