Skip to content

Commit

Permalink
don't fail if parent_zone_name is not provided (cloudposse#51)
Browse files Browse the repository at this point in the history
* don't fail if parent_zone_name is not provided

* Apply suggestions from code review

* Reconciled with latest master

Co-authored-by: Jon Bogaty <[email protected]>
Co-authored-by: Yonatan Koren <[email protected]>

* PR feedback

* add test with no parent zone

* make number from bools

* Auto Format

* match main

* change region

* upd region

* actually add tests

* fix bool cast

* fix required var

* parent_zone record false

* fix example

Co-authored-by: Jon Bogaty <[email protected]>
Co-authored-by: Yonatan Koren <[email protected]>
Co-authored-by: cloudpossebot <[email protected]>
  • Loading branch information
4 people committed Nov 18, 2022
1 parent f6c942f commit 52a8e39
Show file tree
Hide file tree
Showing 20 changed files with 1,839 additions and 46 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
region = "us-west-1"
region = "us-east-2"

secondary_region = "us-west-2"

namespace = "eg"

Expand Down
44 changes: 42 additions & 2 deletions examples/complete/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,51 @@ provider "aws" {
region = var.region
}

provider "aws" {
alias = "secondary_region"
region = var.secondary_region
}

module "vpc_same_region" {
source = "cloudposse/vpc/aws"
version = "0.28.1"

enabled = module.this.enabled && var.private_zone_test_enabled

cidr_block = "172.16.0.0/16"

context = module.this.context
}

module "vpc_secondary_region" {
providers = {
aws = aws.secondary_region
}

source = "cloudposse/vpc/aws"
version = "0.28.1"

enabled = module.this.enabled && var.private_zone_test_enabled

cidr_block = "172.17.0.0/16"

context = module.this.context
}

module "domain" {
source = "../../"
context = module.this.context
parent_zone_name = var.parent_zone_name
zone_name = "$${name}.$${parent_zone_name}"
ns_record_ttl = var.ns_record_ttl
soa_record_ttl = var.soa_record_ttl

private_hosted_zone_vpc_attachments = var.private_zone_test_enabled ? [
{
vpc_id = module.vpc_same_region.vpc_id
vpc_region = var.region
},
{
vpc_id = module.vpc_secondary_region.vpc_id
vpc_region = var.secondary_region
}
] : []
}
4 changes: 4 additions & 0 deletions examples/complete/outputs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ output "zone_name" {
output "fqdn" {
value = module.domain.fqdn
}

output "type" {
value = module.domain.type
}
13 changes: 13 additions & 0 deletions examples/complete/private-zone.us-west-1.tfvars
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
region = "us-west-1"

secondary_region = "us-west-2"

namespace = "eg"

stage = "test"

name = "private-zone"

parent_zone_name = "testing.cloudposse.co"

private_zone_test_enabled = true
11 changes: 11 additions & 0 deletions examples/complete/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ variable "region" {
description = "AWS region"
}

variable "secondary_region" {
type = string
description = "Second AWS region for testing multi-zone private hosted zone"
}

variable "parent_zone_name" {
type = string
description = "Name of the hosted zone to contain this record (or specify `parent_zone_id`)"
Expand All @@ -17,3 +22,9 @@ variable "soa_record_ttl" {
type = number
description = "The time to live (TTL) of the start of authority Route53 record, in seconds."
}

variable "private_zone_test_enabled" {
type = bool
default = false
description = "Enable or disable the private zone test"
}
279 changes: 279 additions & 0 deletions examples/without_parent_zone/context.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,279 @@
#
# ONLY EDIT THIS FILE IN github.com/cloudposse/terraform-null-label
# All other instances of this file should be a copy of that one
#
#
# Copy this file from https://github.com/cloudposse/terraform-null-label/blob/master/exports/context.tf
# and then place it in your Terraform module to automatically get
# Cloud Posse's standard configuration inputs suitable for passing
# to Cloud Posse modules.
#
# curl -sL https://raw.githubusercontent.com/cloudposse/terraform-null-label/master/exports/context.tf -o context.tf
#
# Modules should access the whole context as `module.this.context`
# to get the input variables with nulls for defaults,
# for example `context = module.this.context`,
# and access individual variables as `module.this.<var>`,
# with final values filled in.
#
# For example, when using defaults, `module.this.context.delimiter`
# will be null, and `module.this.delimiter` will be `-` (hyphen).
#

module "this" {
source = "cloudposse/label/null"
version = "0.25.0" # requires Terraform >= 0.13.0

enabled = var.enabled
namespace = var.namespace
tenant = var.tenant
environment = var.environment
stage = var.stage
name = var.name
delimiter = var.delimiter
attributes = var.attributes
tags = var.tags
additional_tag_map = var.additional_tag_map
label_order = var.label_order
regex_replace_chars = var.regex_replace_chars
id_length_limit = var.id_length_limit
label_key_case = var.label_key_case
label_value_case = var.label_value_case
descriptor_formats = var.descriptor_formats
labels_as_tags = var.labels_as_tags

context = var.context
}

# Copy contents of cloudposse/terraform-null-label/variables.tf here

variable "context" {
type = any
default = {
enabled = true
namespace = null
tenant = null
environment = null
stage = null
name = null
delimiter = null
attributes = []
tags = {}
additional_tag_map = {}
regex_replace_chars = null
label_order = []
id_length_limit = null
label_key_case = null
label_value_case = null
descriptor_formats = {}
# Note: we have to use [] instead of null for unset lists due to
# https://github.com/hashicorp/terraform/issues/28137
# which was not fixed until Terraform 1.0.0,
# but we want the default to be all the labels in `label_order`
# and we want users to be able to prevent all tag generation
# by setting `labels_as_tags` to `[]`, so we need
# a different sentinel to indicate "default"
labels_as_tags = ["unset"]
}
description = <<-EOT
Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as `null` to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
EOT

validation {
condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"])
error_message = "Allowed values: `lower`, `title`, `upper`."
}

validation {
condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"])
error_message = "Allowed values: `lower`, `title`, `upper`, `none`."
}
}

variable "enabled" {
type = bool
default = null
description = "Set to false to prevent the module from creating any resources"
}

variable "namespace" {
type = string
default = null
description = "ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique"
}

variable "tenant" {
type = string
default = null
description = "ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for"
}

variable "environment" {
type = string
default = null
description = "ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'"
}

variable "stage" {
type = string
default = null
description = "ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'"
}

variable "name" {
type = string
default = null
description = <<-EOT
ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a `tag`.
The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.
EOT
}

variable "delimiter" {
type = string
default = null
description = <<-EOT
Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.
EOT
}

variable "attributes" {
type = list(string)
default = []
description = <<-EOT
ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the `delimiter`
and treated as a single ID element.
EOT
}

variable "labels_as_tags" {
type = set(string)
default = ["default"]
description = <<-EOT
Set of labels (ID elements) to include as tags in the `tags` output.
Default is to include all labels.
Tags with empty values will not be included in the `tags` output.
Set to `[]` to suppress all generated tags.
**Notes:**
The value of the `name` tag, if included, will be the `id`, not the `name`.
Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
EOT
}

variable "tags" {
type = map(string)
default = {}
description = <<-EOT
Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
Neither the tag keys nor the tag values will be modified by this module.
EOT
}

variable "additional_tag_map" {
type = map(string)
default = {}
description = <<-EOT
Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
EOT
}

variable "label_order" {
type = list(string)
default = null
description = <<-EOT
The order in which the labels (ID elements) appear in the `id`.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
EOT
}

variable "regex_replace_chars" {
type = string
default = null
description = <<-EOT
Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.
EOT
}

variable "id_length_limit" {
type = number
default = null
description = <<-EOT
Limit `id` to this many characters (minimum 6).
Set to `0` for unlimited length.
Set to `null` for keep the existing setting, which defaults to `0`.
Does not affect `id_full`.
EOT
validation {
condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0
error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length."
}
}

variable "label_key_case" {
type = string
default = null
description = <<-EOT
Controls the letter case of the `tags` keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper`.
Default value: `title`.
EOT

validation {
condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case)
error_message = "Allowed values: `lower`, `title`, `upper`."
}
}

variable "label_value_case" {
type = string
default = null
description = <<-EOT
Controls the letter case of ID elements (labels) as included in `id`,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper` and `none` (no transformation).
Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.
Default value: `lower`.
EOT

validation {
condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case)
error_message = "Allowed values: `lower`, `title`, `upper`, `none`."
}
}

variable "descriptor_formats" {
type = any
default = {}
description = <<-EOT
Describe additional descriptors to be output in the `descriptors` output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
`{
format = string
labels = list(string)
}`
(Type is `any` so the map values can later be enhanced to provide additional options.)
`format` is a Terraform format string to be passed to the `format()` function.
`labels` is a list of labels, in order, to pass to `format()` function.
Label values will be normalized before being passed to `format()` so they will be
identical to how they appear in `id`.
Default is `{}` (`descriptors` output will be empty).
EOT
}

#### End of copy of cloudposse/terraform-null-label/variables.tf
9 changes: 9 additions & 0 deletions examples/without_parent_zone/fixtures.us-east-2.tfvars
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
region = "us-east-2"

namespace = "eg"

stage = "test"

name = "hosted_zone_no_parent_record"

zone_name = "testing.cloudposse.co"
Loading

0 comments on commit 52a8e39

Please sign in to comment.