Add variable description

Author: aurimasmick

README.md

@@ -70,23 +70,23 @@ module "opensearch" {
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_create_opensearch"></a> [create\_opensearch](#input\_create\_opensearch) | create\_opensearch | `bool` | `false` | no |
+| <a name="input_create_opensearch"></a> [create\_opensearch](#input\_create\_opensearch) | Whether to create OpenSearch cluster | `bool` | `false` | no |
 | <a name="input_enable_advanced_security_options"></a> [enable\_advanced\_security\_options](#input\_enable\_advanced\_security\_options) | Whether advanced security is enabled | `bool` | `true` | no |
 | <a name="input_enable_internal_user_database"></a> [enable\_internal\_user\_database](#input\_enable\_internal\_user\_database) | Whether the internal user database is enabled | `bool` | `false` | no |
-| <a name="input_enable_saml"></a> [enable\_saml](#input\_enable\_saml) | enable\_saml | `bool` | `true` | no |
-| <a name="input_environment"></a> [environment](#input\_environment) | Environment | `string` | n/a | yes |
+| <a name="input_enable_saml"></a> [enable\_saml](#input\_enable\_saml) | Whether OpenSearch SAML options are enabled | `bool` | `true` | no |
+| <a name="input_environment"></a> [environment](#input\_environment) | Environment name | `string` | n/a | yes |
 | <a name="input_master_user_arn"></a> [master\_user\_arn](#input\_master\_user\_arn) | User or role arn which is provisioning opensearch. This role is used to configure opensearch TF provider. | `string` | `null` | no |
 | <a name="input_name_prefix"></a> [name\_prefix](#input\_name\_prefix) | Prefix to be used with resources | `string` | n/a | yes |
-| <a name="input_opensearch_engine_version"></a> [opensearch\_engine\_version](#input\_opensearch\_engine\_version) | opensearch\_engine\_version | `string` | `"OpenSearch_1.2"` | no |
-| <a name="input_opensearch_instance_count"></a> [opensearch\_instance\_count](#input\_opensearch\_instance\_count) | opensearch\_instance\_count | `string` | `"1"` | no |
-| <a name="input_opensearch_instance_type"></a> [opensearch\_instance\_type](#input\_opensearch\_instance\_type) | opensearch\_instance\_type | `string` | `"t3.small.search"` | no |
-| <a name="input_opensearch_subdomain"></a> [opensearch\_subdomain](#input\_opensearch\_subdomain) | opensearch\_subdomain | `string` | `"opensearch"` | no |
-| <a name="input_opensearch_volume_size"></a> [opensearch\_volume\_size](#input\_opensearch\_volume\_size) | opensearch\_volume\_size | `number` | `40` | no |
-| <a name="input_region"></a> [region](#input\_region) | Region | `string` | n/a | yes |
-| <a name="input_roles_mappings"></a> [roles\_mappings](#input\_roles\_mappings) | roles\_mappings | <pre>map(object({<br>    description   = optional(string)<br>    backend_roles = list(string)<br>  }))</pre> | `{}` | no |
-| <a name="input_route_53_zone_name"></a> [route\_53\_zone\_name](#input\_route\_53\_zone\_name) | route\_53\_zone\_name | `string` | n/a | yes |
-| <a name="input_sso_admins_group_id"></a> [sso\_admins\_group\_id](#input\_sso\_admins\_group\_id) | sso\_admins\_group\_id | `string` | `null` | no |
-| <a name="input_sso_entity_id"></a> [sso\_entity\_id](#input\_sso\_entity\_id) | sso\_entity\_id | `string` | `null` | no |
+| <a name="input_opensearch_engine_version"></a> [opensearch\_engine\_version](#input\_opensearch\_engine\_version) | Either Elasticsearch\_X.Y or OpenSearch\_X.Y to specify the engine version for the Amazon OpenSearch Service domain | `string` | `"OpenSearch_1.2"` | no |
+| <a name="input_opensearch_instance_count"></a> [opensearch\_instance\_count](#input\_opensearch\_instance\_count) | Number of instances in the cluster | `string` | `"1"` | no |
+| <a name="input_opensearch_instance_type"></a> [opensearch\_instance\_type](#input\_opensearch\_instance\_type) | Instance type of data nodes in the cluster | `string` | `"t3.small.search"` | no |
+| <a name="input_opensearch_subdomain"></a> [opensearch\_subdomain](#input\_opensearch\_subdomain) | Route53 OpenSearch subdomain | `string` | `"opensearch"` | no |
+| <a name="input_opensearch_volume_size"></a> [opensearch\_volume\_size](#input\_opensearch\_volume\_size) | Size of EBS volumes attached to data nodes (in GiB) | `number` | `40` | no |
+| <a name="input_region"></a> [region](#input\_region) | Region name | `string` | n/a | yes |
+| <a name="input_roles_mappings"></a> [roles\_mappings](#input\_roles\_mappings) | OpenSearch roles mappings | <pre>map(object({<br>    description   = optional(string)<br>    backend_roles = list(string)<br>  }))</pre> | `{}` | no |
+| <a name="input_route_53_zone_name"></a> [route\_53\_zone\_name](#input\_route\_53\_zone\_name) | Route53 DNS zone | `string` | n/a | yes |
+| <a name="input_sso_admins_group_id"></a> [sso\_admins\_group\_id](#input\_sso\_admins\_group\_id) | AWS SSO admins group | `string` | `null` | no |
+| <a name="input_sso_entity_id"></a> [sso\_entity\_id](#input\_sso\_entity\_id) | AWS SSO entity ID | `string` | `null` | no |
 
 ## Outputs
 

variables.tf

@@ -1,5 +1,5 @@
 variable "region" {
-  description = "Region"
+  description = "Region name"
   type        = string
 }
 
@@ -9,47 +9,47 @@ variable "name_prefix" {
 }
 
 variable "environment" {
-  description = "Environment"
+  description = "Environment name"
   type        = string
 }
 
 variable "create_opensearch" {
-  description = "create_opensearch"
+  description = "Whether to create OpenSearch cluster"
   type        = bool
   default     = false
 }
 
 variable "route_53_zone_name" {
-  description = "route_53_zone_name"
+  description = "Route53 DNS zone"
   type        = string
 }
 
 variable "opensearch_subdomain" {
-  description = "opensearch_subdomain"
+  description = "Route53 OpenSearch subdomain"
   type        = string
   default     = "opensearch"
 }
 
 variable "opensearch_engine_version" {
-  description = "opensearch_engine_version"
+  description = "Either Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain"
   type        = string
   default     = "OpenSearch_1.2"
 }
 
 variable "opensearch_instance_type" {
-  description = "opensearch_instance_type"
+  description = "Instance type of data nodes in the cluster"
   type        = string
   default     = "t3.small.search"
 }
 
 variable "opensearch_instance_count" {
-  description = "opensearch_instance_count"
+  description = "Number of instances in the cluster"
   type        = string
   default     = "1"
 }
 
 variable "opensearch_volume_size" {
-  description = "opensearch_volume_size"
+  description = "Size of EBS volumes attached to data nodes (in GiB)"
   type        = number
   default     = 40
 }
@@ -75,27 +75,27 @@ variable "master_user_arn" {
 # SAML
 
 variable "enable_saml" {
-  description = "enable_saml"
+  description = "Whether OpenSearch SAML options are enabled"
   type        = bool
   default     = true
 }
 
 variable "sso_entity_id" {
-  description = "sso_entity_id"
+  description = "AWS SSO entity ID"
   type        = string
   default     = null
 }
 
 variable "sso_admins_group_id" {
-  description = "sso_admins_group_id"
+  description = "AWS SSO admins group"
   type        = string
   default     = null
 }
 
 # OpenSearch roles
 
 variable "roles_mappings" {
-  description = "roles_mappings"
+  description = "OpenSearch roles mappings"
   type = map(object({
     description   = optional(string)
     backend_roles = list(string)