boldlink / terraform-aws-docdb Goto Github PK

This Terraform module Manages a DocDB Cluster.

• Removes Complexity: The module abstracts away much of the underlying complexity of provisioning and managing Amazon DocumentDB clusters, making it easier to create and manage clusters with minimal effort.

• Reusable Configuration: Define your DocumentDB cluster configuration once and reuse it across different projects or environments, reducing duplication and errors.

• Configuration Options: The module exposes a wide range of configuration options, allowing you to fine-tune your DocumentDB cluster to meet your specific requirements.

Examples available here

NOTE: These examples use the latest version of this module

module "complete_cluster" {
  source                    = "boldlink/docdb/aws"
  version                   = "<specify_latest_version_here>"
  cluster_identifier        = local.cluster_name
  availability_zones        = data.aws_availability_zones.available.names
  identifier                = "${local.cluster_name}-instance"
  instance_class            = "db.t3.medium"
  instance_count            = local.count
  final_snapshot_identifier = "${local.cluster_name}-final-snapshot"
  master_username           = random_string.master_username.result
  master_password           = random_password.master_password.result
  subnet_ids                = data.aws_subnets.default.ids
  tags = {
    environment        = "examples"
    "user::CostCenter" = "terraform-registry"
  }
}

AWS DocumentDB Cluster Documentation

Terraform DocumentDB Cluster Documentation

No modules.

list(object({
    name         = string
    value        = string
    apply_method = string
  }))

[
  "audit",
  "profiler"
]

This repository uses third party software:

• pre-commit - Used to help ensure code and documentation consistency
  • Install with brew install pre-commit
  • Manually use with pre-commit run
• terraform 0.14.11 For backwards compatibility we are using version 0.14.11 for testing making this the min version tested and without issues with terraform-docs.
• terraform-docs - Used to generate the Inputs and Outputs sections
  • Install with brew install terraform-docs
  • Manually use via pre-commit
• tflint - Used to lint the Terraform code
  • Install with brew install tflint
  • Manually use via pre-commit

The example stacks are used by BOLDLink developers to validate the modules by building an actual stack on AWS.

Some of the modules have dependencies on other modules (ex. Ec2 instance depends on the VPC module) so we create them first and use data sources on the examples to use the stacks.

Any supporting resources will be available on the tests/supportingResources and the lifecycle is managed by the Makefile targets.

Resources on the test/supportingResources folder are not intended for demo or actual implementation purposes, and can be used for reference.

The makefile contain in this repo is optimized for linux paths and the main purpose is to execute testing for now.

• Create all tests stacks including any supporting resources:

make tests

• Clean all tests except existing supporting resources:

make clean

• Clean supporting resources - this is done separately so you can test your module build/modify/destroy independently.

make cleansupporting

• !!!DANGER!!! Clean the state files from examples and test/supportingResources - use with CAUTION!!!

make cleanstatefiles