Postgres to Aurora rename (#31)

* Initial commit

* Fixing out_dotenv

* Fixing var

* Cosmetics

Author: LeoDiazL

README.md

@@ -56,7 +56,7 @@ jobs:
 1. [Certificates](#certificate-inputs)
 1. [Load Balancer](#load-balancer-inputs)
 1. [EFS](#efs-inputs)
-1. [RDS](#rds-inputs)
+1. [Amazon Aurora Inputs](#aurora-inputs)
 1. [Docker](#docker-inputs)
 
 The following inputs can be used as `step.with` keys
@@ -192,24 +192,24 @@ The following inputs can be used as `step.with` keys
 <hr/>
 <br/>
 
-#### **RDS Inputs**
+#### **Aurora Inputs**
 | Name             | Type    | Description                        |
 |------------------|---------|------------------------------------|
-| `aws_postgres_enable` | Boolean | Set to `true` to enable a postgres database. |
-| `aws_postgres_engine` | String |  Which Database engine to use. Default is `aurora-postgresql`.|
-| `aws_postgres_engine_version` | String |  Specify Postgres version.  More information [here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html). Default is `11.17`. |
-| `aws_postgres_database_group_family` | String | Specify aws database group family. Default is `aurora-postgresql11`. See [this](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-parameter-group.html).|
-| `aws_postgres_instance_class` | String | Define the size of the instances in the DB cluster. Default is `db.t3.medium`. | 
-| `aws_postgres_security_group_name` | String | The name of the Postgres security group. Defaults to `SG for ${aws_resource_identifier} - PG`. |
-| `aws_postgres_subnets` | String | Specify which subnets to use as a list of strings.  Example: `i-1234,i-5678,i-9101`. |
-| `aws_postgres_cluster_name` | String | Specify a cluster name. Will be created if it does not exist. Defaults to `aws_resource_identifier`. |
-| `aws_postgres_database_name` | String | Specify a database name. Will be created if it does not exist. Defaults to `aws_resource_identifier`. |
-| `aws_postgres_database_port` | String | Specify a listening port for the database. Default is `5432`.|
-| `aws_postgres_restore_snapshot` | String | Restore a snapshot to the DB. Should be set only once. Changes in this value will destroy and recreate the database completely. | 
-| `aws_postgres_snapshot_name` | String | Specify a database name. Will be created if it does not exist. Won't overwrite. |
-| `aws_postgres_snapshot_overwrite` | Boolean | Set to true to overwrite the snapshot. |
-| `aws_postgres_database_protection` | Boolean | Protects the database from deletion. Default is `false`.|
-| `aws_postgres_database_final_snapshot` | Boolean | Creates a snapshot before deletion. If a string is passed, it will be used as snapsthot name. Defaults to `false`.|
+| `aws_aurora_enable` | Boolean | Set to `true` to enable an [Aurora database](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html). (Postgres or MySQL). |
+| `aws_aurora_engine` | String |  Which Database engine to use. Default is `aurora-postgresql`.|
+| `aws_aurora_engine_version` | String |  Specify database version.  More information [Postgres](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) or [MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraMySQLReleaseNotes/Welcome.html). Default is `11.17`. (Postgres) |
+| `aws_aurora_database_group_family` | String | Specify aws database group family. Default is `aurora-postgresql11`. See [this](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-parameter-group.html).|
+| `aws_aurora_instance_class` | String | Define the size of the instances in the DB cluster. Default is `db.t3.medium`. | 
+| `aws_aurora_security_group_name` | String | The name of the database security group. Defaults to `SG for ${aws_resource_identifier} - Aurora`. |
+| `aws_aurora_subnets` | String | Specify which subnets to use as a list of strings.  Example: `i-1234,i-5678,i-9101`. |
+| `aws_aurora_cluster_name` | String | Specify a cluster name. Will be created if it does not exist. Defaults to `aws_resource_identifier`. |
+| `aws_aurora_database_name` | String | Specify a database name. Will be created if it does not exist. Defaults to `aws_resource_identifier`. |
+| `aws_aurora_database_port` | String | Specify a listening port for the database. Default is `5432`.|
+| `aws_aurora_restore_snapshot` | String | Restore a snapshot to the DB. Should be set only once. Changes in this value will destroy and recreate the database completely. | 
+| `aws_aurora_snapshot_name` | String | Specify a database name. Will be created if it does not exist. Won't overwrite. |
+| `aws_aurora_snapshot_overwrite` | Boolean | Set to true to overwrite the snapshot. |
+| `aws_aurora_database_protection` | Boolean | Protects the database from deletion. Default is `false`.|
+| `aws_aurora_database_final_snapshot` | Boolean | Creates a snapshot before deletion. If a string is passed, it will be used as snapsthot name. Defaults to `false`.|
 <hr/>
 <br/>
 
@@ -284,9 +284,11 @@ An example EFS Zone mapping;
 }
 ```
 
-## Adding external Postgres database (AWS RDS)
+## Adding external Aurora database (AWS RDS)
 
-If `aws_postgres_enable` is set to `true`, this action will deploy an RDS cluster for Postgres.
+If `aws_aurora_enable` is set to `true`, this action will deploy a RDS Aurora cluster using Postgres as a default. 
+
+See [this Terraform provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/rds_cluster) and [this other AWS doc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-parameter-group.html) to set up most of the variables.
 
 ### Environment variables
 The following environment variables are added to the `.env` file in your app's `docker-compose.yaml` file.
@@ -304,17 +306,18 @@ services:
 The available environment variables are:
 | Variable | Description |
 |----------|-------------|
-| `POSTGRES_CLUSTER_ENDPOINT` (and `PGHOST`) | Writer endpoint for the cluster |
-| `POSTGRES_CLUSTER_PORT` (and `PGPORT`) | The database port |
-| `POSTGRES_CLUSTER_MASTER_PASSWORD` (and `PG_PASSWORD`) | database root password |
-| `POSTGRES_CLUSTER_MASTER_USERNAME` (and `PG_USER`) | The database master username |
-| `POSTGRES_CLUSTER_DATABASE_NAME` (and `PGDATABASE`) | Name for an automatically created database on cluster creation |
-| `POSTGRES_CLUSTER_ARN` | Amazon Resource Name (ARN) of cluster |
-| `POSTGRES_CLUSTER_ID` | The RDS Cluster Identifier |
-| `POSTGRES_CLUSTER_RESOURCE_ID` | The RDS Cluster Resource ID |
-| `POSTGRES_CLUSTER_READER_ENDPOINT` | A read-only endpoint for the cluster, automatically load-balanced across replicas |
-| `POSTGRES_CLUSTER_ENGINE_VERSION_ACTUAL` | The running version of the cluster database |
-| `POSTGRES_CLUSTER_HOSTED_ZONE_ID`| The Route53 Hosted Zone ID of the endpoint |
+| `AURORA_CLUSTER_ENGINE` (and `DBA_ENGINE`) | Engine name - ( mysql/postgres ) |
+| `AURORA_CLUSTER_ENDPOINT` (and `DBA_HOST`) | Writer endpoint for the cluster |
+| `AURORA_CLUSTER_PORT` (and `DBA_PORT`) | The database port |
+| `AURORA_CLUSTER_MASTER_PASSWORD` (and `DBA_PASSWORD`) | database root password |
+| `AURORA_CLUSTER_MASTER_USERNAME` (and `DBA_USER`) | The database master username |
+| `AURORA_CLUSTER_DATABASE_NAME` (and `DBA_NAME`) | Name for an automatically created database on cluster creation |
+| `AURORA_CLUSTER_ARN` | Amazon Resource Name (ARN) of cluster |
+| `AURORA_CLUSTER_ID` | The RDS Cluster Identifier |
+| `AURORA_CLUSTER_RESOURCE_ID` | The RDS Cluster Resource ID |
+| `AURORA_CLUSTER_READER_ENDPOINT` | A read-only endpoint for the cluster, automatically load-balanced across replicas |
+| `AURORA_CLUSTER_ENGINE_VERSION_ACTUAL` | The running version of the cluster database |
+| `AURORA_CLUSTER_HOSTED_ZONE_ID`| The Route53 Hosted Zone ID of the endpoint |
 
 ### AWS Root Certs
 The AWS root certificate is downloaded and accessible via the `rds-combined-ca-bundle.pem` file in root of your app repo/directory.
@@ -327,11 +330,11 @@ const { Client } = require('pg')
 
 // set up client
 const client = new Client({
-  host: process.env.PGHOST,
-  port: process.env.PGPORT,
-  user: process.env.PG_USER,
-  password: process.env.PG_PASSWORD,
-  database: process.env.PGDATABASE,
+  host: process.env.DBA_HOST,
+  port: process.env.DBA_PORT,
+  user: process.env.DBA_USER,
+  password: process.env.DBA_PASSWORD,
+  database: process.env.DBA_NAME,
   ssl: {
     ca: fs.readFileSync('rds-combined-ca-bundle.pem').toString()
   }
@@ -345,12 +348,12 @@ await client.end();
 console.log(`Hello SQL timestamp: ${result.rows[0].now}`);
 ```
 
-### Postgres Infrastructure and Cluster Details
+### Aurora Infrastructure and Cluster Details
 Specifically, the following resources will be created:
 - AWS Security Group
   - AWS Security Group Rule - Allows access to the cluster's db port: `5432`
-- AWS RDS Aurora Postgres
-  - Includes a single database (set by the input: `aws_postgres_database_name`. defaults to `root`)
+- AWS RDS Aurora
+  - Includes a single database (set by the input: `aws_aurora_database_name`. defaults to `root`)
 
 Additional details about the cluster that's created:
 - Automated backups (7 Days)
@@ -359,7 +362,7 @@ Additional details about the cluster that's created:
 - Monitoring enabled
 - Sends logs to AWS Cloudwatch
 
-> _**For more details**, see [operations/deployment/terraform/postgres.tf](operations/deployment/terraform/postgres.tf)_
+> _**For more details**, see [link-to-be-updated](operations/deployment/terraform/postgres.tf)_
 
 ## Made with BitOps
 [BitOps](https://bitops.sh) allows you to define Infrastructure-as-Code for multiple tools in a central place.  This action uses a BitOps [Operations Repository](https://bitops.sh/operations-repo-structure/) to set up the necessary Terraform and Ansible to create infrastructure and deploy to it.

action.yaml

@@ -253,49 +253,49 @@ inputs:
     required: false
 
   # AWS RDS
-  aws_postgres_enable:
+  aws_aurora_enable:
     description: 'Set to "true" to enable a postgres database'
     required: false
-  aws_postgres_engine: 
+  aws_aurora_engine: 
     description: 'Which Database engine to use'
     required: false
-  aws_postgres_engine_version:
+  aws_aurora_engine_version:
     description: 'Specify Postgres version'
     required: false
-  aws_postgres_database_group_family:
+  aws_aurora_database_group_family:
     description: 'Postgres database group family'
     required: false 
-  aws_postgres_instance_class:
+  aws_aurora_instance_class:
     description: 'Define the size of the instances in the DB cluster'
     required: false
-  aws_postgres_security_group_name:
+  aws_aurora_security_group_name:
     description:  'The name of the Postgres security group'
     required: false
-  aws_postgres_subnets:
+  aws_aurora_subnets:
     description: 'Specify which subnets to use as a list of strings.  Example: `i-1234,i-5678,i-9101`'
     required: false
-  aws_postgres_cluster_name:
+  aws_aurora_cluster_name:
     description: 'Specify a cluster name. Will be created if it does not exist'
     required: false
-  aws_postgres_database_name:
+  aws_aurora_database_name:
     description: 'Specify a database name. Will be created if it does not exist'
     required: false
-  aws_postgres_database_port:
+  aws_aurora_database_port:
     description: 'Postgres database port'
     required: false
-  aws_postgres_restore_snapshot:
+  aws_aurora_restore_snapshot:
     description: 'Restore a snapshot to the DB. Should be used only once. Changes in this value will destroy and recreate the database completely.'
     required: false
-  aws_postgres_snapshot_name:
+  aws_aurora_snapshot_name:
     description: 'Takes a snapshot of the cluster using that name. If none definded, no snapshot will be made. If snap already exists, no new one will be created.'
     required: false
-  aws_postgres_snapshot_overwrite:
+  aws_aurora_snapshot_overwrite:
     description: 'If the snapshot name is the same as an existing one, will destroy and create a new one.'
     required: false
-  aws_postgres_database_protection:
+  aws_aurora_database_protection:
     description: 'Protects the database from deletion.'
     required: false
-  aws_postgres_database_final_snapshot:
+  aws_aurora_database_final_snapshot:
     description: 'Generates a snapshot of the database before deletion.'
     required: false
 
@@ -500,21 +500,21 @@ runs:
         AWS_EFS_EC2_MOUNT_POINT: ${{ inputs.aws_efs_ec2_mount_point }}
 
         # AWS RDS
-        AWS_POSTGRES_ENABLE: ${{ inputs.aws_postgres_enable }}
-        AWS_POSTGRES_ENGINE:  ${{ inputs.aws_postgres_engine }}
-        AWS_POSTGRES_ENGINE_VERSION:  ${{ inputs.aws_postgres_engine_version }}
-        AWS_POSTGRES_DATABASE_GROUP_FAMILY:  ${{ inputs.aws_postgres_database_group_family }}
-        AWS_POSTGRES_INSTANCE_CLASS: ${{ inputs.aws_postgres_instance_class }}
-        AWS_POSTGRES_SECURITY_GROUP_NAME: ${{ inputs.aws_postgres_security_group_name }}
-        AWS_POSTGRES_SUBNETS: ${{ inputs.aws_postgres_subnets }}
-        AWS_POSTGRES_CLUSTER_NAME: ${{ inputs.aws_postgres_cluster_name }}
-        AWS_POSTGRES_DATABASE_NAME: ${{ inputs.aws_postgres_database_name }}
-        AWS_POSTGRES_DATABASE_PORT: ${{ inputs.aws_postgres_database_port}}
-        AWS_POSTGRES_RESTORE_SNAPSHOT: ${{ inputs.aws_postgres_restore_snapshot }}
-        AWS_POSTGRES_SNAPSHOT_NAME: ${{ inputs.aws_postgres_snapshot_name }}
-        AWS_POSTGRES_SNAPSHOT_OVERWRITE: ${{ inputs.aws_postgres_snapshot_overwrite }}
-        AWS_POSTGRES_DATABASE_PROTECTION: ${{ inputs.aws_postgres_database_protection }}
-        AWS_POSTGRES_DATABASE_FINAL_SNAPSHOT: ${{ inputs.aws_postgres_database_final_snapshot }}
+        AWS_AURORA_ENABLE: ${{ inputs.aws_aurora_enable }}
+        AWS_AURORA_ENGINE:  ${{ inputs.aws_aurora_engine }}
+        AWS_AURORA_ENGINE_VERSION:  ${{ inputs.aws_aurora_engine_version }}
+        AWS_AURORA_DATABASE_GROUP_FAMILY:  ${{ inputs.aws_aurora_database_group_family }}
+        AWS_AURORA_INSTANCE_CLASS: ${{ inputs.aws_aurora_instance_class }}
+        AWS_AURORA_SECURITY_GROUP_NAME: ${{ inputs.aws_aurora_security_group_name }}
+        AWS_AURORA_SUBNETS: ${{ inputs.aws_aurora_subnets }}
+        AWS_AURORA_CLUSTER_NAME: ${{ inputs.aws_aurora_cluster_name }}
+        AWS_AURORA_DATABASE_NAME: ${{ inputs.aws_aurora_database_name }}
+        AWS_AURORA_DATABASE_PORT: ${{ inputs.aws_aurora_database_port}}
+        AWS_AURORA_RESTORE_SNAPSHOT: ${{ inputs.aws_aurora_restore_snapshot }}
+        AWS_AURORA_SNAPSHOT_NAME: ${{ inputs.aws_aurora_snapshot_name }}
+        AWS_AURORA_SNAPSHOT_OVERWRITE: ${{ inputs.aws_aurora_snapshot_overwrite }}
+        AWS_AURORA_DATABASE_PROTECTION: ${{ inputs.aws_aurora_database_protection }}
+        AWS_AURORA_DATABASE_FINAL_SNAPSHOT: ${{ inputs.aws_aurora_database_final_snapshot }}
 
         # Docker
         DOCKER_INSTALL: ${{ inputs.docker_install }}

operations/_scripts/deploy/deploy.sh

@@ -76,7 +76,7 @@ cat $GITHUB_ACTION_PATH/operations/deployment/bitops.config.yaml
 
 ## Ensuring bucket get's destroyed only if everything is set to be destroyed
 if [[ $(alpha_only "$TF_STATE_BUCKET_DESTROY") == true ]] && ! [[ $(alpha_only "$TF_STACK_DESTROY") == true ]] ; then
-  if [[ $(alpha_only "$AWS_POSTGRES_ENABLE") == true ]] || 
+  if [[ $(alpha_only "$AWS_AURORA_ENABLE") == true ]] || 
      [[ $(alpha_only "$AWS_EFS_ENABLE") == true ]] || 
      [[ $(alpha_only "$AWS_EC2_INSTANCE_CREATE") == true ]] ||
      [[ $(alpha_only "$AWS_EKS_CREATE") == true ]]; then 

operations/_scripts/generate/generate_bitops_config.sh

@@ -120,7 +120,7 @@ bitops:
       create_bitops_terraform_config aws false targets
     fi
   else
-    if [[ $(alpha_only "$AWS_EC2_INSTANCE_CREATE") == true ]] || [[ $(alpha_only "$AWS_EFS_CREATE") == true ]] || [[ "$AWS_POSTGRES_ENABLE" != "" ]]; then
+    if [[ $(alpha_only "$AWS_EC2_INSTANCE_CREATE") == true ]] || [[ $(alpha_only "$AWS_EFS_CREATE") == true ]] || [[ "$AWS_AURORA_ENABLE" != "" ]]; then
       add_terraform_module aws
       create_bitops_terraform_config aws true targets
     fi