Code Monkey home page Code Monkey logo

terraform-aws-rds's Introduction

Cloud Posse

terraform-aws-rds Build Status Latest Release Slack Community

Terraform module to provision AWS RDS instances


This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Introduction

The module will create:

  • DB instance (MySQL, Postgres, SQL Server, Oracle)
  • DB Parameter Group
  • DB Subnet Group
  • DB Security Group
  • DNS Record in Route53 for the DB endpoint

Usage

module "rds_instance" {
      source                      = "git::https://github.com/cloudposse/terraform-aws-rds.git?ref=master"
      namespace                   = "eg"
      stage                       = "prod"
      name                        = "app"
      dns_zone_id                 = "Z89FN1IW975KPE"
      host_name                   = "db"
      security_group_ids          = ["sg-xxxxxxxx"]
      database_name               = "wordpress"
      database_user               = "admin"
      database_password           = "xxxxxxxxxxxx"
      database_port               = 3306
      multi_az                    = "true"
      storage_type                = "gp2"
      allocated_storage           = "100"
      storage_encrypted           = "true"
      engine                      = "mysql"
      engine_version              = "5.7.17"
      instance_class              = "db.t2.medium"
      db_parameter_group          = "mysql5.6"
      parameter_group_name        = "mysql-5-6"
      publicly_accessible         = "false"
      subnet_ids                  = ["sb-xxxxxxxxx", "sb-xxxxxxxxx"]
      vpc_id                      = "vpc-xxxxxxxx"
      snapshot_identifier         = "rds:production-2015-06-26-06-05"
      auto_minor_version_upgrade  = "true"
      allow_major_version_upgrade = "false"
      apply_immediately           = "false"
      maintenance_window          = "Mon:03:00-Mon:04:00"
      skip_final_snapshot         = "false"
      copy_tags_to_snapshot       = "true"
      backup_retention_period     = 7
      backup_window               = "22:00-03:00"

      db_parameter                = [
        { name  = "myisam_sort_buffer_size"   value = "1048576" },
        { name  = "sort_buffer_size"          value = "2097152" },
      ]
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Inputs

Name Description Type Default Required
allocated_storage The allocated storage in GBs string - yes
allow_major_version_upgrade Allow major version upgrade string false no
apply_immediately Specifies whether any database modifications are applied immediately, or during the next maintenance window string false no
attributes Additional attributes (e.g. 1) list <list> no
auto_minor_version_upgrade Allow automated minor version upgrade (e.g. from Postgres 9.5.3 to Postgres 9.5.4) string true no
backup_retention_period Backup retention period in days. Must be > 0 to enable backups string 0 no
backup_window When AWS can perform DB snapshots, can't overlap with maintenance window string 22:00-03:00 no
copy_tags_to_snapshot Copy tags from DB to a snapshot string true no
database_name The name of the database to create when the DB instance is created string - yes
database_password (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user string `` no
database_port Database port (e.g. 3306 for MySQL). Used in the DB Security Group to allow access to the DB instance from the provided security_group_ids string - yes
database_user (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user string `` no
db_parameter A list of DB parameters to apply. Note that parameters may differ from a DB family to another list <list> no
db_parameter_group Parameter group, depends on DB engine used string - yes
delimiter Delimiter to be used between name, namespace, stage and attributes string - no
dns_zone_id The ID of the DNS Zone in Route53 where a new DNS record will be created for the DB host name string `` no
enabled Set to false to prevent the module from creating any resources string true no
engine Database engine type string - yes
engine_version Database engine version, depends on engine type string - yes
final_snapshot_identifier Final snapshot identifier e.g.: some-db-final-snapshot-2015-06-26-06-05 string `` no
host_name The DB host name created in Route53 string db no
instance_class Class of RDS instance string - yes
iops The amount of provisioned IOPS. Setting this implies a storage_type of 'io1'. Default is 0 if rds storage type is not 'io1' string 0 no
maintenance_window The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi' UTC string Mon:03:00-Mon:04:00 no
multi_az Set to true if multi AZ deployment must be supported string false no
name The Name of the application or solution (e.g. bastion or portal) string - yes
namespace Namespace (e.g. eg or cp) string - yes
parameter_group_name Name of the DB parameter group to associate string `` no
publicly_accessible Determines if database can be publicly available (NOT recommended) string false no
security_group_ids he IDs of the security groups from which to allow ingress traffic to the DB instance list <list> no
skip_final_snapshot If true (default), no snapshot will be made before deleting DB string true no
snapshot_identifier Snapshot identifier e.g: rds:production-2015-06-26-06-05. If specified, the module create cluster from the snapshot string `` no
stage Stage (e.g. prod, dev, staging) string - yes
storage_encrypted (Optional) Specifies whether the DB instance is encrypted. The default is false if not specified. string false no
storage_type One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). string standard no
subnet_ids List of subnets for the DB list - yes
tags Additional tags (e.g. map(BusinessUnit,XYZ) map <map> no
vpc_id VPC ID the DB instance will be created in string - yes

Outputs

Name Description
hostname DNS host name of the instance
instance_address Address of the instance
instance_endpoint DNS Endpoint of the instance
instance_id ID of the instance
parameter_group_id ID of the Parameter Group
security_group_id ID of the Security Group
subnet_group_id ID of the Subnet Group

Related Projects

Check out these related projects.

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

E-Mail

  • Questions. We'll use a Shared Slack channel between your team and ours.
  • Troubleshooting. We'll help you triage why things aren't working.
  • Code Reviews. We'll review your Pull Requests and provide constructive feedback.
  • Bug Fixes. We'll rapidly work to fix any bugs in our projects.
  • Build New Terraform Modules. We'll develop original modules to provision infrastructure.
  • Cloud Architecture. We'll assist with your cloud strategy and design.
  • Implementation. We'll provide hands-on support to implement our reference architectures.

Community Forum

Get access to our Open Source Community Forum on Slack. It's FREE to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build sweet infrastructure.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2018 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know at [email protected]

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We love Open Source Software!

We offer paid support on all of our projects.

Check out our other projects, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman
Erik Osterman
Andriy Knysh
Andriy Knysh
Sergey Vasilyev
Sergey Vasilyev
Valeriy
Valeriy
Konstantin B
Konstantin B
drmikecrowe
drmikecrowe

terraform-aws-rds's People

Contributors

aknysh avatar dschaaff avatar s2504s avatar vadim-hleif avatar drama17 avatar goruha avatar const-bon avatar drmikecrowe avatar

Watchers

Brian Crook avatar Brandon Dunton avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.