marapp-infra

marapp requires a set of infrastructure-level services into which to deploy application-level environments and their resources. This is meant to be used only once, as it can accomodate any number of marapp environments.

This is a Terraform module meant to provision these services in AWS

To get started you will need the following:

• Terraform 0.12
• AWS CLI 2.0
• A set of valid AWS Administrator or PowerUser Credentials
• [if provisioning a MongoDB Atlas cluster]:
  • a set of MongoDB Atlas Credentials (a pair of public-private keys)

Installation

Follow these instructions after installing both Terraform and AWS CLI:

1. Configure AWS Credentials

   Type aws configure and input the aforementioned AWS credentials, including the region where you want to deploy the infrastructure stack into

2. Initialize Terraform modules

   Navigate to the src directory inside this repository and type terraform init

3. Fill in input variables

   Open up terraform.tfvars and change default variable values to meet your need

   The following variables will provision additional resources based on their value:

   • create_elasticache_redis_node - will provision a Redis node in AWS, set to false if you're using your own Redis node cluster

   • create_elasticsearch_cluster - will provision an Elasticsearch cluster in AWS, set to false if you're using your own Elasticsearch cluster

   • create_mongodb_atlas_resources - will provision a MongoDB cluster in MongoDB Atlas, set to false if you're using your own MongoDB cluster

     • To provision this resource you will need a set of valid API credentials generated using the MongoDB Atlas dashboard
     • Controls to generate API keys can be found in your Organization's Access Manager page, under the API Keys tab

4. Run and visualize a provisioning plan

   Run terraform plan

   This serves to validate your input variables and credentials, and to perform a dry-run against your AWS account. It outputs a plan and a summary of resources to-be-created

5. Apply provisioning plan

   Run terraform apply

   This will have the same behaviour as terraform plan, with the added difference of prompting you to accept the planned changes

   Simply input yes when prompted, and a live feed of resources being provisioned is displayed

6. Inspect the output

   At the end of a successful apply, a set of variables and their values shall be output, to be used in further provisioning application environments

   These can be found here

---

Requirements

Name	Version
terraform	>= 0.12
aws-cli	~> 2.0

Providers

Name	Version
aws	~> 2.0
mongodbatlas	~> 0.5
random	~> 2.2

Inputs

Name	Description	Type	Default	Required
stack_identifier	Application and infrastructure stack identifier. Prepended to provisioned resources	string	"marapp"	no
environment_name	Application and infrastructure environment name. Used to tag resources as belonging to the environment. (i.e. staging/rc/prod)	string	n/a	yes
aws_region	AWS region into which to provision resources (i.e. us-east-1/us-west-1)	string	n/a	yes
vpc_cidr	Addressable CIDR of the AWS VPC.	string	n/a	yes
availability_zones	List of availability zones into which to provision subnets	list	n/a	yes
subnet_cidrs	Addressable CIDRs for the availability zones' subnets	list	n/a	yes
private_subnet_cidrs	Addressable CIDRs for the availability zones' private subnets	list	n/a	yes
create_mongodb_atlas_resources	Set to true to create MongoDB Atlas resources.	bool	false	no
mongodb_atlas_public_key	Public key used to access the MongoDB Atlas API. To be used in conjunction with the create_mongodb_atlas_resources variable	string	""	no
mongodb_atlas_private_key	Private key used to access the MongoDB Atlas API. To be used in conjunction with the create_mongodb_atlas_resources variable	string	""	no
mongodb_atlas_organization_id	MongoDB Atlas organization. To be used in conjunction with the create_mongodb_atlas_resources variable	string	""	no
mongodb_atlas_project_name	MongoDB Atlas project name. To be used in conjunction with the create_mongodb_atlas_resources variable	string	""	no
mongodb_atlas_cluster_disk_size	Disk size for the MongoDB Atlas cluster. To be used in conjunction with the create_mongodb_atlas_resources variable	number	210	no
mongodb_atlas_cluster_disk_iops	Provisioned IOPS for the MongoDB Atlas cluster. To be used in conjunction with the create_mongodb_atlas_resources variable	number	630	no
mongodb_atlas_cluster_instance_size	Instance size for the MongoDB Atlas cluster. To be used in conjunction with the create_mongodb_atlas_resources variable. Documented under providerSettings.instanceSizeName: https://docs.atlas.mongodb.com/reference/api/clusters-create-one/	string	"M40"	no
mongodb_atlas_cluster_aws_region	AWS Region for the MongoDB Atlas cluster. To be used in conjunction with the create_mongodb_atlas_resources variable. Must corelate with the aws_region variable. . Documented under providerSettings.regionName: https://docs.atlas.mongodb.com/reference/api/clusters-create-one/	string	"US_EAST_1"	no
create_elasticache_iam_service_linked_role	Set to true to create an AWS IAM Service Linked Role for Elasticache. Leave false if you want to use your own Redis node or an IAM Service Linked Role already exists for Elasticache	bool	false	no
create_elasticache_redis_node	Set to true to create an AWS Elasticache Redis cluster. Leave false if you want to use your own Redis node	bool	false	no
elasticache_redis_node_type	Node type of the AWS Elasticache Redis cluster. To be used in conjunction with the create_elasticache_redis_node variable. Documented here: https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html	string	"cache.t2.small"	no
create_elasticsearch_iam_service_linked_role	Set to true to create an AWS IAM Service Linked Role for Elasticsearch. Leave false if you want to use your own Elasticsearch cluster or an IAM Service Linked Role already exists for Elasticache	bool	false	no
create_elasticsearch_cluster	Set to true to create an AWS Elasticsearch 6.0 cluster. Leave false if you want to use your own Elasticsearch 6.0 node	bool	false	no
elasticsearch_instance_type	Instance type of the AWS Elasticsearch cluster. To be used in conjunction with the create_elasticsearch_cluster variable. Documented here: https://aws.amazon.com/elasticsearch-service/pricing/	string	"t2.small.elasticsearch"	no
elasticsearch_instance_count	Number of instances in the AWS Elasticsearch cluster. To be used in conjunction with the create_elasticsearch_cluster variable.	number	1	no
elasticsearch_instance_disk_volume_size	Disk volume size of the instances in the AWS Elasticsearch cluster. To be used in conjunction with the create_elasticsearch_cluster variable.	number	20	no

Outputs

Name	Description
mongodb_sns_publish_access_key_id	AWS Access Key ID for MongoDB SNS publish user
mongodb_sns_publish_secret_key	AWS Secret Key for MongoDB SNS publish user
vpc_id	Id of the provisioned AWS VPC
vpc_subnets	Ids of the public subnets provisioned in the VPC
private_vpc_subnets	Ids of the private subnets provisioned in the VPC
redis_cache_nodes	Connection info for the AWS Elasticache Redis nodes.
elasticsearch_endpoint	Connection info for the AWS Elasticsearch cluster.
vpc_security_group	Id of the default security group provisioned for the VPC
mongodb_atlas_user_name	Generated username for MongoDB Atlas
mongodb_atlas_user_password	Generated password for MongoDB Atlas
mongodb_atlas_database_endpoints	Endpoints list for MongoDB Atlas