Merge pull request #3 from RohitSquareops/Release-v1.0.0

sunil-kumar-squareops · web-flow · commit 55957419203b · 2023-06-07T17:01:38.000+05:30
Initial Release
diff --git a/IAM.md b/IAM.md
@@ -0,0 +1,31 @@
+## IAM Permission
+
+The Policy required to deploy this module:
+```hcl
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "VisualEditor0",
+            "Effect": "Allow",
+            "Action": [
+                "ec2:AuthorizeSecurityGroupEgress",
+                "ec2:AuthorizeSecurityGroupIngress",
+                "ec2:CreateSecurityGroup",
+                "ec2:CreateTags",
+                "ec2:DeleteSecurityGroup",
+                "ec2:DeleteTags",
+                "ec2:DescribeAccountAttributes",
+                "ec2:DescribeAvailabilityZones",
+                "ec2:DescribeNetworkInterfaces",
+                "ec2:DescribeSecurityGroups",
+                "ec2:RevokeSecurityGroupEgress",
+                "ec2:RevokeSecurityGroupIngress"
+            ],
+            "Resource": [
+                "*"
+            ]
+        },
+    ]
+}
+```
diff --git a/README.md b/README.md
@@ -21,10 +21,10 @@ This Terraform module provisions an Amazon RDS PostgreSQL database on AWS. Amazo
 ## Usage Examples
 ```hcl
 module "rds-pg" {
-  source                           = "https://github.com/sq-ia/terraform-aws-rds-postgresql.git"
-  name                             = "skaf"
-  db_name                          = "postgres"
-  vpc_id                           = "vpc-047eb87de44acfb73"
+  source                           = "squareops/rds-postgresql/aws"
+  name                             = "postgresql"
+  db_name                          = "proddb"
+  vpc_id                           = "vpc-047eb8acfb73"
   multi_az                         = "true"
   subnet_ids                       = ["subnet-b39cfc", "subnet-090b8d8"]
   environment                      = "prod"
@@ -37,13 +37,16 @@ module "rds-pg" {
   skip_final_snapshot              = true
   backup_window                    = "03:00-06:00"
   maintenance_window               = "Mon:00:00-Mon:03:00"
-  allowed_security_groups          = ["sg-013cb57dc3bc6f880"]
   major_engine_version             = "15.2"
   deletion_protection              = false
+  allowed_security_groups          = ["sg-013cbf880"]
   final_snapshot_identifier_prefix = "final"
 }
 ```
-Refer [examples](https://github.com/sq-ia/terraform-aws-rds-postgresql/tree/main/example/complete) for more details.
+Refer [examples](https://github.com/squareops/terraform-aws-rds-postgresql/tree/main/example/complete) for more details.
+
+## IAM Permissions
+The required IAM permissions to create resources from this module can be found [here](https://github.com/squareops/terraform-aws-rds-postgresql/blob/main/IAM.md)
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
@@ -130,7 +133,7 @@ Refer [examples](https://github.com/sq-ia/terraform-aws-rds-postgresql/tree/main
 
 To report an issue with a project:
 
-  1. Check the repository's [issue tracker](https://github.com/sq-ia/terraform-aws-rds-postgresql/issues) on GitHub
+  1. Check the repository's [issue tracker](https://github.com/squareops/terraform-aws-rds-postgresql/issues) on GitHub
   2. Search to check if the issue has already been reported
   3. If you can't find an answer to your question in the documentation or issue tracker, you can ask a question by creating a new issue. Make sure to provide enough context and details.
 
@@ -142,7 +145,7 @@ Apache License, Version 2.0, January 2004 (https://www.apache.org/licenses/LICEN
 
 To support our GitHub project by liking it, you can follow these steps:
 
-  1. Visit the repository: Navigate to the [GitHub repository](https://github.com/sq-ia/terraform-aws-rds-postgresql)
+  1. Visit the repository: Navigate to the [GitHub repository](https://github.com/squareops/terraform-aws-rds-postgresql)
 
   2. Click the "Star" button: On the repository page, you'll see a "Star" button in the upper right corner. Clicking on it will star the repository, indicating your support for the project.
 
diff --git a/example/complete/README.md b/example/complete/README.md
@@ -24,7 +24,7 @@ No providers.
 
 | Name | Source | Version |
 |------|--------|---------|
-| <a name="module_rds-pg"></a> [rds-pg](#module\_rds-pg) | git@github.com:sq-ia/terraform-aws-rds-postgresql.git | n/a |
+| <a name="module_rds-pg"></a> [rds-pg](#module\_rds-pg) | squareops/postgresql-rds/aws | n/a |
 
 ## Resources
 
diff --git a/example/complete/main.tf b/example/complete/main.tf
@@ -1,18 +1,23 @@
 locals {
   region         = "us-east-2"
-  name           = "skaf"
-  vpc_id         = "vpc-00ae5511ee10671c1"
+  name           = "postgresql"
+  vpc_id         = "vpc-00ae5571c1"
   family         = "postgres15"
-  subnet_ids     = ["subnet-0d9a81939c6dd2a6e","subnet-0fd26f0d73dc9e73d"]
+  subnet_ids     = ["subnet-0d9a8193d2a6e","subnet-0fd263dc9e73d"]
   environment    = "prod"
-  kms_key_arn    = "arn:aws:kms:us-east-2:271251951598:key/73ff9e84-83e1-4097-b388-fe29623338a9"
+  kms_key_arn    = "arn:aws:kms:us-east-2:22222222:key/73ff9e84-83e1-fe29623338a9"
   engine_version = "15.2"
   instance_class = "db.m5d.large"
-  allowed_security_groups = ["sg-0a680184e11eafd35"]
+  allowed_security_groups = ["sg-0a680afd35"]
+  additional_tags = {
+    Owner      = "Organization_Name"
+    Expires    = "Never"
+    Department = "Engineering"
+  }
 }
 
 module "rds-pg" {
-  source                           = "git@github.com:sq-ia/terraform-aws-rds-postgresql.git"
+  source                           = "squareops/rds-postgresql/aws"
   name                             = local.name
   db_name                          = "postgres"
   multi_az                         = "true"
diff --git a/example/complete/provider.tf b/example/complete/provider.tf
@@ -1,3 +1,6 @@
 provider "aws" {
   region = local.region
+  default_tags {
+    tags = local.additional_tags
+  }
 }
diff --git a/main.tf b/main.tf
@@ -12,32 +12,32 @@ module "db" {
   source                           = "terraform-aws-modules/rds/aws"
   version                          = "~> 3.0"
   identifier                       = format("%s-%s", var.environment, var.name)
+  name                             = var.db_name
+  port                             = var.port
   engine                           = var.engine
-  engine_version                   = var.engine_version
+  username                         = var.master_username
+  multi_az                         = var.multi_az
+  subnet_ids                       = var.subnet_ids
+  kms_key_id                       = var.kms_key_arn
   instance_class                   = var.instance_class
+  engine_version                   = var.engine_version
   allocated_storage                = var.allocated_storage
   storage_encrypted                = var.storage_encrypted
-  kms_key_id                       = var.kms_key_arn
   publicly_accessible              = var.publicly_accessible
   replicate_source_db              = var.replicate_source_db
-  name                             = var.db_name
-  username                         = var.master_username
-  port                             = var.port
-  multi_az                         = var.multi_az
-  subnet_ids                       = var.subnet_ids
   vpc_security_group_ids           = split(",", module.security_group_rds.security_group_id)
   skip_final_snapshot              = var.skip_final_snapshot
-  final_snapshot_identifier_prefix = var.final_snapshot_identifier_prefix
   snapshot_identifier              = var.snapshot_identifier
   maintenance_window               = var.maintenance_window
   backup_window                    = var.backup_window
-  backup_retention_period          = var.backup_retention_period
   apply_immediately                = var.apply_immediately
+  backup_retention_period          = var.backup_retention_period
   random_password_length           = var.random_password_length
   create_random_password           = var.create_random_password
   monitoring_interval              = "30"
   monitoring_role_name             = format("%s-%s-RDSPostgresql", var.name, var.environment)
   create_monitoring_role           = true
+  final_snapshot_identifier_prefix = var.final_snapshot_identifier_prefix
   enabled_cloudwatch_logs_exports  = ["postgresql"]
   tags = merge(
     { "Name" = format("%s-%s", var.environment, var.name) },
@@ -60,8 +60,8 @@ resource "aws_security_group_rule" "default_ingress" {
   description = "From allowed SGs"
 
   type                     = "ingress"
-  from_port                = var.port
   to_port                  = var.port
+  from_port                = var.port
   protocol                 = "tcp"
   source_security_group_id = element(var.allowed_security_groups, count.index)
   security_group_id        = module.security_group_rds.security_group_id
@@ -73,8 +73,8 @@ resource "aws_security_group_rule" "cidr_ingress" {
   description = "From allowed CIDRs"
 
   type              = "ingress"
-  from_port         = var.port
   to_port           = var.port
+  from_port         = var.port
   protocol          = "tcp"
   cidr_blocks       = var.allowed_cidr_blocks
   security_group_id = module.security_group_rds.security_group_id
@@ -83,15 +83,15 @@ resource "aws_security_group_rule" "cidr_ingress" {
 module "security_group_rds" {
   source      = "terraform-aws-modules/security-group/aws"
   version     = "~> 4"
-  create      = var.create_security_group
   name        = format("%s-%s-%s", var.environment, var.name, "rds-sg")
-  description = "Complete PostgreSQL example security group"
+  create      = var.create_security_group
   vpc_id      = var.vpc_id
+  description = "Complete PostgreSQL example security group"
 
   egress_with_cidr_blocks = [
     {
-      from_port   = 0
       to_port     = 0
+      from_port   = 0
       protocol    = "-1"
       cidr_blocks = "0.0.0.0/0"
     },

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,6 @@`
`1`	`1`	`provider "aws" {`
`2`	`2`	`region = local.region`
	`3`	`+ default_tags {`
	`4`	`+ tags = local.additional_tags`
	`5`	`+ }`
`3`	`6`	`}`