feat: aws elasticache redis service

Author: shanewxy

Makefile

@@ -18,14 +18,14 @@ help:
 	# Usage:
 	#
 	#   * [dev] `make generate`, generate README file.
-	#           - `make generate examples/hello-world` only generate README file under examples/hello-world directory.
+	#           - `make generate examples/standalone` only generate README file under examples/standalone directory.
 	#
 	#   * [dev] `make lint`, check style and security.
 	#           - `LINT_DIRTY=true make lint` verify whether the code tree is dirty.
-	#           - `make lint examples/hello-world` only verify the code under examples/hello-world directory.
+	#           - `make lint examples/standalone` only verify the code under examples/standalone directory.
 	#
 	#   * [dev] `make test`, execute unit testing.
-	#           - `make test example/hello-world` only test the code under examples/hello-world directory.
+	#           - `make test example/standalone` only test the code under examples/standalone directory.
 	#
 	#   * [ci]  `make ci`, execute `make generate`, `make lint` and `make test`.
 	#

README.md

@@ -1,17 +1,28 @@
-# Awesome Walrus Template
+# AWS Elasticache Redis Template
 
-Start here to create an awesome Walrus template.
+Terraform module which deploys [Elasticache Redis](https://aws.amazon.com/elasticache/redis/) on AWS.
 
 ## Usage
 
 ```hcl
-
+module "example" {
+  source = "..."
+
+  infrastructure = {
+    vpc_id        = "..."
+    kms_key_id    = "..."
+    domain_suffix = "..."
+  }
+
+  architecture   = "standalone"
+  engine_version = "7.0"
+}
 ```
 
 ## Examples
 
-- ...
-- ...
+- [Replication](./examples/replication)
+- [Standalone](./examples/standalone)
 
 ## Contributing
 
@@ -23,38 +34,61 @@ Please read our [contributing guide](./docs/CONTRIBUTING.md) if you're intereste
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.24.0 |
+| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.5.1 |
 
 ## Providers
 
-No providers.
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.24.0 |
+| <a name="provider_random"></a> [random](#provider\_random) | >= 3.5.1 |
 
 ## Modules
 
-| Name | Source | Version |
-|------|--------|---------|
-| <a name="module_submodule"></a> [submodule](#module\_submodule) | ./modules/submodule | n/a |
+No modules.
 
 ## Resources
 
-No resources.
+| Name | Type |
+|------|------|
+| [aws_elasticache_parameter_group.target](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_parameter_group) | resource |
+| [aws_elasticache_replication_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_replication_group) | resource |
+| [aws_elasticache_subnet_group.target](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_subnet_group) | resource |
+| [aws_security_group.target](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
+| [aws_security_group_rule.target](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |
+| [aws_service_discovery_instance.primary](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_instance) | resource |
+| [aws_service_discovery_instance.reader](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_instance) | resource |
+| [aws_service_discovery_service.primary](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_service) | resource |
+| [aws_service_discovery_service.reader](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_service) | resource |
+| [random_password.password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
+| [random_string.name_suffix](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |
+| [aws_kms_key.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_key) | data source |
+| [aws_service_discovery_dns_namespace.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/service_discovery_dns_namespace) | data source |
+| [aws_subnets.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnets) | data source |
+| [aws_vpc.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_context"></a> [context](#input\_context) | Receive contextual information. When Walrus deploys, Walrus will inject specific contextual information into this field.<br><br>Examples:<pre>context:<br>  project:<br>    name: string<br>    id: string<br>  environment:<br>    name: string<br>    id: string<br>  resource:<br>    name: string<br>    id: string</pre> | `map(any)` | `{}` | no |
+| <a name="input_infrastructure"></a> [infrastructure](#input\_infrastructure) | Specify the infrastructure information for deploying.<br><br>Examples:<pre>infrastructure:<br>  vpc_id: string                  # the ID of the VPC where the MySQL service applies<br>  kms_key_id: sting,optional      # the ID of the KMS key which to encrypt the MySQL data<br>  domain_suffix: string           # a private DNS namespace of the CloudMap where to register the applied MySQL service</pre> | <pre>object({<br>    vpc_id        = string<br>    kms_key_id    = optional(string)<br>    domain_suffix = string<br>  })</pre> | n/a | yes |
+| <a name="input_architecture"></a> [architecture](#input\_architecture) | Specify the deployment architecture, select from standalone or replication. | `string` | `"standalone"` | no |
+| <a name="input_engine_version"></a> [engine\_version](#input\_engine\_version) | Specify the deployment engine version. | `string` | `"7.0"` | no |
+| <a name="input_engine_parameters"></a> [engine\_parameters](#input\_engine\_parameters) | Specify the deployment parameters. | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |
+| <a name="input_password"></a> [password](#input\_password) | Specify the account password. | `string` | `null` | no |
+| <a name="input_resources"></a> [resources](#input\_resources) | Specify the computing resources.<br>Examples:<pre>resources:<br>  nodeType: string, optional      # https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html</pre> | <pre>object({<br>    nodeType = optional(string, "cache.t2.micro")<br>  })</pre> | <pre>{<br>  "nodeType": "cache.t2.micro"<br>}</pre> | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| <a name="output_walrus_project_name"></a> [walrus\_project\_name](#output\_walrus\_project\_name) | The name of project where deployed in Walrus. |
-| <a name="output_walrus_project_id"></a> [walrus\_project\_id](#output\_walrus\_project\_id) | The id of project where deployed in Walrus. |
-| <a name="output_walrus_environment_name"></a> [walrus\_environment\_name](#output\_walrus\_environment\_name) | The name of environment where deployed in Walrus. |
-| <a name="output_walrus_environment_id"></a> [walrus\_environment\_id](#output\_walrus\_environment\_id) | The id of environment where deployed in Walrus. |
-| <a name="output_walrus_resource_name"></a> [walrus\_resource\_name](#output\_walrus\_resource\_name) | The name of resource where deployed in Walrus. |
-| <a name="output_walrus_resource_id"></a> [walrus\_resource\_id](#output\_walrus\_resource\_id) | The id of resource where deployed in Walrus. |
-| <a name="output_submodule"></a> [submodule](#output\_submodule) | The message from submodule. |
+| <a name="output_context"></a> [context](#output\_context) | The input context, a map, which is used for orchestration. |
+| <a name="output_selector"></a> [selector](#output\_selector) | The selector, a map, which is used for dependencies or collaborations. |
+| <a name="output_endpoint_internal"></a> [endpoint\_internal](#output\_endpoint\_internal) | The internal endpoints, a string list, which are used for internal access. |
+| <a name="output_endpoint_internal_readonly"></a> [endpoint\_internal\_readonly](#output\_endpoint\_internal\_readonly) | The internal readonly endpoints, a string list, which are used for internal readonly access. |
+| <a name="output_password"></a> [password](#output\_password) | The password of redis service. |
 <!-- END_TF_DOCS -->
 
 ## License

examples/hello-world/README.md

@@ -0,0 +1,63 @@
+# Replication Example
+
+Deploy Redis service in replication architecture by root module.
+
+```bash
+# setup infra
+$ terraform apply -auto-approve \
+  -target=aws_vpc.example \
+  -target=aws_subnet.example \
+  -target=aws_kms_key.example \
+  -target=aws_service_discovery_private_dns_namespace.example
+
+# create service
+$ terraform apply -auto-approve
+```
+
+<!-- BEGIN_TF_DOCS -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.24.0 |
+| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.5.1 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.24.0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_this"></a> [this](#module\_this) | ../.. | n/a |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_internet_gateway.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/internet_gateway) | resource |
+| [aws_kms_key.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) | resource |
+| [aws_route.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route) | resource |
+| [aws_service_discovery_private_dns_namespace.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_private_dns_namespace) | resource |
+| [aws_subnet.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/subnet) | resource |
+| [aws_vpc.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc) | resource |
+| [aws_availability_zones.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_context"></a> [context](#output\_context) | n/a |
+| <a name="output_selector"></a> [selector](#output\_selector) | n/a |
+| <a name="output_endpoint_internal"></a> [endpoint\_internal](#output\_endpoint\_internal) | n/a |
+| <a name="output_endpoint_internal_readonly"></a> [endpoint\_internal\_readonly](#output\_endpoint\_internal\_readonly) | n/a |
+| <a name="output_password"></a> [password](#output\_password) | n/a |
+<!-- END_TF_DOCS -->

examples/hello-world/main.tf

@@ -0,0 +1,111 @@
+terraform {
+  required_version = ">= 1.0"
+
+  required_providers {
+    random = {
+      source  = "hashicorp/random"
+      version = ">= 3.5.1"
+    }
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 5.24.0"
+    }
+  }
+}
+
+provider "aws" {}
+
+data "aws_availability_zones" "selected" {
+  state = "available"
+
+  lifecycle {
+    postcondition {
+      condition     = length(self.names) > 0
+      error_message = "Failed to get Avaialbe Zones"
+    }
+  }
+}
+
+# create vpc.
+
+resource "aws_vpc" "example" {
+  instance_tenancy     = "default"
+  enable_dns_hostnames = true
+  enable_dns_support   = true
+  cidr_block           = "10.0.0.0/16"
+}
+
+resource "aws_subnet" "example" {
+  for_each = {
+    for k, v in data.aws_availability_zones.selected.names : v => cidrsubnet(aws_vpc.example.cidr_block, 8, k)
+  }
+
+  vpc_id            = aws_vpc.example.id
+  availability_zone = each.key
+  cidr_block        = each.value
+}
+
+#resource "aws_internet_gateway" "example" {
+#  vpc_id = aws_vpc.example.id
+#}
+#
+#resource "aws_route" "example" {
+#  destination_cidr_block = "0.0.0.0/0"
+#  route_table_id         = aws_vpc.example.default_route_table_id
+#  gateway_id             = aws_internet_gateway.example.id
+#}
+
+# create kms key.
+
+resource "aws_kms_key" "example" {
+  key_usage                = "ENCRYPT_DECRYPT"
+  customer_master_key_spec = "SYMMETRIC_DEFAULT"
+  deletion_window_in_days  = 7
+  is_enabled               = true
+  enable_key_rotation      = false
+  multi_region             = true
+  description              = "redis-encryption"
+}
+
+# create private dns.
+
+resource "aws_service_discovery_private_dns_namespace" "example" {
+  name = "example-dev-dns"
+  vpc  = aws_vpc.example.id
+}
+
+# create mysql service.
+
+module "this" {
+  source = "../.."
+
+  infrastructure = {
+    vpc_id        = aws_vpc.example.id
+    kms_key_id    = aws_kms_key.example.id
+    domain_suffix = aws_service_discovery_private_dns_namespace.example.name
+  }
+
+  architecture = "replication"
+
+  depends_on = [aws_service_discovery_private_dns_namespace.example]
+}
+
+output "context" {
+  value = module.this.context
+}
+
+output "selector" {
+  value = module.this.selector
+}
+
+output "endpoint_internal" {
+  value = module.this.endpoint_internal
+}
+
+output "endpoint_internal_readonly" {
+  value = module.this.endpoint_internal_readonly
+}
+
+output "password" {
+  value = nonsensitive(module.this.password)
+}