Skip to content

Commit 18d013d

Browse files
author
vijay-stephen
committed
Merge pull request #90 from sourcefuse/refactor/remove-cloudposse-dependency
Refactor - Remove dependency on Cloudposse
1 parent 2f6b0da commit 18d013d

File tree

1 file changed

+24
-6
lines changed
  • docs/arc-iac-docs/modules/terraform-aws-arc-db/docs/module-usage-guide

1 file changed

+24
-6
lines changed

docs/arc-iac-docs/modules/terraform-aws-arc-db/docs/module-usage-guide/README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To use the module in your Terraform configuration, include the following source
2727
```hcl
2828
module "aurora" {
2929
source = "sourcefuse/arc-db/aws"
30-
version = "3.0.0"
30+
version = "4.0.0"
3131
# insert the required variables here
3232
}
3333
```
@@ -37,7 +37,7 @@ module "aurora" {
3737
Integrate the module with your existing Terraform mono repo configuration, follow the steps below:
3838

3939
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.
4141
3. Configure with your backend
4242
- Create the environment backend configuration file: `config.<environment>.hcl`
4343
- **region**: Where the backend resides
@@ -64,15 +64,33 @@ For a list of outputs, see the README [Outputs](https://github.com/sourcefuse/te
6464

6565
### Basic Usage
6666

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.
6868

6969
This example will create:
7070

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.
7273

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
7475

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.
7694

7795
### Tips and Recommendations
7896

0 commit comments

Comments
 (0)