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: docs/arc-iac-docs/modules/terraform-aws-arc-db/docs/module-usage-guide/README.md
+24-6Lines changed: 24 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ To use the module in your Terraform configuration, include the following source
27
27
```hcl
28
28
module "aurora" {
29
29
source = "sourcefuse/arc-db/aws"
30
-
version = "3.0.0"
30
+
version = "4.0.0"
31
31
# insert the required variables here
32
32
}
33
33
```
@@ -37,7 +37,7 @@ module "aurora" {
37
37
Integrate the module with your existing Terraform mono repo configuration, follow the steps below:
38
38
39
39
1. Create a new folder in `terraform/` named `db`.
40
-
2. Create the required files, see the [examples](https://github.com/sourcefuse/terraform-aws-arc-db/tree/main/examples/simple) to base off of.
40
+
2. Create the required files, see the [examples](https://github.com/sourcefuse/terraform-aws-arc-db/tree/main/examples/rds) to base off of.
41
41
3. Configure with your backend
42
42
- Create the environment backend configuration file: `config.<environment>.hcl`
43
43
-**region**: Where the backend resides
@@ -64,15 +64,33 @@ For a list of outputs, see the README [Outputs](https://github.com/sourcefuse/te
64
64
65
65
### Basic Usage
66
66
67
-
For basic usage, see the [example](https://github.com/sourcefuse/terraform-aws-arc-db/tree/main/example) folder.
67
+
For basic usage, see the [example](https://github.com/sourcefuse/terraform-aws-arc-db/tree/main/examples/rds) folder.
68
68
69
69
This example will create:
70
70
71
-
module "aurora": This module is creating an Aurora database cluster.The module is configuring the Aurora cluster with various settings, such as the instance type, the number of instances in the cluster, the subnets and security groups it's associated with, and more.
71
+
- RDS Instance Example
72
+
This example demonstrates deploying a single RDS instance using the module, configuring an Amazon RDS database with basic settings like instance class, storage, and connectivity. It showcases options for database engine, encryption, and CloudWatch monitoring for a standalone RDS database. Ideal for simple, production-ready RDS setups.
72
73
73
-
module "rds_sql_server": This module is creating an Amazon RDS instance for SQL Server.This module is configuring the RDS instance with various settings, such as the database engine and version, the instance class, the allocated storage, the security groups it's associated with, and more.
74
+
### RDS Proxy
74
75
75
-
Both of these modules are using data sources (data.aws_vpc.vpc, data.aws_subnets.private, data.aws_security_groups.db_sg, etc.) to fetch information about the existing AWS infrastructure, such as the VPC, subnets, and security groups, and use that information to configure the databases.
76
+
For RDS Proxy, see the [example](https://github.com/sourcefuse/terraform-aws-arc-db/tree/main/examples/rds-proxy) folder.
77
+
78
+
- RDS Proxy Example
79
+
This example configures an RDS Proxy for an RDS database, helping manage connection pooling for improved database performance and security. By integrating with RDS Proxy, it reduces connection management overhead and scales automatically with demand, useful for applications with variable database traffic and sensitive to scaling requirements.
80
+
81
+
### Aurora Cluster
82
+
83
+
For Aurora Cluster, see the [example](https://github.com/sourcefuse/terraform-aws-arc-db/tree/main/examples/aurora) folder.
84
+
85
+
- Aurora Cluster Example
86
+
This example provisions an Amazon Aurora cluster, utilizing the module to set up a high-availability, high-performance database solution. The configuration includes multiple instances within a cluster, providing a resilient and cost-effective solution suitable for demanding applications.
87
+
88
+
### Aurora Cluster Serverless
89
+
90
+
For Aurora Cluster Serverless, see the [example](https://github.com/sourcefuse/terraform-aws-arc-db/tree/main/examples/aurora-serverless) folder.
91
+
92
+
- Aurora Serverless Cluster Example
93
+
This example deploys an Aurora Serverless cluster autoscaling, making it ideal for applications with unpredictable or intermittent database usage. The module configures serverless capacity, connectivity, and database settings, automatically adjusting to workload needs without manual intervention.
0 commit comments