You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-6Lines changed: 12 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@
6
6
7
7
### [SquareOps Technologies](https://squareops.com/) Your DevOps Partner for Accelerating cloud journey.
8
8
<br>
9
-
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.
9
+
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, Azure key vault & GCP secrets manager. With this module, users can easily deploy a highly available MongoDB cluster on AWS EKS, AZure AKS & GCP GKE Kubernetes clusters with the flexibility to customize their configurations according to their needs.
10
10
11
11
## Supported Versions:
12
12
13
-
| MongoDB Helm Chart Version | K8s supported version |
13
+
| MongoDB Helm Chart Version | K8s supported version (EKS, AKS & GKE)|
14
14
| :-----: | :--- |
15
15
|**13.1.5**|**1.23,1.24,1.25,1.26,1.27**|
16
16
@@ -59,7 +59,9 @@ module "mongodb" {
59
59
60
60
61
61
```
62
-
Refer [examples](https://github.com/squareops/terraform-kubernetes-mongodb/tree/main/examples/complete) for more details.
62
+
Refer [AWS examples](https://github.com/squareops/terraform-kubernetes-mongodb/tree/main/examples/complete/aws) for more details.
63
+
Refer [Azure examples](https://github.com/squareops/terraform-kubernetes-mongodb/tree/main/examples/complete/azure) for more details.
64
+
Refer [GCP examples](https://github.com/squareops/terraform-kubernetes-mongodb/tree/main/examples/complete/gcp) for more details.
63
65
64
66
## IAM Permissions
65
67
The required IAM permissions to create resources from this module can be found [here](https://github.com/squareops/terraform-kubernetes-mongodb/blob/main/IAM.md)
@@ -72,7 +74,7 @@ The required IAM permissions to create resources from this module can be found [
72
74
5. To deploy Prometheus/Grafana, please follow the installation instructions for each tool in their respective documentation.
73
75
6. Once Prometheus and Grafana are deployed, the exporter can be configured to scrape metrics data from your application or system and send it to Prometheus.
74
76
7. Finally, you can use Grafana to create custom dashboards and visualize the metrics data collected by Prometheus.
75
-
8. This module is compatible with EKS version 1.23,1.24,1.25,1.26 and 1.27 which is great news for users deploying the module on an EKS cluster running that version. Review the module's documentation, meet specific configuration requirements, and test thoroughly after deployment to ensure everything works as expected.
77
+
8. This module is compatible with EKS, AKS & GKE which is great news for users deploying the module on an AWS, Azure & GCP cloud. Review the module's documentation, meet specific configuration requirements, and test thoroughly after deployment to ensure everything works as expected.
76
78
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
| <aname="input_namespace"></a> [namespace](#input\_namespace)| Name of the Kubernetes namespace where the Mongodb deployment will be deployed. |`string`|`"mongodb"`| no |
127
130
| <aname="input_project_id"></a> [project\_id](#input\_project\_id)| Google Cloud project ID |`string`|`""`| no |
128
131
| <aname="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 |
132
+
| <aname="input_resource_group_location"></a> [resource\_group\_location](#input\_resource\_group\_location)| Azure region |`string`|`"East US"`| no |
133
+
| <aname="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name)| Azure Resource Group name |`string`|`""`| no |
134
+
| <aname="input_storage_account_name"></a> [storage\_account\_name](#input\_storage\_account\_name)| Azure storage account name |`string`|`""`| no |
0 commit comments