README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-rds-cluster

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-rds-cluster

# Badges to display
badges:
  - name: "Build Status"
    image: "https://travis-ci.org/cloudposse/terraform-aws-rds-cluster.svg?branch=master"
    url: "https://travis-ci.org/cloudposse/terraform-aws-rds-cluster"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-rds-cluster.svg"
    url: "https://github.com/cloudposse/terraform-aws-rds-cluster/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-rds"
    description: "Terraform module to provision AWS RDS instances"
    url: "https://github.com/cloudposse/terraform-aws-rds"
  - name: "terraform-aws-rds-cloudwatch-sns-alarms"
    description: "Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic"
    url: "https://github.com/cloudposse/terraform-aws-rds-cloudwatch-sns-alarms"

# Short description of this project
description: |-
  Terraform module to provision an [`RDS Aurora`](https://aws.amazon.com/rds/aurora) cluster for MySQL or Postgres.

# How to use this project
usage: |-

  Basic [example](examples/basic)

  ```hcl
  module "rds_cluster_aurora_postgres" {
    source             = "git::https://github.com/cloudposse/terraform-aws-rds-cluster.git?ref=master"
    name               = "postgres"
    engine             = "aurora-postgresql"
    cluster_family     = "aurora-postgresql9.6"
    cluster_size       = "2"
    namespace          = "eg"
    stage              = "dev"
    admin_user         = "admin1"
    admin_password     = "Test123456789"
    db_name            = "dbname"
    db_port            = "5432"
    instance_type      = "db.r4.large"
    vpc_id             = "vpc-36f54c51"
    availability_zones = ["us-east-1a", "us-east-1b"]
    security_groups    = ["sg-0a6d5a3a"]
    subnets            = ["subnet-705e3115", "subnet-dab9e2f0"]
    zone_id            = "Z19EN1IQ979KPE"
  }
  ```

  With [cluster parameters](examples/with_cluster_parameters)

  ```hcl
  module "rds_cluster_aurora_mysql" {
    source             = "git::https://github.com/cloudposse/terraform-aws-rds-cluster.git?ref=master"
    engine             = "aurora"
    cluster_family     = "aurora-mysql5.7"
    cluster_size       = "2"
    namespace          = "eg"
    stage              = "dev"
    name               = "db"
    admin_user         = "admin1"
    admin_password     = "Test123456789"
    db_name            = "dbname"
    instance_type      = "db.t2.small"
    vpc_id             = "vpc-xxxxxxx"
    availability_zones = ["us-east-1a", "us-east-1b"]
    security_groups    = ["sg-0a6d5a3a"]
    subnets            = ["subnet-8b03333", "subnet-8b0772a3"]
    zone_id            = "xxxxxxxx"

    cluster_parameters = [
      {
        name  = "character_set_client"
        value = "utf8"
      },
      {
        name  = "character_set_connection"
        value = "utf8"
      },
      {
        name  = "character_set_database"
        value = "utf8"
      },
      {
        name  = "character_set_results"
        value = "utf8"
      },
      {
        name  = "character_set_server"
        value = "utf8"
      },
      {
        name  = "collation_connection"
        value = "uft8_bin"
      },
      {
        name  = "collation_server"
        value = "uft8_bin"
      },
      {
        name         = "lower_case_table_names"
        value        = "1"
        apply_method = "pending-reboot"
      },
      {
        name         = "skip-character-set-client-handshake"
        value        = "1"
        apply_method = "pending-reboot"
      },
    ]
  }
  ```

  With [enhanced monitoring](examples/enhanced_monitoring)

  ```hcl
  # create IAM role for monitoring
  resource "aws_iam_role" "enhanced_monitoring" {
    name               = "rds-cluster-example-1"
    assume_role_policy = "${data.aws_iam_policy_document.enhanced_monitoring.json}"
  }

  # Attach Amazon's managed policy for RDS enhanced monitoring
  resource "aws_iam_role_policy_attachment" "enhanced_monitoring" {
    role       = "${aws_iam_role.enhanced_monitoring.name}"
    policy_arn = "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole"
  }

  # allow rds to assume this role
  data "aws_iam_policy_document" "enhanced_monitoring" {
    statement {
        actions = [
        "sts:AssumeRole",
      ]

      effect = "Allow"

      principals {
        type        = "Service"
        identifiers = ["monitoring.rds.amazonaws.com"]
      }
    }
  }

  module "rds_cluster_aurora_postgres" {
    source             = "git::https://github.com/cloudposse/terraform-aws-rds-cluster.git?ref=master"
    engine             = "aurora-postgresql"
    cluster_family     = "aurora-postgresql9.6"
    cluster_size       = "2"
    namespace          = "eg"
    stage              = "dev"
    name               = "db"
    admin_user         = "admin1"
    admin_password     = "Test123456789"
    db_name            = "dbname"
    db_port            = "5432"
    instance_type      = "db.r4.large"
    vpc_id             = "vpc-xxxxxxx"
    availability_zones = ["us-east-1a", "us-east-1b"]
    security_groups    = ["sg-0a6d5a3a"]
    subnets            = ["subnet-8b03333", "subnet-8b0772a3"]
    zone_id            = "xxxxxxxx"

    # enable monitoring every 30 seconds
    rds_monitoring_interval = "30"

    # reference iam role created above
    rds_monitoring_role_arn = "${aws_iam_role.enhanced_monitoring.arn}"
  }
  ```

# Example usage
#examples: |-
#  Example goes here...

# How to get started quickly
#quickstart: |-
#  Here's how to get started...

# Other files to include in this README from the project folder
include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    github: "osterman"
  - name: "Igor Rodionov"
    github: "goruha"
  - name: "Andriy Knysh"
    github: "aknysh"
  - name: "Sarkis Varozian"
    github: "sarkis"
  - name: "Mike Crowe"
    github: "mike-zipit"
  - name: "Sergey Vasilyev"
    github: "s2504s"
  - name: "Todor Todorov"
    github: "tptodorov"
  - name: "Lee Huffman"
    github: "leehuffman"