https://github.com/terraform-google-modules/terraform-google-address

Manages Google Cloud IP addresses
https://github.com/terraform-google-modules/terraform-google-address
cft-terraform networking
Last synced: 2 months ago
JSON representation
Manages Google Cloud IP addresses
Host: GitHub
URL: https://github.com/terraform-google-modules/terraform-google-address
Owner: terraform-google-modules
License: apache-2.0
Created: 2018-12-14T16:56:54.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2025-03-28T20:20:26.000Z (2 months ago)
Last Synced: 2025-03-28T21:26:10.730Z (2 months ago)
Topics: cft-terraform, networking
Language: Shell
Homepage: https://registry.terraform.io/modules/terraform-google-modules/address/google
Size: 493 KB
Stars: 67
Watchers: 33
Forks: 48
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project

README

        # [Google Address Terraform Module](https://registry.terraform.io/modules/terraform-google-modules/address/google/)

This terraform module provides the means to permanently reserve an [IP address](https://cloud.google.com/compute/docs/ip-addresses/)

available to Google Cloud Platform (GCP) resources, and optionally create

forward and reverse entries within Google Cloud DNS. The intent is to provide an

address resource which exists independent of the lifecycle of the resources

that require the address.

## Compatibility

This module is meant for use with Terraform 0.13. If you haven't

[upgraded](https://www.terraform.io/upgrade-guides/0-13.html) and need a Terraform

0.12.x-compatible version of this module, the last released version

intended for Terraform 0.12.x is [v2.1.1](https://registry.terraform.io/modules/terraform-google-modules/-address/google/v2.1.1).

## Examples without DNS

Examples are provided in the `examples` folder, but to simply reserve IP

addresses on a subnetwork without registering them in DNS refer to the

following example:

```hcl

module "address-fe" {

  source  = "terraform-google-modules/address/google"

  version = "~> 4.1"

  project_id = "gcp-network"

  region = "us-west1"

  subnetwork = "projects/gcp-network/regions/us-west1/subnetworks/dev-us-west1-dynamic"

  names = [

    "gusw1-dev-fooapp-fe-0001-a-001-ip",

    "gusw1-dev-fooapp-fe-0001-a-002-ip",

    "gusw1-dev-fooapp-fe-0001-a-003-ip"

  ]

}

```

Then perform the following commands on the root folder:

- `terraform init` to get the plugins

- `terraform plan` to see the infrastructure plan

- `terraform apply` to apply the infrastructure build

- `terraform destroy` to destroy the built infrastructure

An `addresses` output has been provided as the list of IP addresses that were

reserved by GCP. Because the `addresses` input variable was not specified, GCP has

reserved the next available IP addresses from the subnetwork provided. The number

of IP addresses reserved is equal to the length of the `names` input

variable, so size that list accordingly.

If you would prefer to provide the specific IP addresses to be reserved, that can be accomplished with the `addresses` input variable:

```hcl

module "address-fe" {

  source  = "terraform-google-modules/address/google"

  version = "~> 3.1"

  subnetwork = "projects/gcp-network/regions/us-west1/subnetworks/dev-us-west1-dynamic"

  names = [

    "gusw1-dev-fooapp-fe-0001-a-001-ip",

    "gusw1-dev-fooapp-fe-0001-a-002-ip",

    "gusw1-dev-fooapp-fe-0001-a-003-ip"

  ]

  addresses = [

    "10.11.0.10",

    "10.11.0.11",

    "10.11.0.12"

  ]

}

```

Note that the IP addresses must not be reserved and must fall within the range of the provided subnetwork.

### External IP address

External IP addresses can be reserved by setting the `global` input var to `true` and omitting the subnetwork:

```hcl

module "address-fe" {

  source  = "terraform-google-modules/address/google"

  version = "~> 3.1"

  names  = ["external-facing-ip"]

  global = true

}

```

## DNS Examples

Optionally, the IP addresses you reserve can be registered in Google Cloud

DNS by providing information on the project hosting the Cloud DNS zone, the

managed zone name, the domain registered with Cloud DNS, and setting the

`enable_cloud_dns` feature flag to `true`:

```hcl

module "address-fe" {

  source  = "terraform-google-modules/address/google"

  version = "~> 3.1"

  subnetwork           = "projects/gcp-network/regions/us-west1/subnetworks/dev-us-west1-dynamic"

  enable_cloud_dns     = true

  dns_project          = "gcp-dns"

  dns_domain           = "example.com"

  dns_managed_zone     = "nonprod-dns-zone"

  names = [

    "gusw1-dev-fooapp-fe-0001-a-001-ip",

    "gusw1-dev-fooapp-fe-0001-a-002-ip",

    "gusw1-dev-fooapp-fe-0001-a-003-ip"

  ]

  dns_short_names = [

    "gusw1-dev-fooapp-fe-0001-a-001",

    "gusw1-dev-fooapp-fe-0001-a-002",

    "gusw1-dev-fooapp-fe-0001-a-003"

  ]

}

```

### Reverse DNS

The module also supports the ability to register reverse DNS entries within

their own zone by setting the `enable_gcp_ptr` feature flag to `true` and

specifying the zone with the `dns_reverse_zone` input variable:

```hcl

module "address-fe" {

  source  = "terraform-google-modules/address/google"

  version = "~> 3.1"

  subnetwork           = "projects/gcp-network/regions/us-west1/subnetworks/dev-us-west1-dynamic"

  enable_cloud_dns     = true

  enable_gcp_ptr       = true

  dns_project          = "gcp-dns"

  dns_domain           = "example.com"

  dns_managed_zone     = "nonprod-dns-zone"

  dns_reverse_zone     = "nonprod-dns-reverse-zone"

  names = [

    "gusw1-dev-fooapp-fe-0001-a-001-ip",

    "gusw1-dev-fooapp-fe-0001-a-002-ip",

    "gusw1-dev-fooapp-fe-0001-a-003-ip"

  ]

  dns_short_names = [

    "gusw1-dev-fooapp-fe-0001-a-001",

    "gusw1-dev-fooapp-fe-0001-a-002",

    "gusw1-dev-fooapp-fe-0001-a-003"

  ]

}

```

As with the non-DNS examples above, the `addresses` input variable can be

provided with a list of specific IP addresses to be reserved if desired.

## Input variables that cannot contain computed values

Because of the way the module is structured, and due to the fact that

Terraform doesn't yet support computed count values, there are certain input

variables whose values cannot be computed values. The list of those input

variables is as follows:

```

var.dns_domain

var.dns_short_names

var.enable_cloud_dns

var.enable_reverse_dns

var.global

var.names

```

You must currently use literal values for these input variables. If you

don't you run the risk of failing validation (at the least) or surfacing the

dreaded `value of 'count' cannot be computed` error. Future versions of

Terraform may change this fact, but this is the current limitation.

## 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(string)` | 
[
  ""
] | no |

| descriptions | A list of descriptions to add to each address. | `list(string)` | `[]` | 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 |

| labels | Labels to apply to this address. | `map(string)` | `{}` | 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//regions//subnetworks/") | `string` | `""` | no |

## Outputs

| Name | Description |

|------|-------------|

| addresses | List of address values managed by this module (e.g. ["1.2.3.4"]) |

| 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 |

## Requirements

### Terraform plugins

- [Terraform](https://www.terraform.io/downloads.html) >= 0.13.0

- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) plugin >= 5.2.0

### Configure a Service Account

In order to execute this module you must have a Service Account with the following roles:

- roles/dns.admin on the project (for DNS registration)

- roles/compute.networkAdmin on the organization (or the host project that defines the network)

#### Script Helper

A [helper script](./helpers/setup-sa.sh) is included to automatically grant all the

required roles at the project level. The `roles/compute.networkAdmin` can

either be assigned at the project level on the project hosting the network

and subnetworks where IP addresses will be reserved, or at the organization

level. The `setup-sa.sh` script will assign it at the project level on the

host project that is passed in. If this is not what you need then you will

need to adjust permissions accordingly.

Run the script as follows:

```

./helpers/setup-sa.sh  

```

The `SERVICE_ACCOUNT_NAME` can be whatever you want the service account to be

named. Successful completion of the `setup-sa.sh` script will result in a

credentials file called `credentials.json` that can be used with

`gcloud` or referenced by the module tests.

### Enable API's

In order to operate with the Service Account you must activate the following API on the project where the Service Account was created:

- Compute Engine API - compute.googleapis.com

- Google Cloud DNS API - dns.googleapis.com

NOTE: These APIs are enabled by default on the host project passed in to the `./helpers/setup-sa.sh` helper script.

## Install

### Terraform

Be sure you have the correct Terraform version (0.12.x), you can choose the binary here:

- https://releases.hashicorp.com/terraform/

## File structure

The project has the following folders and files:

- /: root folder

- /examples: examples for using this module

- /test: Folders with files for testing the module (see Testing section on this file)

- /main.tf: main file for this module, contains all the resources to create

- /variables.tf: all the variables for the module

- /output.tf: the outputs of the module

- /README.md: this file
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/terraform-google-modules/terraform-google-address

Awesome Lists containing this project

README
