standardization for v1.0

siddharthbarhate · siddharthbarhate · commit 3a52aa2e3c3b · 2023-01-19T20:10:07.000+05:30
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2023 SquareOps Technologies Pvt. Ltd. 
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
diff --git a/README.md b/README.md
@@ -1,42 +1,76 @@
 
 # AWS Network Terraform module
 
+![squareops_avatar]
+
+[squareops_avatar]: https://squareops.com/img/home1/Squareops_logo.jpg
+
+### [SquareOps Technologies](https://squareops.com/) Provide end to end solution for all your DevOps needs
+
+<br>
+
+
 Terraform module to create Networking resources for workload deployment on AWS Cloud.
 
+<br>
+
 ## Usage Example
 
 ```hcl
+
+module "key_pair_vpn" {
+  source             = "squareops/terraform-aws-ec2-keypair"
+  region             = us-east-1
+  environment        = production
+  key_name           = format("%s-%s-vpn", production, skaf)
+  ssm_parameter_path = format("%s-%s-vpn", production, skaf)
+}
+
+
 module "vpc" {
-  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
+  source = "squareops/terraform-aws-network"
+
+  environment                                     = "production"
+  name                                            = "skaf"
+  region                                          = "us-east-1"
+  vpc_cidr                                        = "10.0.0.0/16"
+  azs                                             = ["us-east-1a", "us-east-1b"]
+  enable_public_subnet                            = true
+  enable_private_subnet                           = true
+  enable_database_subnet                          = true
+  enable_intra_subnet                             = true
+  one_nat_gateway_per_az                          = true
+  vpn_server_enabled                              = true
+  vpn_server_instance_type                        = "t3a.small"
+  vpn_key_pair                                    = module.key_pair_vpn.key_pair_name
+  enable_flow_log                                 = true
+  flow_log_max_aggregation_interval               = 60
+  flow_log_cloudwatch_log_group_retention_in_days = 90
+
 }
 
+
 ```
-Refer [examples](https://gitlab.com/squareops/sal/terraform/aws/network/-/tree/qa/examples) directory for more references.
+Refer [examples](examples) for all examples.
+
 ## Important Note
-To prevent destruction interruptions, any extra LBs or resources that have been created outside of Terraform and attached to the Terraform resources must be deleted before the module is destroyed. 
+To prevent destruction interruptions, any resources that have been created outside of Terraform and attached to the resources provisioned by Terraform must be deleted before the module is destroyed. 
 
 ## Network Scenarios
 
-Users need to provide `vpc_cidr` and subnets are calculated with the help of [in-built functions](https://gitlab.com/squareops/sal/terraform/aws/network/-/blob/qa/main.tf#L2).
+Users need to declare `vpc_cidr` and subnets are calculated with the help of in-built functions.
 
-This module supports three scenarios for creating Network resource on AWS. Each will be explained in detail in the corresponding sections.
+This module supports three scenarios to create Network resource on AWS. Each will be explained in brief in the corresponding sections.
 
-- **simple-vpc (default behavior):** For creating a VPC with only public subnets and IGW.
+- **simple-vpc (default behavior):** To create a VPC with public subnets and IGW.
   - `vpc_cidr       = ""`
   - `enable_public_subnet = true`
-- **vpc-with-private-sub:** For creating a VPC with both public and private subnets and IGW and NAT gateway.
+- **vpc-with-private-sub:** To create a VPC with public subnets, private subnets, IGW gateway and NAT gateway.
   - `vpc_cidr              = local.vpc_cidr`
   - `enable_public_subnet  = true`
   - `enable_private_subnet = true`
 
-- **complete-vpc-with-vpn:** For creating a VPC with public, private, database and intra subnets along with an IGW and NAT gateway. Jump server/Bastion Host is also configured. 
+- **complete-vpc-with-vpn:** To create a VPC with public, private, database and intra subnets along with an IGW and NAT gateway. Jump server/Bastion Host is also configured. 
   - `vpc_cidr               = local.vpc_cidr`
   - `enable_public_subnet   = true`
   - `enable_private_subnet  = true`
@@ -50,6 +84,12 @@ This module supports three scenarios for creating Network resource on AWS. Each
   - `flow_log_max_aggregation_interval               = 60`
   - `flow_log_cloudwatch_log_group_retention_in_days = 90`
 
+
+# IAM Permissions
+The required IAM permissions to create resources from this module can be found [here](https://github.com/squareops/terraform-aws-network/blob/main/IAM.md)
+
+
+
 # VPN setup-
 
 To configure Pritunl VPN:
@@ -83,73 +123,6 @@ server administration ports (Automated)
 (Automated)
 
 
-<!-- BEGIN_TF_DOCS -->
-## Requirements
-
-| Name | Version |
-|------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.23 |
-
-## Providers
-
-| Name | Version |
-|------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.31.0 |
-
-## Modules
-
-| Name | Source | Version |
-|------|--------|---------|
-| <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | 3.14.4 |
-| <a name="module_vpn_server"></a> [vpn\_server](#module\_vpn\_server) | ./modules/vpn | n/a |
-
-## Resources
-
-| Name | Type |
-|------|------|
-| [aws_ec2_instance_type.arch](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ec2_instance_type) | data source |
-
-## Inputs
-
-| Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:--------:|
-| <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` | 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` | 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 |
-| <a name="input_region"></a> [region](#input\_region) | Specify the region in which VPC will be created | `string` | `"us-east-1"` | no |
-| <a name="input_vpc_cidr"></a> [vpc\_cidr](#input\_vpc\_cidr) | The CIDR block of the VPC | `string` | `"10.0.0.0/16"` | no |
-| <a name="input_vpn_key_pair"></a> [vpn\_key\_pair](#input\_vpn\_key\_pair) | Specify the name of AWS Keypair to be used for VPN Server | `string` | `""` | no |
-| <a name="input_vpn_server_enabled"></a> [vpn\_server\_enabled](#input\_vpn\_server\_enabled) | Set to true if you want to deploy VPN Gateway resource and attach it to the VPC | `bool` | `false` | no |
-| <a name="input_vpn_server_instance_type"></a> [vpn\_server\_instance\_type](#input\_vpn\_server\_instance\_type) | EC2 instance Type for VPN Server, Only amd64 based instance type are supported eg. t2.medium, t3.micro, c5a.large etc. | `string` | `"t3a.small"` | no |
-
-## Outputs
-
-| Name | Description |
-|------|-------------|
-| <a name="output_database_subnets"></a> [database\_subnets](#output\_database\_subnets) | List of IDs of database subnets |
-| <a name="output_intra_subnets"></a> [intra\_subnets](#output\_intra\_subnets) | Intra Subnet IDs |
-| <a name="output_private_subnets"></a> [private\_subnets](#output\_private\_subnets) | List of IDs of private subnets |
-| <a name="output_public_subnets"></a> [public\_subnets](#output\_public\_subnets) | List of IDs of public subnets |
-| <a name="output_region"></a> [region](#output\_region) | AWS Region for the VPC |
-| <a name="output_vpc_cidr_block"></a> [vpc\_cidr\_block](#output\_vpc\_cidr\_block) | IPV4 CIDR Block for this VPC |
-| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC |
-| <a name="output_vpn_host_public_ip"></a> [vpn\_host\_public\_ip](#output\_vpn\_host\_public\_ip) | IP Address of VPN Server |
-| <a name="output_vpn_security_group"></a> [vpn\_security\_group](#output\_vpn\_security\_group) | Security Group ID of VPN Server |
-<!-- END_TF_DOCS -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
@@ -217,3 +190,6 @@ server administration ports (Automated)
 | <a name="output_vpn_host_public_ip"></a> [vpn\_host\_public\_ip](#output\_vpn\_host\_public\_ip) | IP Address of VPN Server |
 | <a name="output_vpn_security_group"></a> [vpn\_security\_group](#output\_vpn\_security\_group) | Security Group ID of VPN Server |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+
+
diff --git a/examples/complete-vpc-with-vpn/README.md b/examples/complete-vpc-with-vpn/README.md
@@ -1,4 +1,22 @@
-# complete-vpc-with-vpn
+# Complete VPC with VPN
+
+This configuration is suitable for production environments
+
+A NAT Gateway, Public and Private subnet will be created per availability zone. 
+
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+$ terraform init
+$ terraform plan
+$ terraform apply
+```
+
+Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
+
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
@@ -43,3 +61,5 @@ No inputs.
 | <a name="output_vpn_host_public_ip"></a> [vpn\_host\_public\_ip](#output\_vpn\_host\_public\_ip) | IP Adress of VPN Server |
 | <a name="output_vpn_security_group"></a> [vpn\_security\_group](#output\_vpn\_security\_group) | Security Group ID of VPN Server |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+
diff --git a/examples/complete-vpc-with-vpn/main.tf b/examples/complete-vpc-with-vpn/main.tf
@@ -14,15 +14,15 @@ data "aws_region" "current" {}
 data "aws_availability_zones" "available" {}
 
 module "key_pair_vpn" {
-  source             = "git@gitlab.com:squareops/sal/terraform/aws/ec2-keypair.git?ref=qa"
+  source             = "squareops/terraform-aws-ec2-keypair"
   region             = local.region
   environment        = local.environment
   key_name           = format("%s-%s-vpn", local.environment, local.name)
   ssm_parameter_path = format("%s-%s-vpn", local.environment, local.name)
 }
 
 module "vpc" {
-  source = "git@gitlab.com:squareops/sal/terraform/aws/network.git?ref=qa"
+  source = "squareops/terraform-aws-network"
 
   environment                                     = local.environment
   name                                            = local.name
@@ -33,7 +33,7 @@ module "vpc" {
   enable_private_subnet                           = true
   enable_database_subnet                          = true
   enable_intra_subnet                             = true
-  one_nat_gateway_per_az                          = false
+  one_nat_gateway_per_az                          = true
   vpn_server_enabled                              = true
   vpn_server_instance_type                        = "t3a.small"
   vpn_key_pair                                    = module.key_pair_vpn.key_pair_name
diff --git a/examples/simple-vpc/README.md b/examples/simple-vpc/README.md
@@ -18,42 +18,6 @@ $ terraform apply
 
 Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
 
-<!-- BEGIN_TF_DOCS -->
-## Requirements
-
-| Name | Version |
-|------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.1 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.63 |
-
-## Providers
-
-No providers.
-
-## Modules
-
-| Name | Source | Version |
-|------|--------|---------|
-| <a name="module_vpc"></a> [vpc](#module\_vpc) | ../../ | n/a |
-
-## Resources
-
-No resources.
-
-## Inputs
-
-No inputs.
-
-## Outputs
-
-| Name | Description |
-|------|-------------|
-| <a name="output_private_subnets"></a> [private\_subnets](#output\_private\_subnets) | List of IDs of private subnets |
-| <a name="output_public_subnets"></a> [public\_subnets](#output\_public\_subnets) | List of IDs of public subnets |
-| <a name="output_region"></a> [region](#output\_region) | AWS Region |
-| <a name="output_vpc_cidr_block"></a> [vpc\_cidr\_block](#output\_vpc\_cidr\_block) | AWS Region |
-| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC |
-<!-- END_TF_DOCS -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
diff --git a/examples/simple-vpc/main.tf b/examples/simple-vpc/main.tf
@@ -18,7 +18,7 @@ data "aws_availability_zones" "available" {}
 ################################################################################
 
 module "vpc" {
-  source = "../../"
+  source = "squareops/terraform-aws-network"
 
   environment          = local.environment
   name                 = local.name
diff --git a/examples/vpc-with-private-sub/README.md b/examples/vpc-with-private-sub/README.md
@@ -1,4 +1,20 @@
-# vpc-with-private-sub
+# VPC with Private Subnets
+
+
+A public and private subnet will be created per availability zone in addition to single NAT Gateway shared between all availability zones.
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+$ terraform init
+$ terraform plan
+$ terraform apply
+```
+
+Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
+
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
diff --git a/examples/vpc-with-private-sub/main.tf b/examples/vpc-with-private-sub/main.tf
@@ -14,7 +14,7 @@ data "aws_region" "current" {}
 data "aws_availability_zones" "available" {}
 
 module "vpc" {
-  source = "git@gitlab.com:squareops/sal/terraform/aws/network.git?ref=qa"
+  source = "squareops/terraform-aws-network"
 
   environment           = local.environment
   name                  = local.name
diff --git a/main.tf b/main.tf
@@ -15,7 +15,7 @@ data "aws_ec2_instance_type" "arch" {
 
 module "vpc" {
   source                                          = "terraform-aws-modules/vpc/aws"
-  version                                         = "3.14.4"
+  version                                         = "1.0.0"
   name                                            = format("%s-%s-vpc", var.environment, var.name)
   cidr                                            = var.vpc_cidr # CIDR FOR VPC
   azs                                             = var.azs
diff --git a/modules/vpn/README.md b/modules/vpn/README.md
@@ -1,5 +1,15 @@
 # VPN
 
+Terraform module to create Pritunl VPN server on AWS.
+
+Pritunl is an VPN software with features including but not limited to:
+- Open Source
+- Supports multiple protocols
+- Supports Single Sign-On
+- Highly secure
+
+Refer [this](https://pritunl.com/) for more information.
+
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
diff --git a/outputs.tf b/outputs.tf
@@ -29,7 +29,7 @@ output "database_subnets" {
 }
 
 output "intra_subnets" {
-  description = "Intra Subnet IDs"
+  description = "List of IDs of Intra subnets"
   value       = length(module.vpc.intra_subnets) > 0 ? module.vpc.intra_subnets : null
 
 }
