added documentation

main.tf

+# These are the defined variables used in all the modules. They are referenced in the modules, and defined here.
+# This is where you would change any variable values.
+
 # variables for networks and router 
 variable "admin_state_up" {default = true}
 variable "enable_dhcp" {default = true}
@@ -28,7 +31,7 @@ variable "image_compute" {default = "CentOS-7-x86_64-GenericCloud-1905"}
 variable "compute_node_count" {default = 2}
 
 
-
+# runs the external-network module
 module "dmz-network" {
     source = "./external-network"
     # Default name var is in the module main file
@@ -36,7 +39,7 @@ module "dmz-network" {
     enable_dhcp = var.enable_dhcp
     public_network_name = var.public_network_name
 }
-
+# calls the outputs defined in the external-network module
 output "external_network_id" {
   value = "${module.dmz-network.external_network_id}"
 }
@@ -45,22 +48,25 @@ output "router_id" {
     value = "${module.dmz-network.router_id}"
 }
 
+# runs the internal-network module
 module "cluster-network" {
     source = "./internal-network"
     # Default name var is in the module main file
     admin_state_up = var.admin_state_up
     enable_dhcp = var.enable_dhcp
 }
-    
+# calls the outputs defined in the internal-network module
 output "internal_network_id" {
   value = "${module.cluster-network.internal_network_id}"
 }
 
+# runs the floating-ip module - uses public network name defined above
 module "floating-ip" {
     source = "./floating-ip"
     public_network_name = var.public_network_name
 }
 
+# calls the outputs defined in the floating-ip module
 output "floating_ip_ohpc" {
     value = "${module.floating-ip.ohpc_address}"
 }
@@ -69,19 +75,23 @@ output "floating_ip_ood" {
     value = "${module.floating-ip.ood_address}"
 }
 
+# runs the key-pair module - imports local public key into openstack and give it the name defined above in the variables
 module "keypair" {
     source = "./key-pair"
     keypair_name = var.keypair_name
     ssh_public_key = var.ssh_public_key
 }
 
+# calls the outputs defined in the key-pair module
 output "keypair_name" {
     value = "${module.keypair.keypair_name}"
 }
 
+# runs the ohpc-instance module - creates ohpc instance using variables defined above
+# calls functions from dmz-network, floating-ip, and keypair modules to get values created there for use
 module "ohpc-instance" {
-    external_subnet_id = "${module.dmz-network.external_subnet_id}"
     source = "./ohpc-instance"
+    external_subnet_id = "${module.dmz-network.external_subnet_id}"
     floating_ip_ohpc = "${module.floating-ip.ohpc_address}"
     ohpc_instance_name = var.ohpc_instance_name
     image_ohpc = var.image_ohpc
@@ -93,10 +103,12 @@ module "ohpc-instance" {
     ohpc_user =  var.ohpc_user
     ssh_private_key = var.ssh_private_key
 }
-    
+
+# runs the ood-instance module - creates ood instance using variables defined above
+# calls functions from cluster-network, floating-ip, and keypair modules to get values created there for use
 module "ood-instance" {
-    internal_subnet_id = "${module.cluster-network.internal_subnet_id}"
     source = "./ood-instance"
+    internal_subnet_id = "${module.cluster-network.internal_subnet_id}"
     floating_ip_ood = "${module.floating-ip.ood_address}"
     flavor = var.flavor
     host_prefix = var.host_prefix
@@ -109,6 +121,8 @@ module "ood-instance" {
     ssh_private_key = var.ssh_private_key
 }
 
+# runs the nodes module - creates nodes using variables defined above
+# calls functions from cluster-network and keypair modules to get values created there for use
 module "nodes" {
     source = "./nodes"
     internal_subnet_id = "${module.cluster-network.internal_subnet_id}"
@@ -119,10 +133,12 @@ module "nodes" {
     compute_node_count = var.compute_node_count
 }
 
+# calls the outputs defined in the ohpc-instance module
 output "ohpc-ssh_host" {
     value = "${module.ohpc-instance.ssh_host}"
 }
 
+# calls the outputs defined in the ood-instance module
 output "ood-ssh_host" {
     value = "${module.ood-instance.ssh_host}"
 }
\ No newline at end of file