Merge pull request #4 from RohitSquareops/main

Updated variable, readme and indentation

Author: sunil-kumar-squareops

README.md

@@ -6,28 +6,46 @@
 
 ### [SquareOps Technologies](https://squareops.com/) Your DevOps Partner for Accelerating cloud journey.
 <br>
+This module is for deploying a highly available MongoDB cluster on Kubernetes using Helm charts. This module provides flexible configuration options to customize the MongoDB deployment such as setting the volume size, architecture, replica count, and more. It also includes options to enable MongoDB backups and restores, and to deploy MongoDB exporters for getting metrics in Grafana. Additionally, this module provides options to create a new namespace, and to configure recovery windows for AWS Secrets Manager. With this module, users can easily deploy a highly available MongoDB cluster on Kubernetes with the flexibility to customize their configurations according to their needs.
+
+## Supported Versions:
+
+|  MongoDB Helm Chart Version    |     K8s supported version   |  
+| :-----:                       |         :---                |
+| **13.1.5**                     |    **1.23,1.24,1.25**           |
+
 
 ## Usage Example
 
 ```hcl
 module "mongodb" {
-  source                   = "../../"
+  source                   = "https://github.com/sq-ia/terraform-kubernetes-mongodb.git"
   cluster_name             = "dev-skaf"
   mongodb_config = {
   name               = "skaf"
-  values_yaml        = file("./helm/values.yaml")
+  values_yaml        = ""
   environment        = "prod"
   volume_size        = "10Gi"
   architecture       = "replicaset"
   replica_count      = 2
   storage_class_name = "gp2"  
   }
+  mongodb_backup_enabled   = true
   mongodb_backup_config = {
-    s3_bucket_uri         = "s3://bucket-name"
-    s3_bucket_region      = "us-east-2"
-    cron_for_full_backup  = "*/2 * * * *"
+    s3_bucket_uri         = ""
+    s3_bucket_region      = ""
+    cron_for_full_backup  = "* * * * *"
+  }
+
+  mongodb_restore_enabled = true
+  mongodb_restore_config = {
+    s3_bucket_uri              = ""
+    s3_bucket_region           = ""
+    full_restore_enable        = true
+    file_name_full             = ""
+    incremental_restore_enable = false
+    file_name_incremental      = ""
   }
-  mongodb_backup_enabled   = true
   mongodb_exporter_enabled = true  
 }
 
@@ -87,19 +105,19 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_app_version"></a> [app\_version](#input\_app\_version) | Enter app version of application | `string` | `"5.0.8-debian-10-r9"` | no |
-| <a name="input_chart_version"></a> [chart\_version](#input\_chart\_version) | Enter chart version of application | `string` | `"13.1.5"` | no |
-| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name of the EKS cluster | `string` | `""` | no |
-| <a name="input_create_namespace"></a> [create\_namespace](#input\_create\_namespace) | Set it to true to create given namespace | `string` | `true` | no |
-| <a name="input_mongodb_backup_config"></a> [mongodb\_backup\_config](#input\_mongodb\_backup\_config) | Mongodb Backup configurations | `any` | <pre>{<br>  "cron_for_full_backup": "*/5 * * * *",<br>  "s3_bucket_region": "us-east-2",<br>  "s3_bucket_uri": ""<br>}</pre> | no |
-| <a name="input_mongodb_backup_enabled"></a> [mongodb\_backup\_enabled](#input\_mongodb\_backup\_enabled) | Set true to enable mongodb backups | `bool` | `false` | no |
-| <a name="input_mongodb_config"></a> [mongodb\_config](#input\_mongodb\_config) | Mongodb configurations | `any` | <pre>{<br>  "architecture": "",<br>  "environment": "",<br>  "name": "",<br>  "replica_count": 2,<br>  "storage_class_name": "",<br>  "values_yaml": "",<br>  "volume_size": ""<br>}</pre> | no |
-| <a name="input_mongodb_exporter_config"></a> [mongodb\_exporter\_config](#input\_mongodb\_exporter\_config) | Mongodb exporter configuration | `any` | <pre>{<br>  "version": "2.9.0"<br>}</pre> | no |
-| <a name="input_mongodb_exporter_enabled"></a> [mongodb\_exporter\_enabled](#input\_mongodb\_exporter\_enabled) | Set true to deploy mongodb exporters to get metrics in grafana | `bool` | `false` | no |
-| <a name="input_mongodb_restore_config"></a> [mongodb\_restore\_config](#input\_mongodb\_restore\_config) | Mongodb restore configurations | `any` | <pre>{<br>  "file_name_full": "",<br>  "file_name_incremental": "",<br>  "full_restore_enable": false,<br>  "incremental_restore_enable": false,<br>  "s3_bucket_region": "us-east-2",<br>  "s3_bucket_uri": "s3://mymongo/mongodumpfull_20230424_112501.gz"<br>}</pre> | no |
-| <a name="input_mongodb_restore_enabled"></a> [mongodb\_restore\_enabled](#input\_mongodb\_restore\_enabled) | Set true to enable mongodb restore | `bool` | `false` | no |
-| <a name="input_namespace"></a> [namespace](#input\_namespace) | Enter namespace name | `string` | `"mongodb"` | no |
-| <a name="input_recovery_window_aws_secret"></a> [recovery\_window\_aws\_secret](#input\_recovery\_window\_aws\_secret) | Number of days that AWS Secrets Manager waits before it can delete the secret. This value can be 0 to force deletion without recovery or range from 7 to 30 days. | `number` | `0` | no |
+| <a name="input_app_version"></a> [app\_version](#input\_app\_version) | Version of the Mongodb application that will be deployed. | `string` | `"5.0.8-debian-10-r9"` | no |
+| <a name="input_chart_version"></a> [chart\_version](#input\_chart\_version) | Version of the Mongodb chart that will be used to deploy Mongodb application. | `string` | `"13.1.5"` | no |
+| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Specifies the name of the EKS cluster to deploy the Mongodb application on. | `string` | `""` | no |
+| <a name="input_create_namespace"></a> [create\_namespace](#input\_create\_namespace) | Specify whether or not to create the namespace if it does not already exist. Set it to true to create the namespace. | `string` | `true` | no |
+| <a name="input_mongodb_backup_config"></a> [mongodb\_backup\_config](#input\_mongodb\_backup\_config) | Configuration options for Mongodb database backups. It includes properties such as the S3 bucket URI, the S3 bucket region, and the cron expression for full backups. | `any` | <pre>{<br>  "cron_for_full_backup": "*/5 * * * *",<br>  "s3_bucket_region": "us-east-2",<br>  "s3_bucket_uri": ""<br>}</pre> | no |
+| <a name="input_mongodb_backup_enabled"></a> [mongodb\_backup\_enabled](#input\_mongodb\_backup\_enabled) | Specifies whether to enable backups for Mongodb database. | `bool` | `false` | no |
+| <a name="input_mongodb_config"></a> [mongodb\_config](#input\_mongodb\_config) | Specify the configuration settings for Mongodb, including the name, environment, storage options, replication settings, and custom YAML values. | `any` | <pre>{<br>  "architecture": "",<br>  "environment": "",<br>  "name": "",<br>  "replica_count": 2,<br>  "storage_class_name": "",<br>  "values_yaml": "",<br>  "volume_size": ""<br>}</pre> | no |
+| <a name="input_mongodb_exporter_config"></a> [mongodb\_exporter\_config](#input\_mongodb\_exporter\_config) | Specify whether or not to deploy Mongodb exporter to collect Mongodb metrics for monitoring in Grafana. | `any` | <pre>{<br>  "version": "2.9.0"<br>}</pre> | no |
+| <a name="input_mongodb_exporter_enabled"></a> [mongodb\_exporter\_enabled](#input\_mongodb\_exporter\_enabled) | Specify whether or not to deploy Mongodb exporter to collect Mongodb metrics for monitoring in Grafana. | `bool` | `false` | no |
+| <a name="input_mongodb_restore_config"></a> [mongodb\_restore\_config](#input\_mongodb\_restore\_config) | Configuration options for restoring dump to the Mongodb database. | `any` | <pre>{<br>  "file_name_full": "",<br>  "file_name_incremental": "",<br>  "full_restore_enable": false,<br>  "incremental_restore_enable": false,<br>  "s3_bucket_region": "us-east-2",<br>  "s3_bucket_uri": "s3://mymongo/mongodumpfull_20230424_112501.gz"<br>}</pre> | no |
+| <a name="input_mongodb_restore_enabled"></a> [mongodb\_restore\_enabled](#input\_mongodb\_restore\_enabled) | Specifies whether to enable restoring dump to the Mongodb database. | `bool` | `false` | no |
+| <a name="input_namespace"></a> [namespace](#input\_namespace) | Name of the Kubernetes namespace where the Mongodb deployment will be deployed. | `string` | `"mongodb"` | no |
+| <a name="input_recovery_window_aws_secret"></a> [recovery\_window\_aws\_secret](#input\_recovery\_window\_aws\_secret) | Number of days that AWS Secrets Manager will wait before deleting a secret. This value can be set to 0 to force immediate deletion, or to a value between 7 and 30 days to allow for recovery. | `number` | `0` | no |
 
 ## Outputs
 

example/complete/README.md

@@ -21,7 +21,7 @@ No requirements.
 
 | Name | Source | Version |
 |------|--------|---------|
-| <a name="module_mongodb"></a> [mongodb](#module\_mongodb) | ../../ | n/a |
+| <a name="module_mongodb"></a> [mongodb](#module\_mongodb) | https://github.com/sq-ia/terraform-kubernetes-mongodb.git | n/a |
 
 ## Resources
 
@@ -39,5 +39,4 @@ No inputs.
 | Name | Description |
 |------|-------------|
 | <a name="output_mongodb_configuration"></a> [mongodb\_configuration](#output\_mongodb\_configuration) | Mongodb\_Info |
-| <a name="output_mongodb_endpoint"></a> [mongodb\_endpoint](#output\_mongodb\_endpoint) | n/a |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

example/complete/main.tf

@@ -1,13 +1,17 @@
 locals {
+  name        = "mongo"
   region      = "us-east-2"
-  name        = "dev"
-  environment = "skaf"
-
+  environment = "prod"
+  additional_tags = {
+    Owner      = "organization_name"
+    Expires    = "Never"
+    Department = "Engineering"
+  }
 }
 
 module "mongodb" {
-  source       = "../../"
-  cluster_name = "dev-skaf"
+  source       = "https://github.com/sq-ia/terraform-kubernetes-mongodb.git"
+  cluster_name = "dev-cluster"
   mongodb_config = {
     name               = local.name
     values_yaml        = file("./helm/values.yaml")
@@ -17,14 +21,12 @@ module "mongodb" {
     replica_count      = 2
     storage_class_name = "gp2"
   }
+  mongodb_backup_enabled = true
   mongodb_backup_config = {
     s3_bucket_uri        = "s3://mymongo"
     s3_bucket_region     = local.region
     cron_for_full_backup = "*/2 * * * *"
   }
-  mongodb_backup_enabled   = true
-  mongodb_exporter_enabled = false
-
   mongodb_restore_enabled = true
   mongodb_restore_config = {
     s3_bucket_uri              = "s3://mymongo/mongodumpfull_20230424_112501.gz"
@@ -34,5 +36,5 @@ module "mongodb" {
     incremental_restore_enable = false
     file_name_incremental      = ""
   }
-
+  mongodb_exporter_enabled = true
 }

example/complete/output.tf

@@ -2,7 +2,3 @@ output "mongodb_configuration" {
   value       = module.mongodb.mongodb
   description = "Mongodb_Info"
 }
-
-output "mongodb_endpoint" {
-  value = module.mongodb.mongodb_endpoint
-}

example/complete/provider.tf

@@ -1,17 +1,18 @@
 provider "aws" {
   region = local.region
+  default_tags {
+    tags = local.additional_tags
+  }
 }
 
-
 data "aws_eks_cluster" "cluster" {
-  name = "test-squareops"
+  name = ""
 }
 
 data "aws_eks_cluster_auth" "cluster" {
-  name = "test-squareops"
+  name = ""
 }
 
-
 provider "kubernetes" {
   host                   = data.aws_eks_cluster.cluster.endpoint
   cluster_ca_certificate = base64decode(data.aws_eks_cluster.cluster.certificate_authority.0.data)

main.tf

@@ -162,11 +162,11 @@ resource "helm_release" "mongodb_restore" {
       s3_role_arn                = aws_iam_role.mongo_restore_role.arn,
       s3_bucket_uri              = var.mongodb_restore_config.s3_bucket_uri,
       s3_bucket_region           = var.mongodb_restore_config.s3_bucket_region,
-      mongodb_root_user_password = random_password.mongodb_root_password.result,
-      full_restore_enable        = var.mongodb_restore_config.full_restore_enable,
       file_name_full             = var.mongodb_restore_config.file_name_full,
+      full_restore_enable        = var.mongodb_restore_config.full_restore_enable,
+      file_name_incremental      = var.mongodb_restore_config.file_name_incremental,
       incremental_restore_enable = var.mongodb_restore_config.incremental_restore_enable,
-      file_name_incremental      = var.mongodb_restore_config.file_name_incremental
+      mongodb_root_user_password = random_password.mongodb_root_password.result
     })
   ]
 }

variables.tf

@@ -9,31 +9,31 @@ variable "mongodb_config" {
     values_yaml        = ""
     storage_class_name = ""
   }
-  description = "Mongodb configurations"
+  description = "Specify the configuration settings for Mongodb, including the name, environment, storage options, replication settings, and custom YAML values."
 }
 
 variable "chart_version" {
   type        = string
   default     = "13.1.5"
-  description = "Enter chart version of application"
+  description = "Version of the Mongodb chart that will be used to deploy Mongodb application."
 }
 
 variable "app_version" {
   type        = string
   default     = "5.0.8-debian-10-r9"
-  description = "Enter app version of application"
+  description = "Version of the Mongodb application that will be deployed."
 }
 
 variable "namespace" {
   type        = string
   default     = "mongodb"
-  description = "Enter namespace name"
+  description = "Name of the Kubernetes namespace where the Mongodb deployment will be deployed."
 }
 
 variable "mongodb_backup_enabled" {
   type        = bool
   default     = false
-  description = "Set true to enable mongodb backups"
+  description = "Specifies whether to enable backups for Mongodb database."
 }
 
 variable "mongodb_backup_config" {
@@ -43,45 +43,45 @@ variable "mongodb_backup_config" {
     s3_bucket_region     = "us-east-2"
     cron_for_full_backup = "*/5 * * * *"
   }
-  description = "Mongodb Backup configurations"
+  description = "Configuration options for Mongodb database backups. It includes properties such as the S3 bucket URI, the S3 bucket region, and the cron expression for full backups."
 }
 
 variable "mongodb_exporter_enabled" {
   type        = bool
   default     = false
-  description = "Set true to deploy mongodb exporters to get metrics in grafana"
+  description = "Specify whether or not to deploy Mongodb exporter to collect Mongodb metrics for monitoring in Grafana."
 }
 
 variable "mongodb_exporter_config" {
   type = any
   default = {
     version = "2.9.0"
   }
-  description = "Mongodb exporter configuration"
+  description = "Specify whether or not to deploy Mongodb exporter to collect Mongodb metrics for monitoring in Grafana."
 }
 
 variable "recovery_window_aws_secret" {
-  default     = 0
   type        = number
-  description = "Number of days that AWS Secrets Manager waits before it can delete the secret. This value can be 0 to force deletion without recovery or range from 7 to 30 days."
+  default     = 0
+  description = "Number of days that AWS Secrets Manager will wait before deleting a secret. This value can be set to 0 to force immediate deletion, or to a value between 7 and 30 days to allow for recovery."
 }
 
 variable "cluster_name" {
   type        = string
-  description = "Name of the EKS cluster"
   default     = ""
+  description = "Specifies the name of the EKS cluster to deploy the Mongodb application on."
 }
 
 variable "create_namespace" {
   type        = string
-  description = "Set it to true to create given namespace"
   default     = true
+  description = "Specify whether or not to create the namespace if it does not already exist. Set it to true to create the namespace."
 }
 
 variable "mongodb_restore_enabled" {
   type        = bool
   default     = false
-  description = "Set true to enable mongodb restore"
+  description = "Specifies whether to enable restoring dump to the Mongodb database."
 }
 
 variable "mongodb_restore_config" {
@@ -94,5 +94,5 @@ variable "mongodb_restore_config" {
     incremental_restore_enable = false
     file_name_incremental      = ""
   }
-  description = "Mongodb restore configurations"
+  description = "Configuration options for restoring dump to the Mongodb database."
 }