add description

rds-oracle/CHANGELOG.md

@@ -1,5 +1,8 @@
-# v1.3 -- 20200604
+* v1.3 -- 20200604
   - add module version, update tags
 
-# v1.3.1 -- 20210621
+* v1.3.1 -- 20210621
   - add ports 2483 and 2484 (tcp, tcp+ssl)
+
+* v1.3.2 -- 20210621
+  - add variable description

rds-oracle/README.md

@@ -10,6 +10,10 @@ module "rds-oracle" {
 
   # name = "m-rds-oracle"
   vpc_id = var.vpc_id
+
+  ## optional
+  # description = "my other description"    # not recommended to change this
+
   # Name, CostAllocation, and Environment are pre-set
   # tags = { }
 }
@@ -41,6 +45,7 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
+| <a name="input_description"></a> [description](#input\_description) | Security group description | `string` | `"module: Oracle common ports"` | no |
 | <a name="input_egress_networks"></a> [egress\_networks](#input\_egress\_networks) | List of egress networks (all ports) | `list(string)` | <pre>[<br>  "0.0.0.0/0"<br>]</pre> | no |
 | <a name="input_name"></a> [name](#input\_name) | Security group Name | `string` | `"m-oracle-db"` | no |
 | <a name="input_networks"></a> [networks](#input\_networks) | List of ingress networks (applies to all ports) | `list(string)` | <pre>[<br>  "0.0.0.0/0"<br>]</pre> | no |

rds-oracle/main.tf

@@ -11,6 +11,10 @@
 * 
 *   # name = "m-rds-oracle"
 *   vpc_id = var.vpc_id
+* 
+*   ## optional
+*   # description = "my other description"    # not recommended to change this
+*
 *   # Name, CostAllocation, and Environment are pre-set
 *   # tags = { }
 * }

rds-oracle/ports.tf

@@ -1,5 +1,5 @@
 locals {
-  description = "module: Oracle common ports"
+  description = var.description
   name        = var.name
   ports = [
     [1521, 1521, "tcp", "oracle-db", []],

rds-oracle/variables.tf

@@ -16,6 +16,12 @@ variable "name" {
   default = "m-oracle-db"
 }
 
+variable "description" {
+  description = "Security group description"
+  type        = string
+  default     = "module: Oracle common ports"
+}
+
 variable "networks" {
   description = "List of ingress networks (applies to all ports)"
   type        = list(string)

rds-oracle/version.tf

@@ -1,3 +1,3 @@
 locals {
-  _module_version = "1.3.1"
+  _module_version = "1.3.2"
 }