Table of Contents

• Introduction
• Guidelines
• Requirements
• Providers
• Modules
• Resources
• Inputs
• Outputs

---

Introduction

This is a template for Terraform modules.

It is part of our XOAP Automation Forces Open Source community library to give you a quick start into Infrastructure as Code deployments with Terraform.

We have a lot of Terraform modules that are Open Source and maintained by the XOAP staff.

Please check the links for more info, including usage information and full documentation:

• XOAP Website
• XOAP Documentation
• Twitter
• LinkedIn

---

Guidelines

We are using the following guidelines to write code and make it easier for everyone to follow a destinctive guideline. Please check these links before starting to work on changes.

Git Naming Conventions are an important part of the development process. They descrtibe how Branched, Commit Messages, Pull Requests and Tags should look like to make the easily understandebla for everybody in the development chain.

Git Naming Conventions

he Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of.

Conventional Commits

The better a Pull Request description is, the better a review can understand and decide on how to review the changes. This improves implementation speed and reduces communication between the requester and the reviewer resulting in much less overhead.

Wiriting A Great Pull Request Description

Versioning is a crucial part for Terraform Stacks and Modules. Without version tags you cannot clearly create a stable environment and be sure that your latest changes won't crash your production environment (sure it still can happen, but we are trying our best to implement everything that we can to reduce the risk)

Semantic Versioning

Naming Conventions for Terraform resources must be used.

Terraform Naming Conventions

---

Usage

Installation

For the first ime using this template necessary tools need to be installed. A script for PowerShell Core is provided under ./build/init.ps1

This script will install following dependencies:

• pre-commit
• terraform-docs
• tflint
• tfsec
• checkov
• terrascan
• kics

This script configures:

• global git template under ~/.git-template
• global pre-commit hooks for prepare-commit-msg and commit-msg under ~/.git-template/hooks
• github actions:
  • linting and checks for pull requests from dev to master/main
  • automatic tagging and release creation on pushes to master/main
  • dependabot updates

It currently supports the automated installation for macOS. Support for Windows and Linux will be available soon.

Synchronisation

We provided a script under ./build/sync_template.ps1 to fetch the latest changes from this template repository. Please be aware that this is mainly a copy operation which means all your current changes have to be committed first and after running the script you have to merge this changes into your codebase.

Configuration

---

Requirements

Name	Version
terraform	>=1.1.6
aws	>= 4.8.0

Providers

Name	Version
aws	>= 4.8.0
random	n/a

Modules

Name	Source	Version
this_label	git::github.com/xoap-io/terraform-aws-misc-label	v0.1.1
this_label_snapshot	git::github.com/xoap-io/terraform-aws-misc-label	v0.1.1

Resources

Name	Type
aws_db_instance.this	resource
aws_db_option_group.this	resource
aws_db_parameter_group.this	resource
aws_db_subnet_group.this	resource
random_password.this	resource
random_string.this_snapshot	resource

Inputs

Name	Description	Type	Default	Required
backup	The backup configuration for the RDS instance	object({ enabled = bool retention_days = number })	n/a	yes
context	Default context for naming and tagging purpose	object({ organization = string environment = string account = string product = string tags = map(string) })	n/a	yes
enable_performance_insights	Whether to enable Performance Insights	bool	n/a	yes
instance	The RDS instance to create	object({ type = string engine = string engine_version = string major_engine_version = string family = string multi_az = bool publicly_accessible = bool deletion_protection = bool allow_upgrades = bool port = number })	n/a	yes
logging	The logging configuration for the RDS instance	object({ enabled = bool types = set(string) })	n/a	yes
name	The name of the RDS instance	string	n/a	yes
parameters	The parameters to pass to the RDS instance	map(string)	n/a	yes
storage	The storage configuration for the RDS instance	object({ max_allocated_storage = number allocated_storage = number kms_arn = string })	n/a	yes
vpc	The VPC to create the RDS instance in	object({ id = string subnets = list(string) security_groups = list(string) })	n/a	yes

Outputs

Name	Description
auth	Exported auth information for passing between modules
context	Exported context from input variable
db_instance	Exported output from aws_db_instance
option_group	Exported output from aws_db_option_group
parameter_group	Exported output from aws_db_parameter_group
subnet_group	Exported output from aws_db_subnet_group