Merge pull request #4 from craftech-io/release-v1

Release/v1

Author: agustinawortley

.github/workflows/pre-commit.yml

@@ -0,0 +1,27 @@
+name: pipeline to push modules to registry
+on:
+  push:
+    tags:
+      - v*
+env:
+  REGISTRY_HOST: https://registry.craftech.io
+
+jobs:
+  push-to-registry:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: push modules to registry
+        uses: craftech-io/[email protected]
+        with:
+          api-key: ${{ secrets.PRD_API_KEY_REGISTRY }}
+          hostname: ${{ env.REGISTRY_HOST }}
+          namespace: craftech
+          module-name: ${{ github.event.repository.name }}
+          system: aws
+          version: ${{ github.ref_name }}
+          modules-path: modules/
+          lower-terraform-version: "0.99.99"
+          higher-terraform-version: "1.5.6"

.github/workflows/push-to-registry.yml

@@ -92,14 +92,14 @@ module "acm" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.53 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0, <=1.5.5 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.5.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 2.53 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.5.0 |
 
 ## Modules
 

README.md

@@ -0,0 +1,27 @@
+# ---------------------------------------------------------------------------------------------------------------------
+# CONFIGURE OUR AWS CONNECTION
+# ---------------------------------------------------------------------------------------------------------------------
+
+provider "aws" {
+  # The AWS region in which all resources will be created
+  region = var.aws_region
+}
+
+# ---------------------------------------------------------------------------------------------------------------------
+# ACM
+# ---------------------------------------------------------------------------------------------------------------------
+module "acm" {
+  source = "../.."
+
+  create_certificate = var.create_certificate
+  domain_name        = var.domain_name
+  zone_id            = var.zone_id
+
+  # For certificate in private zone, validation has to be by email.
+  validation_method                  = var.validation_method
+  validate_certificate               = var.validate_certificate
+  validation_allow_overwrite_records = var.validation_allow_overwrite_records
+  wait_for_validation                = var.wait_for_validation
+  subject_alternative_names          = var.subject_alternative_names
+  tags                               = var.tags
+}

examples/acm/main.tf

@@ -0,0 +1,32 @@
+# ----------------------------------------------------------------------------------------------------------------------
+# Outputs to implement main module
+# ----------------------------------------------------------------------------------------------------------------------
+output "acm_certificate_arn" {
+  description = "The ARN of the certificate"
+  value       = module.acm.acm_certificate_arn
+}
+
+output "acm_certificate_domain_validation_options" {
+  description = "A list of attributes to feed into other resources to complete certificate validation. Can have more than one element, e.g. if SANs are defined. Only set if DNS-validation was used."
+  value       = module.acm.acm_certificate_domain_validation_options
+}
+
+output "acm_certificate_validation_emails" {
+  description = "A list of addresses that received a validation E-Mail. Only set if EMAIL-validation was used."
+  value       = module.acm.acm_certificate_validation_emails
+}
+
+output "validation_route53_record_fqdns" {
+  description = "List of FQDNs built using the zone domain and name."
+  value       = module.acm.validation_route53_record_fqdns
+}
+
+output "distinct_domain_names" {
+  description = "List of distinct domains names used for the validation."
+  value       = module.acm.distinct_domain_names
+}
+
+output "validation_domains" {
+  description = "List of distinct domain validation options. This is useful if subject alternative names contain wildcards."
+  value       = module.acm.validation_domains
+}

examples/acm/outputs.tf

@@ -0,0 +1,62 @@
+# ----------------------------------------------------------------------------------------------------------------------
+# REQUIRED PARAMETERS
+# ----------------------------------------------------------------------------------------------------------------------
+
+variable "aws_region" {
+  description = "The AWS Region where this VPC will exist."
+  type        = string
+  default     = "us-east-1"
+}
+
+variable "domain_name" {
+  description = "A domain name for which the certificate should be issued"
+  type        = string
+  default     = ""
+}
+
+variable "validate_certificate" {
+  description = "Whether to validate certificate by creating Route53 record"
+  type        = bool
+  default     = true
+}
+
+variable "subject_alternative_names" {
+  description = "A list of domains that should be SANs in the issued certificate"
+  type        = list(string)
+  default     = []
+}
+
+variable "validation_method" {
+  description = "Which method to use for validation. DNS or EMAIL are valid, NONE can be used for certificates that were imported into ACM and then into Terraform."
+  type        = string
+}
+
+variable "zone_id" {
+  description = "The ID of the hosted zone to contain this record."
+  type        = string
+  default     = null
+}
+
+variable "create_certificate" {
+  description = "Whether to create ACM certificate"
+  type        = bool
+  default     = true
+}
+
+variable "validation_allow_overwrite_records" {
+  description = "Whether to allow overwrite of Route53 records"
+  type        = bool
+  default     = true
+}
+
+variable "wait_for_validation" {
+  description = "Whether to wait for the validation to complete"
+  type        = bool
+  default     = true
+}
+
+variable "tags" {
+  description = "A mapping of tags to assign to the resource"
+  type        = map(string)
+  default     = {}
+}

examples/acm/variables.tf

@@ -23,14 +23,14 @@ Note that this example may create resources which cost money. Run `terraform des
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.53 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= >= 1.0.0, <=1.5.5 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.5.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 2.53 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.5.0 |
 
 ## Modules
 

examples/complete-dns-validation/README.md

@@ -36,14 +36,14 @@ Note that this example may create resources which cost money. Run `terraform des
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.53 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= >= 1.0.0, <=1.5.5 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.5.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 2.53 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.5.0 |
 
 ## Modules
 

examples/complete-email-validation/README.md

@@ -1,3 +1,23 @@
+# ----------------------------------------------------------------------------------------------------------------------
+# TERRAFORM VERSION
+# ----------------------------------------------------------------------------------------------------------------------
+
+terraform {
+  required_version = ">= 1.0.0, <=1.5.5"
+
+  # This module has been updated for helm v3 usage. We do not recommend using this version with helm v2.
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "~> 5.5.0"
+    }
+  }
+}
+
+# ---------------------------------------------------------------------------------------------------------------------
+# CREATE ACM CERTIFICATE
+# ---------------------------------------------------------------------------------------------------------------------
+
 locals {
   # Get distinct list of domains and SANs
   distinct_domain_names = distinct(