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
+51-20Lines changed: 51 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,42 +6,77 @@
6
6
7
7
### [SquareOps Technologies](https://squareops.com/) Your DevOps Partner for Accelerating cloud journey.
8
8
<br>
9
-
This module allows users to customize the deployment by providing various input variables. Users can specify the name and environment of the Redis deployment, the chart and app version, the namespace in which the Redis deployment will be created, and whether to enable Grafana monitoring. The module also allows users to set the recovery window for the AWS Secrets Manager that is used to store the Redis password.
9
+
This module allows users to customize the deployment by providing various input variables. Users can specify the name and environment of the Redis deployment, the chart and app version, the namespace in which the Redis deployment will be created, and whether to enable Grafana monitoring. 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 redis on AWS EKS, Azure AKS & GCP GKE Kubernetes clusters with the flexibility to customize their configurations according to their needs.
10
10
<br><br>
11
11
This module creates a Redis master and one or more Redis slaves, depending on the specified architecture. The module creates Kubernetes services for the Redis master and slave deployments, and exposes these services as endpoints that can be used to connect to the Redis database. Users can retrieve these endpoints using the module's outputs.
12
12
13
13
## Supported Versions :
14
14
15
-
| Redis Helm Chart Version | K8s supported version |
15
+
| Redis Helm Chart Version | K8s supported version (EKS, AKS & GKE)|
Refer [examples](https://github.com/squareops/terraform-kubernetes-redis/tree/main/examples/complete) for more details.
77
+
- Refer [AWS examples](https://github.com/squareops/terraform-kubernetes-redis/tree/main/examples/complete/aws) for more details.
78
+
- Refer [Azure examples](https://github.com/squareops/terraform-kubernetes-redis/tree/main/examples/complete/azure) for more details.
79
+
- Refer [GCP examples](https://github.com/squareops/terraform-kubernetes-redis/tree/main/examples/complete/gcp) for more details.
45
80
46
81
## IAM Permissions
47
82
The required IAM permissions to create resources from this module can be found [here](https://github.com/squareops/terraform-kubernetes-redis/blob/main/IAM.md)
@@ -54,7 +89,7 @@ The required IAM permissions to create resources from this module can be found [
54
89
5. To deploy Prometheus/Grafana, please follow the installation instructions for each tool in their respective documentation.
55
90
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.
56
91
7. Finally, you can use Grafana to create custom dashboards and visualize the metrics data collected by Prometheus.
57
-
8. This module is compatible with EKS version 1.23, 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.
92
+
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.
58
93
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
| <aname="input_grafana_monitoring_enabled"></a> [grafana\_monitoring\_enabled](#input\_grafana\_monitoring\_enabled)| Specify whether or not to deploy Redis exporter to collect Redis metrics for monitoring in Grafana. |`bool`|`false`| no |
96
126
| <aname="input_namespace"></a> [namespace](#input\_namespace)| Namespace where the Redis resources will be deployed. |`string`|`"redis"`| no |
97
127
| <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 it can delete the secret. The value can be 0 to force deletion without recovery, or a range from 7 to 30 days. |`number`|`0`| no |
98
-
| <aname="input_redis_config"></a> [redis\_config](#input\_redis\_config)| Specify the configuration settings for Redis, including the name, environment, storage options, replication settings, store password to secret manager and custom YAML values. |`any`| <pre>{<br> "architecture": "replication",<br> "environment": "",<br> "master_volume_size": "",<br> "name": "",<br> "slave_replica_count": 1,<br> "slave_volume_size": "",<br> "storage_class_name": "",<br> "store_password_to_secret_manager": "",<br> "values_yaml": ""<br>}</pre> | no |
128
+
| <aname="input_redis_config"></a> [redis\_config](#input\_redis\_config)| Specify the configuration settings for Redis, including the name, environment, storage options, replication settings, store password to secret manager and custom YAML values. |`any`| <pre>{<br> "architecture": "replication",<br> "environment": "",<br> "master_volume_size": "",<br> "name": "",<br> "slave_replica_count": 1,<br> "slave_volume_size": "",<br> "storage_class_name": "",<br> "store_password_to_secret_manager": true,<br> "values_yaml": ""<br>}</pre> | no |
129
+
| <aname="input_redis_password"></a> [redis\_password](#input\_redis\_password)| n/a |`string`|`""`| no |
Copy file name to clipboardExpand all lines: examples/complete/aws/README.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,7 @@
6
6
### [SquareOps Technologies](https://squareops.com/) Your DevOps Partner for Accelerating cloud journey.
7
7
<br>
8
8
This example will be very useful for users who are new to a module and want to quickly learn how to use it. By reviewing the examples, users can gain a better understanding of how the module works, what features it supports, and how to customize it to their specific needs.
9
+
9
10
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
|[aws_eks_cluster.cluster](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/eks_cluster)| data source |
31
31
|[aws_eks_cluster_auth.cluster](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/eks_cluster_auth)| data source |
32
+
|[google_client_config.default](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/client_config)| data source |
33
+
|[google_container_cluster.primary](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/container_cluster)| data source |
### [SquareOps Technologies](https://squareops.com/) Your DevOps Partner for Accelerating cloud journey.
7
+
<br>
8
+
This example will be very useful for users who are new to a module and want to quickly learn how to use it. By reviewing the examples, users can gain a better understanding of how the module works, what features it supports, and how to customize it to their specific needs.
|[azurerm_kubernetes_cluster.primary](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/kubernetes_cluster)| data source |
33
+
34
+
## Inputs
35
+
36
+
No inputs.
37
+
38
+
## Outputs
39
+
40
+
| Name | Description |
41
+
|------|-------------|
42
+
| <aname="output_redis_credential"></a> [redis\_credential](#output\_redis\_credential)| Redis credentials used for accessing the database. |
43
+
| <aname="output_redis_endpoints"></a> [redis\_endpoints](#output\_redis\_endpoints)| Redis endpoints in the Kubernetes cluster. |
0 commit comments