update Readme

Author: ShibraAmin18

.pre-commit-config.yaml

@@ -6,13 +6,15 @@ repos:
       - id: terraform-validate
       - id: tflint
         args:
-          - "--module"
-          - "--deep"
+          # - "--module"
           - "--config=.tflint.hcl"
-  - repo: https://github.com/squareops/pre-commit-terraform
-    rev: v1.47.0
+  - repo: https://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.74.0
     hooks:
       - id: terraform_docs
+        args:
+          - --hook-config=--add-to-existing-file=true   
+          - --hook-config=--create-file-if-not-exist=true
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.1.0
     hooks:

README.md

@@ -1,10 +1,3 @@
-## IAM permission Required to run this module
-
-- AmazonVPCFullAccess
-- CloudWatchFullAccess
-- AmazonSSMFullAccess
-- AmazonEC2FullAccess
-- IAMFullAccess
 
 # AWS Network Terraform module
 
@@ -14,17 +7,19 @@ Terraform module to create Networking resources for workload deployment on AWS C
 
 ```hcl
 module "vpc" {
-  source = "git::https://{GIT_USER}:{GIT_TOKEN}@gitlab.com/squareops/sal/terraform/aws/network.git?ref=dev"
-
-  environment                                     = var.environment
-  name                                            = var.name
-  region                                          = var.region
-  additional_aws_tags                                 = var.additional_aws_tags
-  vpc_cidr                                        = var.vpc_cidr
-  public_subnets                                  = var.public_subnets
+  source = "git@gitlab.com:squareops/sal/terraform/aws/network.git?ref=qa"
+
+  environment          = "dev"
+  name                 = "skaf"
+  region               = "us-east-1"
+  vpc_cidr             = "10.0.0.0/16"
+  azs                  = ["us-east-1a", "us-east-1b"]
+  enable_public_subnet = true
 }
 
 ```
+Refer ```examples``` directory for more reference.
+
 ## Network Scenarios
 
 This module supports three scenarios for creating Network resource on AWS. Each will be explained in further detail in the corresponding sections.
@@ -73,14 +68,13 @@ If both `single_nat_gateway` and `one_nat_gateway_per_az` are set to `true`, the
 
 Make sure whenever you set `one_nat_gateway_per_az` to `true` you should have as many public subnets as we have AZ in the region or else this module will fail cause some `region` has more than 3 AZ like N.Virginia and we bydefault provisoning only 3 public subnets 
 
-- To create ***CIS compliant VPC*** set the variable ***create_cis_vpc*** to ***true*** in the .tfvars file.
 
 - To add SSL to the Pritunl endpoint:
 
-        Create a DNS record mapping to the vpn host public IP.
-        Login to pritunl from the credentials in the pritunl-info.txt in the pritunl folder.
-        After login,in the Initial setup window, add the record created in the 'Lets Encrypt Domain' field.
-        Pritunl will automatically configure a signed SSL certificate from Lets Encrypt.
+      1. Create a DNS record mapping to the vpn host public IP
+      2. Login to pritunl from the credentials in the pritunl-info.txt in the pritunl folder.
+      3. After login,in the Initial setup window, add the record created in the 'Lets Encrypt Domain' field.
+      4. Pritunl will automatically configure a signed SSL certificate from Lets Encrypt.
 
         NOTE: Port 80 to be open publicly in the vpn security group to verify and renewing the domain certificate.
 # CIS COMPLIANCE 
@@ -130,19 +124,19 @@ server administration ports (Automated)
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_azs"></a> [azs](#input\_azs) | List of Availability Zone to be used by VPC | `list(any)` | `[]` | no |
+| <a name="input_azs"></a> [azs](#input\_azs) | List of Availability Zone to be used by VPC | `list(any)` | n/a | yes |
 | <a name="input_database_subnet_cidrs"></a> [database\_subnet\_cidrs](#input\_database\_subnet\_cidrs) | Database Tier subnet CIDRs to be created | `list(any)` | `[]` | no |
 | <a name="input_default_network_acl_ingress"></a> [default\_network\_acl\_ingress](#input\_default\_network\_acl\_ingress) | List of maps of ingress rules to set on the Default Network ACL | `list(map(string))` | <pre>[<br>  {<br>    "action": "deny",<br>    "cidr_block": "0.0.0.0/0",<br>    "from_port": 22,<br>    "protocol": "tcp",<br>    "rule_no": 98,<br>    "to_port": 22<br>  },<br>  {<br>    "action": "deny",<br>    "cidr_block": "0.0.0.0/0",<br>    "from_port": 3389,<br>    "protocol": "tcp",<br>    "rule_no": 99,<br>    "to_port": 3389<br>  },<br>  {<br>    "action": "allow",<br>    "cidr_block": "0.0.0.0/0",<br>    "from_port": 0,<br>    "protocol": "-1",<br>    "rule_no": 100,<br>    "to_port": 0<br>  },<br>  {<br>    "action": "allow",<br>    "from_port": 0,<br>    "ipv6_cidr_block": "::/0",<br>    "protocol": "-1",<br>    "rule_no": 101,<br>    "to_port": 0<br>  }<br>]</pre> | no |
 | <a name="input_enable_database_subnet"></a> [enable\_database\_subnet](#input\_enable\_database\_subnet) | Set true to enable database subnets | `bool` | `false` | no |
 | <a name="input_enable_flow_log"></a> [enable\_flow\_log](#input\_enable\_flow\_log) | Whether or not to enable VPC Flow Logs | `bool` | `false` | no |
 | <a name="input_enable_intra_subnet"></a> [enable\_intra\_subnet](#input\_enable\_intra\_subnet) | Set true to enable intra subnets | `bool` | `false` | no |
 | <a name="input_enable_private_subnet"></a> [enable\_private\_subnet](#input\_enable\_private\_subnet) | Set true to enable private subnets | `bool` | `false` | no |
 | <a name="input_enable_public_subnet"></a> [enable\_public\_subnet](#input\_enable\_public\_subnet) | Set true to enable public subnets | `bool` | `false` | no |
-| <a name="input_environment"></a> [environment](#input\_environment) | Specify the environment indentifier for the VPC | `string` | `""` | no |
+| <a name="input_environment"></a> [environment](#input\_environment) | Specify the environment indentifier for the VPC | `string` | n/a | yes |
 | <a name="input_flow_log_cloudwatch_log_group_retention_in_days"></a> [flow\_log\_cloudwatch\_log\_group\_retention\_in\_days](#input\_flow\_log\_cloudwatch\_log\_group\_retention\_in\_days) | Specifies the number of days you want to retain log events in the specified log group for VPC flow logs. | `number` | `null` | no |
 | <a name="input_flow_log_max_aggregation_interval"></a> [flow\_log\_max\_aggregation\_interval](#input\_flow\_log\_max\_aggregation\_interval) | The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. Valid Values: `60` seconds or `600` seconds. | `number` | `60` | no |
 | <a name="input_intra_subnet_cidrs"></a> [intra\_subnet\_cidrs](#input\_intra\_subnet\_cidrs) | A list of intra subnets CIDR to be created | `list(any)` | `[]` | no |
-| <a name="input_name"></a> [name](#input\_name) | Specify the name of the VPC | `string` | `""` | no |
+| <a name="input_name"></a> [name](#input\_name) | Specify the name of the VPC | `string` | n/a | yes |
 | <a name="input_one_nat_gateway_per_az"></a> [one\_nat\_gateway\_per\_az](#input\_one\_nat\_gateway\_per\_az) | Set to true if a NAT Gateway is required per availability zone for Private Subnet Tier | `bool` | `false` | no |
 | <a name="input_private_subnet_cidrs"></a> [private\_subnet\_cidrs](#input\_private\_subnet\_cidrs) | A list of private subnets CIDR to be created inside the VPC | `list(any)` | `[]` | no |
 | <a name="input_public_subnet_cidrs"></a> [public\_subnet\_cidrs](#input\_public\_subnet\_cidrs) | A list of public subnets CIDR to be created inside the VPC | `list(any)` | `[]` | no |

examples/simple-vpc/main.tf

@@ -2,7 +2,7 @@ locals {
   region      = "us-east-1"
   environment = "dev"
   name        = "simple-example"
-  additional_tags = {
+  additional_aws_tags = {
     Owner      = "SquareOps"
     Expires    = "Never"
     Department = "Engineering"

main.tf

@@ -113,7 +113,7 @@ module "vpn_server" {
   region                   = var.region
   vpc_cidr                 = var.vpc_cidr
   vpc_id                   = module.vpc.vpc_id
-  public_subnet           = module.vpc.public_subnets[0]
+  public_subnet            = module.vpc.public_subnets[0]
   vpn_key_pair             = var.vpn_key_pair
   vpn_server_instance_type = var.vpn_server_instance_type
 }

variables.tf

@@ -6,13 +6,11 @@ variable "region" {
 
 variable "environment" {
   description = "Specify the environment indentifier for the VPC"
-  default     = ""
   type        = string
 }
 
 variable "name" {
   description = "Specify the name of the VPC"
-  default     = ""
   type        = string
 }
 
@@ -24,7 +22,6 @@ variable "vpc_cidr" {
 
 variable "azs" {
   description = "List of Availability Zone to be used by VPC"
-  default     = []
   type        = list(any)
 }