Terraform AWS ARC Document DB Module Usage Guide¶

Introduction¶

Purpose of the Document¶

This document provides guidelines and instructions for users looking to implement the Terraform AWS ARC Document DB module to provision an Amazon Document DB cluster.

Module Overview¶

The terraform-aws-arc-document-db module provides a secure and modular foundation for deploying Document DB cluster on AWS.

Prerequisites¶

Before using this module, ensure you have the following:

AWS credentials configured.
Terraform installed.
A working knowledge of AWS Document DB cluster.

Getting Started¶

Module Source¶

To use the module in your Terraform configuration, include the following source block:

module "example_doc_db_cluster" {
  source = "sourcefuse/arc-document-db/aws"
  // we recommend to pin the version we aren't simply for an example reference against our latest changes.
  # insert the required variables here
}

Integration with Existing Terraform Configurations¶

Integrate the module with your existing Terraform mono repo configuration, follow the steps below:

Create a new folder in terraform/ named document-db.
Create the required files, see the examples to base off of.
Configure with your backend
- Create the environment backend configuration file: config.<environment>.hcl
  - region: Where the backend resides
  - key: <working_directory>/terraform.tfstate
  - bucket: Bucket name where the terraform state will reside
  - dynamodb_table: Lock table so there are not duplicate tfplans in the mix
  - encrypt: Encrypt all traffic to and from the backend

Required AWS Permissions¶

Ensure that the AWS credentials used to execute Terraform have the necessary permissions to create Document DB cluster.

Module Configuration¶

Input Variables¶

For a list of input variables, see the README Inputs section.

Output Values¶

For a list of outputs, see the README Outputs section.

Module Usage¶

Basic Usage¶

For basic usage, see the example folder.

This example will create:

A DocumentDB cluster: This is a fully managed document database service that supports MongoDB workloads. The cluster's configuration is determined by the input variables, such as doc_db_cluster_name, cluster_size, master_username, instance_class, vpc_id, and subnet_ids.

AWS tags: These are key-value pairs that you can assign to AWS resources. The tags are being generated by the arc-tags/aws module and are applied to the DocumentDB cluster.

Tips and Recommendations¶

The module focuses on provisioning an Document DB Cluster. Adjust the configuration parameters as needed for your specific use case.

Troubleshooting¶

Reporting Issues¶

If you encounter a bug or issue, please report it on the GitHub repository.

Security Considerations¶

AWS VPC¶

Understand the security considerations related to Document DB clusters on AWS when using this module.

Best Practices for AWS Document DB¶

Follow best practices to ensure secure Document DB configurations:

DocumentDB security on AWS

Contributing and Community Support¶

Contributing Guidelines¶

Contribute to the module by following the guidelines outlined in the CONTRIBUTING.md file.

Reporting Bugs and Issues¶

If you find a bug or issue, report it on the GitHub repository.

License¶

License Information¶

This module is licensed under the Apache 2.0 license. Refer to the LICENSE file for more details.

Open Source Contribution¶

Contribute to open source by using and enhancing this module. Your contributions are welcome!