feat: Add support for setting purpose, network_tier, prefix_length, and ip_version (#29)

Author: konstantin-recurly

README.md

@@ -178,27 +178,30 @@ dreaded `value of 'count' cannot be computed` error. Future versions of
 Terraform may change this fact, but this is the current limitation.
 
 [^]: (autogen_docs_start)
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| address\_type | The type of address to reserve, either "INTERNAL" or "EXTERNAL". If unspecified, defaults to "INTERNAL". | string | `"INTERNAL"` | no |
-| addresses | A list of IP addresses to create.  GCP will reserve unreserved addresses if given the value "".  If multiple names are given the default value is sufficient to have multiple addresses automatically picked for each name. | list | `<list>` | no |
-| dns\_domain | The domain to append to DNS short names when registering in Cloud DNS. | string | `""` | no |
-| dns\_managed\_zone | The name of the managed zone to create records within.  This managed zone must exist in the host project. | string | `""` | no |
-| dns\_project | The project where DNS A records will be configured. | string | `""` | no |
-| dns\_record\_type | The type of records to create in the managed zone.  (e.g. "A") | string | `"A"` | no |
-| dns\_reverse\_zone | The name of the managed zone to create PTR records within.  This managed zone must exist in the host project. | string | `""` | no |
-| dns\_short\_names | A list of DNS short names to register within Cloud DNS.  Names corresponding to addresses must align by their list index position in the two input variables, `names` and `dns_short_names`.  If an empty list, no domain names are registered.  Multiple names may be registered to the same address by passing a single element list to names and multiple elements to dns_short_names.  (e.g. ["gusw1-dev-fooapp-fe-0001-a-001"]) | list | `<list>` | no |
-| dns\_ttl | The DNS TTL in seconds for records created in Cloud DNS.  The default value should be used unless the application demands special handling. | string | `"300"` | no |
-| enable\_cloud\_dns | If a value is set, register records in Cloud DNS. | string | `""` | no |
-| enable\_reverse\_dns | If a value is set, register reverse DNS PTR records in Cloud DNS in the managed zone specified by dns_reverse_zone | string | `""` | no |
-| global | The scope in which the address should live. If set to true, the IP address will be globally scoped. Defaults to false, i.e. regionally scoped. When set to true, do not provide a subnetwork. | string | `"false"` | no |
-| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | list | `<list>` | no |
-| project\_id | The project ID to create the address in | string | n/a | yes |
-| region | The region to create the address in | string | n/a | yes |
-| subnetwork | The subnet containing the address.  For EXTERNAL addresses use the empty string, "".  (e.g. "projects/<project-name>/regions/<region-name>/subnetworks/<subnetwork-name>") | string | `""` | no |
+|------|-------------|------|---------|:--------:|
+| address\_type | The type of address to reserve, either "INTERNAL" or "EXTERNAL". If unspecified, defaults to "INTERNAL". | `string` | `"INTERNAL"` | no |
+| addresses | A list of IP addresses to create.  GCP will reserve unreserved addresses if given the value "".  If multiple names are given the default value is sufficient to have multiple addresses automatically picked for each name. | `list(string)` | <pre>[<br>  ""<br>]</pre> | no |
+| dns\_domain | The domain to append to DNS short names when registering in Cloud DNS. | `string` | `""` | no |
+| dns\_managed\_zone | The name of the managed zone to create records within.  This managed zone must exist in the host project. | `string` | `""` | no |
+| dns\_project | The project where DNS A records will be configured. | `string` | `""` | no |
+| dns\_record\_type | The type of records to create in the managed zone.  (e.g. "A") | `string` | `"A"` | no |
+| dns\_reverse\_zone | The name of the managed zone to create PTR records within.  This managed zone must exist in the host project. | `string` | `""` | no |
+| dns\_short\_names | A list of DNS short names to register within Cloud DNS.  Names corresponding to addresses must align by their list index position in the two input variables, `names` and `dns_short_names`.  If an empty list, no domain names are registered.  Multiple names may be registered to the same address by passing a single element list to names and multiple elements to dns\_short\_names.  (e.g. ["gusw1-dev-fooapp-fe-0001-a-001"]) | `list(string)` | `[]` | no |
+| dns\_ttl | The DNS TTL in seconds for records created in Cloud DNS.  The default value should be used unless the application demands special handling. | `number` | `300` | no |
+| enable\_cloud\_dns | If a value is set, register records in Cloud DNS. | `bool` | `false` | no |
+| enable\_reverse\_dns | If a value is set, register reverse DNS PTR records in Cloud DNS in the managed zone specified by dns\_reverse\_zone | `bool` | `false` | no |
+| global | The scope in which the address should live. If set to true, the IP address will be globally scoped. Defaults to false, i.e. regionally scoped. When set to true, do not provide a subnetwork. | `bool` | `false` | no |
+| ip\_version | The IP Version that will be used by this address. | `string` | `"IPV4"` | no |
+| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | `list(string)` | `[]` | no |
+| network\_tier | The networking tier used for configuring this address. | `string` | `"PREMIUM"` | no |
+| prefix\_length | The prefix length of the IP range. | `number` | `16` | no |
+| project\_id | The project ID to create the address in | `string` | n/a | yes |
+| purpose | The purpose of the resource(GCE\_ENDPOINT, SHARED\_LOADBALANCER\_VIP, VPC\_PEERING). | `string` | `"GCE_ENDPOINT"` | no |
+| region | The region to create the address in | `string` | n/a | yes |
+| subnetwork | The subnet containing the address.  For EXTERNAL addresses use the empty string, "".  (e.g. "projects/<project-name>/regions/<region-name>/subnetworks/<subnetwork-name>") | `string` | `""` | no |
 
 ## Outputs
 
@@ -208,7 +211,7 @@ Terraform may change this fact, but this is the current limitation.
 | dns\_fqdns | List of DNS fully qualified domain names registered in Cloud DNS.  (e.g. ["gusw1-dev-fooapp-fe-0001-a-001.example.com", "gusw1-dev-fooapp-fe-0001-a-0002.example.com"]) |
 | names | List of address resource names managed by this module (e.g. ["gusw1-dev-fooapp-fe-0001-a-0001-ip"]) |
 | reverse\_dns\_fqdns | List of reverse DNS PTR records registered in Cloud DNS.  (e.g. ["1.2.11.10.in-addr.arpa", "2.2.11.10.in-addr.arpa"]) |
-| self\_links | List of URIs of the created address resources (e.g. ["https://www.googleapis.com/compute/v1/projects/project-abcde/regions/europe-west1/addresses/gusw1-dev-fooapp-fe-0001-a-0001-ip"] |
+| self\_links | List of URIs of the created address resources |
 
 [^]: (autogen_docs_end)
 

examples/dns_forward_and_reverse/README.md

@@ -5,20 +5,19 @@ time, and how to enable the Google Cloud DNS registration functionality for
 both forward and reverse DNS lookup zones.
 
 [^]: (autogen_docs_start)
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| dns\_domain | The name of the domain to be registered with Cloud DNS | string | n/a | yes |
-| dns\_managed\_zone | The name of the managed zone to create records within.  This managed zone must exist in the host project. | string | n/a | yes |
-| dns\_project | The project where DNS A records will be configured. | string | n/a | yes |
-| dns\_reverse\_zone | The name of the managed zone to create PTR records within.  This managed zone must exist in the host project. | string | n/a | yes |
-| dns\_short\_names | A list of DNS short names to register within Cloud DNS.  Names corresponding to addresses must align by their list index position in the two input variables, `names` and `dns_short_names`.  If an empty list, no domain names are registered.  Multiple names may be registered to the same address by passing a single element list to names and multiple elements to dns_short_names.  (e.g. ["gusw1-dev-fooapp-fe-0001-a-001"]) | list | n/a | yes |
-| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | list | n/a | yes |
-| project\_id | The project ID to deploy to | string | n/a | yes |
-| region | The region to deploy to | string | n/a | yes |
-| subnetwork | The subnet containing the address.  For EXTERNAL addresses use the empty string, "".  (e.g. "projects/<project-name>/regions/<region-name>/subnetworks/<subnetwork-name>") | string | n/a | yes |
+|------|-------------|------|---------|:--------:|
+| dns\_domain | The name of the domain to be registered with Cloud DNS | `string` | n/a | yes |
+| dns\_managed\_zone | The name of the managed zone to create records within.  This managed zone must exist in the host project. | `string` | n/a | yes |
+| dns\_project | The project where DNS A records will be configured. | `string` | n/a | yes |
+| dns\_reverse\_zone | The name of the managed zone to create PTR records within.  This managed zone must exist in the host project. | `string` | n/a | yes |
+| dns\_short\_names | A list of DNS short names to register within Cloud DNS.  Names corresponding to addresses must align by their list index position in the two input variables, `names` and `dns_short_names`.  If an empty list, no domain names are registered.  Multiple names may be registered to the same address by passing a single element list to names and multiple elements to dns\_short\_names.  (e.g. ["gusw1-dev-fooapp-fe-0001-a-001"]) | `list(string)` | n/a | yes |
+| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | `list(string)` | n/a | yes |
+| project\_id | The project ID to deploy to | `string` | n/a | yes |
+| region | The region to deploy to | `string` | n/a | yes |
+| subnetwork | The subnet containing the address.  For EXTERNAL addresses use the empty string, "".  (e.g. "projects/<project-name>/regions/<region-name>/subnetworks/<subnetwork-name>") | `string` | n/a | yes |
 
 ## Outputs
 

examples/dns_forward_example/README.md

@@ -6,19 +6,18 @@ will register the IP addresses and their corresponding DNS names with Google
 Cloud DNS.
 
 [^]: (autogen_docs_start)
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| dns\_domain | The name of the domain to be registered with Cloud DNS | string | n/a | yes |
-| dns\_managed\_zone | The name of the managed zone to create records within.  This managed zone must exist in the host project. | string | n/a | yes |
-| dns\_project | The project where DNS A records will be configured. | string | n/a | yes |
-| dns\_short\_names | A list of DNS short names to register within Cloud DNS.  Names corresponding to addresses must align by their list index position in the two input variables, `names` and `dns_short_names`.  If an empty list, no domain names are registered.  Multiple names may be registered to the same address by passing a single element list to names and multiple elements to dns_short_names.  (e.g. ["gusw1-dev-fooapp-fe-0001-a-001"]) | list | n/a | yes |
-| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | list | n/a | yes |
-| project\_id | The project ID to deploy to | string | n/a | yes |
-| region | The region to deploy to | string | n/a | yes |
-| subnetwork | The subnet containing the address.  For EXTERNAL addresses use the empty string, "".  (e.g. "projects/<project-name>/regions/<region-name>/subnetworks/<subnetwork-name>") | string | n/a | yes |
+|------|-------------|------|---------|:--------:|
+| dns\_domain | The name of the domain to be registered with Cloud DNS | `string` | n/a | yes |
+| dns\_managed\_zone | The name of the managed zone to create records within.  This managed zone must exist in the host project. | `string` | n/a | yes |
+| dns\_project | The project where DNS A records will be configured. | `string` | n/a | yes |
+| dns\_short\_names | A list of DNS short names to register within Cloud DNS.  Names corresponding to addresses must align by their list index position in the two input variables, `names` and `dns_short_names`.  If an empty list, no domain names are registered.  Multiple names may be registered to the same address by passing a single element list to names and multiple elements to dns\_short\_names.  (e.g. ["gusw1-dev-fooapp-fe-0001-a-001"]) | `list(string)` | n/a | yes |
+| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | `list(string)` | n/a | yes |
+| project\_id | The project ID to deploy to | `string` | n/a | yes |
+| region | The region to deploy to | `string` | n/a | yes |
+| subnetwork | The subnet containing the address.  For EXTERNAL addresses use the empty string, "".  (e.g. "projects/<project-name>/regions/<region-name>/subnetworks/<subnetwork-name>") | `string` | n/a | yes |
 
 ## Outputs
 

examples/ip_address_only/README.md

@@ -5,15 +5,14 @@ dynamically assigned by GCP. Outputs have been provided to list the address
 itself as well as the resource name that corresponds.
 
 [^]: (autogen_docs_start)
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | list | n/a | yes |
-| project\_id | The project ID to deploy to | string | n/a | yes |
-| region | The region to deploy to | string | n/a | yes |
-| subnetwork | The subnetwork on which the IP address will be reserved | string | n/a | yes |
+|------|-------------|------|---------|:--------:|
+| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | `list(string)` | n/a | yes |
+| project\_id | The project ID to deploy to | `string` | n/a | yes |
+| region | The region to deploy to | `string` | n/a | yes |
+| subnetwork | The subnetwork on which the IP address will be reserved | `string` | n/a | yes |
 
 ## Outputs
 

examples/ip_address_with_specific_ip/README.md

@@ -4,16 +4,15 @@ This example illustrates how to reserve a specific IP address (instead of
 allowing GCP to dynamically assign it from the subnet provided).
 
 [^]: (autogen_docs_start)
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| addresses | A list of IP addresses to create.  GCP will reserve unreserved addresses if given the value "".  If multiple names are given the default value is sufficient to have multiple addresses automatically picked for each name. | list | n/a | yes |
-| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | list | n/a | yes |
-| project\_id | The project ID to deploy to | string | n/a | yes |
-| region | The region to deploy to | string | n/a | yes |
-| subnetwork | The subnetwork on which the IP address will be reserved | string | n/a | yes |
+|------|-------------|------|---------|:--------:|
+| addresses | A list of IP addresses to create.  GCP will reserve unreserved addresses if given the value "".  If multiple names are given the default value is sufficient to have multiple addresses automatically picked for each name. | `list(string)` | n/a | yes |
+| names | A list of IP address resource names to create.  This is the GCP resource name and not the associated hostname of the IP address.  Existing resource names may be found with `gcloud compute addresses list` (e.g. ["gusw1-dev-fooapp-fe-0001-a-001-ip"]) | `list(string)` | n/a | yes |
+| project\_id | The project ID to deploy to | `string` | n/a | yes |
+| region | The region to deploy to | `string` | n/a | yes |
+| subnetwork | The subnetwork on which the IP address will be reserved | `string` | n/a | yes |
 
 ## Outputs
 

main.tf

@@ -38,6 +38,7 @@ locals {
     google_compute_global_address.global_ip.*.self_link,
   )
   dns_ptr_fqdns = data.template_file.ptrs.*.rendered
+  prefix_length = var.address_type == "EXTERNAL" || (var.address_type == "INTERNAL" && var.purpose == "PRIVATE_SERVICE_CONNECT") ? null : var.prefix_length
 }
 
 resource "null_resource" "dns_args_missing" {
@@ -83,12 +84,20 @@ resource "google_compute_address" "ip" {
   address      = element(var.addresses, count.index)
   subnetwork   = var.subnetwork
   address_type = var.address_type
+  purpose      = var.address_type == "INTERNAL" ? var.purpose : null
+  network_tier = var.address_type == "INTERNAL" ? null : var.network_tier
 }
 
 resource "google_compute_global_address" "global_ip" {
-  count   = local.global_addresses_count
-  project = var.project_id
-  name    = var.names[count.index]
+  count         = local.global_addresses_count
+  project       = var.project_id
+  name          = var.names[count.index]
+  address_type  = var.address_type
+  address       = element(var.addresses, count.index)
+  network       = var.address_type == "EXTERNAL" ? null : var.subnetwork
+  purpose       = var.global && var.address_type == "INTERNAL" ? "VPC_PEERING" : null
+  prefix_length = local.prefix_length
+  ip_version    = var.ip_version
 }
 
 /******************************************

variables.tf

@@ -106,3 +106,26 @@ variable "enable_reverse_dns" {
   default     = false
 }
 
+variable "purpose" {
+  type        = string
+  description = "The purpose of the resource(GCE_ENDPOINT, SHARED_LOADBALANCER_VIP, VPC_PEERING)."
+  default     = "GCE_ENDPOINT"
+}
+
+variable "network_tier" {
+  type        = string
+  description = "The networking tier used for configuring this address."
+  default     = "PREMIUM"
+}
+
+variable "prefix_length" {
+  type        = number
+  description = "The prefix length of the IP range."
+  default     = 16
+}
+
+variable "ip_version" {
+  type        = string
+  description = "The IP Version that will be used by this address."
+  default     = "IPV4"
+}