2023 refactor 2

.gitignore

@@ -129,3 +129,7 @@ dmypy.json
 .pyre/
 serverless/exif-ripper/*.output
 append_these_perms_to_aws_credentials_file.secrets
+
+
+*/**/.pluralith
+*/**/.vscode

terraform_v1/01_sls_deployment_bucket/README.md

@@ -25,7 +25,7 @@ No resources.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_env"></a> [env](#input\_env) | Deployment environment. e.g. dev, uat, prod | `string` | `"dev"` | no |
-| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | n/a | yes |
+| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | `"defaultNotRandom"` | no |
 
 ## Outputs
 

terraform_v1/01_sls_deployment_bucket/variables.tf

@@ -7,4 +7,5 @@ variable "env" {
 variable "random_string" {
   description = "A random string to ensure that different people can create globally unique s3 resources"
   type        = string
+  default     = "defaultNotRandom"
 }

terraform_v1/02_DEV/README.md

@@ -27,7 +27,7 @@ No resources.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_env"></a> [env](#input\_env) | Deployment environment. e.g. dev, uat, prod | `string` | `"dev"` | no |
-| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | n/a | yes |
+| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | `"defaultNotRandom"` | no |
 | <a name="input_ssm_root_prefix"></a> [ssm\_root\_prefix](#input\_ssm\_root\_prefix) | SSM root prefix used to construct the key path | `string` | `"/stablecaps/exifripper"` | no |
 
 ## Outputs

terraform_v1/02_DEV/variables.tf

@@ -7,6 +7,7 @@ variable "env" {
 variable "random_string" {
   description = "A random string to ensure that different people can create globally unique s3 resources"
   type        = string
+  default     = "defaultNotRandom"
 }
 
 variable "ssm_root_prefix" {

terraform_v1/03_PROD/README.md

@@ -26,7 +26,7 @@ No resources.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_env"></a> [env](#input\_env) | Deployment environment. e.g. dev, uat, prod | `string` | `"prod"` | no |
-| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | n/a | yes |
+| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | `"defaultNotRandom"` | no |
 | <a name="input_ssm_root_prefix"></a> [ssm\_root\_prefix](#input\_ssm\_root\_prefix) | SSM root prefix used to construct the key path | `string` | `"/stablecaps/exifripper"` | no |
 
 ## Outputs

terraform_v1/03_PROD/variables.tf

@@ -7,6 +7,7 @@ variable "env" {
 variable "random_string" {
   description = "A random string to ensure that different people can create globally unique s3 resources"
   type        = string
+  default     = "defaultNotRandom"
 }
 
 variable "ssm_root_prefix" {

terraform_v1/modules/exif_ripper_buckets/README.md

@@ -30,7 +30,7 @@ No requirements.
 | <a name="input_bucket_dest"></a> [bucket\_dest](#input\_bucket\_dest) | Exif-ripper destination bucket that sanitised files are copied to | `string` | n/a | yes |
 | <a name="input_bucket_source"></a> [bucket\_source](#input\_bucket\_source) | Exif-ripper source bucket that is monitored for new files | `string` | n/a | yes |
 | <a name="input_env"></a> [env](#input\_env) | Deployment environment. e.g. dev, uat, prod | `string` | n/a | yes |
-| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | n/a | yes |
+| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | `"defaultNotRandom"` | no |
 | <a name="input_ssm_root_prefix"></a> [ssm\_root\_prefix](#input\_ssm\_root\_prefix) | SSM root prefix used to construct the key path | `string` | n/a | yes |
 | <a name="input_tags"></a> [tags](#input\_tags) | A map that is used to apply tags to resources created by terraform | `map(string)` | n/a | yes |
 

terraform_v1/modules/exif_ripper_buckets/variables.tf

@@ -6,6 +6,7 @@ variable "env" {
 variable "random_string" {
   description = "A random string to ensure that different people can create globally unique s3 resources"
   type        = string
+  default     = "defaultNotRandom"
 }
 
 

terraform_v2/00_setup_remote_s3_backend_dev/README.md

@@ -24,9 +24,9 @@ No resources.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_env"></a> [env](#input\_env) | n/a | `string` | `"dev"` | no |
-| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | n/a | `string` | n/a | yes |
-| <a name="input_terraform_backend_config_file_path"></a> [terraform\_backend\_config\_file\_path](#input\_terraform\_backend\_config\_file\_path) | n/a | `string` | `"."` | no |
+| <a name="input_env"></a> [env](#input\_env) | Deployment environment. e.g. dev, uat, prod | `string` | n/a | yes |
+| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | `"defaultNotRandom"` | no |
+| <a name="input_terraform_backend_config_file_path"></a> [terraform\_backend\_config\_file\_path](#input\_terraform\_backend\_config\_file\_path) | Path to Terraform backend config file | `string` | `"."` | no |
 
 ## Outputs
 

terraform_v2/00_setup_remote_s3_backend_dev/ini_create_s3_and_dyndb_backend.tf

@@ -3,21 +3,6 @@
 # be bootstrapped according to the simple yet essential procedure in
 # https://github.com/cloudposse/terraform-aws-tfstate-backend#usage
 
-variable "env" {
-  type    = string
-  default = "dev"
-}
-
-variable "random_string" {
-  type = string
-}
-
-variable "terraform_backend_config_file_path" {
-  type    = string
-  default = "."
-}
-
-
 module "terraform_state_backend" {
 
   source     = "cloudposse/tfstate-backend/aws"

terraform_v2/00_setup_remote_s3_backend_dev/variables.tf

@@ -0,0 +1,16 @@
+variable "env" {
+  description = "Deployment environment. e.g. dev, uat, prod"
+  type        = string
+}
+
+variable "random_string" {
+  description = "A random string to ensure that different people can create globally unique s3 resources"
+  type        = string
+  default     = "defaultNotRandom"
+}
+
+variable "terraform_backend_config_file_path" {
+  description = "Path to Terraform backend config file"
+  type        = string
+  default     = "."
+}

terraform_v2/00_setup_remote_s3_backend_prod/README.md

@@ -25,9 +25,9 @@ No resources.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_env"></a> [env](#input\_env) | n/a | `string` | `"prod"` | no |
-| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | n/a | `string` | n/a | yes |
-| <a name="input_terraform_backend_config_file_path"></a> [terraform\_backend\_config\_file\_path](#input\_terraform\_backend\_config\_file\_path) | n/a | `string` | `"."` | no |
+| <a name="input_env"></a> [env](#input\_env) | Deployment environment. e.g. dev, uat, prod | `string` | n/a | yes |
+| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | `"defaultNotRandom"` | no |
+| <a name="input_terraform_backend_config_file_path"></a> [terraform\_backend\_config\_file\_path](#input\_terraform\_backend\_config\_file\_path) | Path to Terraform backend config file | `string` | `"."` | no |
 
 ## Outputs
 

terraform_v2/00_setup_remote_s3_backend_prod/create_s3_and_dyndb_backend.tf

@@ -4,17 +4,20 @@
 # https://github.com/cloudposse/terraform-aws-tfstate-backend#usage
 
 variable "env" {
-  type    = string
-  default = "prod"
+  description = "Deployment environment. e.g. dev, uat, prod"
+  type        = string
 }
 
 variable "random_string" {
-  type = string
+  description = "A random string to ensure that different people can create globally unique s3 resources"
+  type        = string
+  default     = "defaultNotRandom"
 }
 
 variable "terraform_backend_config_file_path" {
-  type    = string
-  default = "."
+  description = "Path to Terraform backend config file"
+  type        = string
+  default     = "."
 }
 
 

terraform_v2/entrypoints/exifripper_buckets_and_iam_role/README.md

@@ -26,7 +26,7 @@ No resources.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_env"></a> [env](#input\_env) | Deployment environment. e.g. dev, uat, prod | `string` | n/a | yes |
-| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | n/a | yes |
+| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | `"defaultNotRandom"` | no |
 | <a name="input_ssm_root_prefix"></a> [ssm\_root\_prefix](#input\_ssm\_root\_prefix) | SSM root prefix used to construct the key path | `string` | n/a | yes |
 
 ## Outputs

terraform_v2/entrypoints/exifripper_buckets_and_iam_role/variables.tf

@@ -6,6 +6,7 @@ variable "env" {
 variable "random_string" {
   description = "A random string to ensure that different people can create globally unique s3 resources"
   type        = string
+  default     = "defaultNotRandom"
 }
 
 variable "ssm_root_prefix" {

terraform_v2/entrypoints/sls_deployment_bucket/README.md

@@ -25,7 +25,7 @@ No resources.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_env"></a> [env](#input\_env) | Deployment environment. e.g. dev, uat, prod | `string` | `"dev"` | no |
-| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | n/a | yes |
+| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | `"defaultNotRandom"` | no |
 
 ## Outputs
 

terraform_v2/entrypoints/sls_deployment_bucket/variables.tf

@@ -7,4 +7,5 @@ variable "env" {
 variable "random_string" {
   description = "A random string to ensure that different people can create globally unique s3 resources"
   type        = string
+  default     = "defaultNotRandom"
 }

terraform_v2/modules/exif_ripper_buckets/README.md

@@ -30,7 +30,7 @@ No requirements.
 | <a name="input_bucket_dest"></a> [bucket\_dest](#input\_bucket\_dest) | Exif-ripper destination bucket that sanitised files are copied to | `string` | n/a | yes |
 | <a name="input_bucket_source"></a> [bucket\_source](#input\_bucket\_source) | Exif-ripper source bucket that is monitored for new files | `string` | n/a | yes |
 | <a name="input_env"></a> [env](#input\_env) | Deployment environment. e.g. dev, uat, prod | `string` | n/a | yes |
-| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | n/a | yes |
+| <a name="input_random_string"></a> [random\_string](#input\_random\_string) | A random string to ensure that different people can create globally unique s3 resources | `string` | `"defaultNotRandom"` | no |
 | <a name="input_ssm_root_prefix"></a> [ssm\_root\_prefix](#input\_ssm\_root\_prefix) | SSM root prefix used to construct the key path | `string` | n/a | yes |
 | <a name="input_tags"></a> [tags](#input\_tags) | A map that is used to apply tags to resources created by terraform | `map(string)` | n/a | yes |
 

terraform_v2/modules/exif_ripper_buckets/variables.tf

@@ -6,6 +6,7 @@ variable "env" {
 variable "random_string" {
   description = "A random string to ensure that different people can create globally unique s3 resources"
   type        = string
+  default     = "defaultNotRandom"
 }
 
 

xxx_terraform-docs.sh → xxx_terraform_docs.sh

@@ -11,7 +11,7 @@ fi
 
 if [ "$#" -ne 1 ]; then
     echo "USAGE: ./xxx_terraform-docs.sh \${YOUR_TERRAFORM_EXEC}"
-    echo "e.g > ./xxx_terraform-docs.sh terraform_v1.0.6"
+    echo "e.g > ./xxx_terraform-docs.sh terraform_v1.5.1"
     exit 0
 fi
 
@@ -24,7 +24,29 @@ unique_tf_dirs=$(find ./ -not -path "*/\.*" -not -path "*venv/*" -not -path "*no
 
 for tf_dirs in $unique_tf_dirs; do
     cd $tf_dirs
+        echo ""
+        pwd
         # TODO: customise this further to enrich READMEs and create links to them from root directory
         terraform-docs markdown table --output-file README.md --output-mode inject .
+
+        IMAGE_FILE="./images/terraform_infra.png"
+        if [ -f "$IMAGE_FILE" ]; then
+            echo "Adding infra image"
+            ### rm previous additions
+
+            sed -i "s|images/terraform_infra.png||g" README.md
+            mv -f README.md README.temp
+
+
+            MDIMG_LINK="![terraform_infra](${IMAGE_FILE})"
+            echo "$MDIMG_LINK" > README.md
+            echo "" >> README.md
+            echo "" >> README.md
+            cat README.temp >> README.md
+            rm README.temp
+
+        else
+            echo "nofindo"
+        fi
     cd -
 done