https://github.com/mineiros-io/terraform-google-compute-address
A Terraform module to deploy and manage Google Compute Addresses in Google Cloud https://cloud.google.com/compute
https://github.com/mineiros-io/terraform-google-compute-address
iac mineiros terraform terraform-modules
Last synced: 27 days ago
JSON representation
A Terraform module to deploy and manage Google Compute Addresses in Google Cloud https://cloud.google.com/compute
- Host: GitHub
- URL: https://github.com/mineiros-io/terraform-google-compute-address
- Owner: mineiros-io
- License: apache-2.0
- Created: 2021-09-29T11:59:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-06T12:40:49.000Z (about 3 years ago)
- Last Synced: 2025-02-06T11:12:56.927Z (3 months ago)
- Topics: iac, mineiros, terraform, terraform-modules
- Language: HCL
- Homepage:
- Size: 78.1 KB
- Stars: 0
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[
](https://mineiros.io/?ref=terraform-google-compute-address)
[](https://github.com/mineiros-io/terraform-google-compute-address/actions)
[](https://github.com/mineiros-io/terraform-google-compute-address/releases)
[](https://github.com/hashicorp/terraform/releases)
[](https://github.com/terraform-providers/terraform-provider-google/releases)
[](https://mineiros.io/slack)
# terraform-google-compute-address
A [Terraform] module for [Google Cloud Platform (GCP)][gcp].
**_This module supports Terraform version 1
and is compatible with the Terraform Google Provider version 4._**
This module is part of our Infrastructure as Code (IaC) framework
that enables our users and customers to easily deploy and manage reusable,
secure, and production-grade cloud infrastructure.
- [Module Features](#module-features)
- [Getting Started](#getting-started)
- [Module Argument Reference](#module-argument-reference)
- [Top-level Arguments](#top-level-arguments)
- [Module Configuration](#module-configuration)
- [Main Resource Configuration](#main-resource-configuration)
- [Module Outputs](#module-outputs)
- [External Documentation](#external-documentation)
- [Google Documentation](#google-documentation)
- [Terraform Google Provider Documentation](#terraform-google-provider-documentation)
- [Module Versioning](#module-versioning)
- [Backwards compatibility in `0.0.z` and `0.y.z` version](#backwards-compatibility-in-00z-and-0yz-version)
- [About Mineiros](#about-mineiros)
- [Reporting Issues](#reporting-issues)
- [Contributing](#contributing)
- [Makefile Targets](#makefile-targets)
- [License](#license)
## Module Features
This module implements the following terraform resources:
- `google_compute_address`
## Getting Started
Most basic usage just setting required arguments:
```hcl
module "terraform-google-compute-address" {
source = "github.com/mineiros-io/terraform-google-compute-address.git?ref=v0.0.2"
name = "ipv4-address"
}
```
## Module Argument Reference
See [variables.tf] and [examples/] for details and use-cases.
### Top-level Arguments
#### Module Configuration
- [**`module_enabled`**](#var-module_enabled): *(Optional `bool`)*
Specifies whether resources in the module will be created.
Default is `true`.
- [**`module_depends_on`**](#var-module_depends_on): *(Optional `list(dependency)`)*
A list of dependencies. Any object can be _assigned_ to this list to define a hidden external dependency.
Example:
```hcl
module_depends_on = [
google_network.network
]
```
#### Main Resource Configuration
- [**`name`**](#var-name): *(**Required** `string`)*
Name of the resource. The name must be `1-63` characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- [**`number_of_addresses`**](#var-number_of_addresses): *(Optional `number`)*
How many resources you want to create.
Default is `1`.
- [**`address`**](#var-address): *(Optional `string`)*
The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for `INTERNAL` address types. The IP address must be inside the specified subnetwork, if any.
- [**`address_type`**](#var-address_type): *(Optional `string`)*
The type of address to reserve. Possible values are `INTERNAL` and `EXTERNAL`.
Default is `"EXTERNAL"`.
- [**`description`**](#var-description): *(Optional `string`)*
An optional description of this resource.
- [**`purpose`**](#var-purpose): *(Optional `string`)*
The purpose of this resource, which can be one of the following values: `GCE_ENDPOINT`, `SHARED_LOADBALANCER_VIP`, `VPC_PEERING`, `IPSEC_INTERCONNECT`.
- [**`network_tier`**](#var-network_tier): *(Optional `string`)*
The networking tier used for configuring this address. If this field is not specified, it is assumed to be `PREMIUM`. Possible values are `PREMIUM` and `STANDARD`.
- [**`subnetwork`**](#var-subnetwork): *(Optional `string`)*
The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with `INTERNAL` type with `GCE_ENDPOINT/DNS_RESOLVER` purposes.
- [**`network`**](#var-network): *(Optional `string`)*
The URL of the network in which to reserve the address. This field can only be used with `INTERNAL` type with the `VPC_PEERING` and `IPSEC_INTERCONNECT` purposes.
- [**`prefix_length`**](#var-prefix_length): *(Optional `string`)*
The prefix length if the resource represents an IP range.
- [**`region`**](#var-region): *(Optional `string`)*
The Region in which the created address should reside. If it is not provided, the provider region is used.
- [**`project`**](#var-project): *(Optional `string`)*
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
## Module Outputs
The following attributes are exported in the outputs of the module:
- [**`module_enabled`**](#output-module_enabled): *(`bool`)*
Whether this module is enabled.
- [**`address`**](#output-address): *(`object(address)`)*
All `google_compute_address` attributes.
## External Documentation
### Google Documentation
- Reserve static internal ip address: https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address
- Reserve static external ip address: https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address
### Terraform Google Provider Documentation
- https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_address
## Module Versioning
This Module follows the principles of [Semantic Versioning (SemVer)].
Given a version number `MAJOR.MINOR.PATCH`, we increment the:
1. `MAJOR` version when we make incompatible changes,
2. `MINOR` version when we add functionality in a backwards compatible manner, and
3. `PATCH` version when we make backwards compatible bug fixes.
### Backwards compatibility in `0.0.z` and `0.y.z` version
- Backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
- Backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)
## About Mineiros
[Mineiros][homepage] is a remote-first company headquartered in Berlin, Germany
that solves development, automation and security challenges in cloud infrastructure.
Our vision is to massively reduce time and overhead for teams to manage and
deploy production-grade and secure cloud infrastructure.
We offer commercial support for all of our modules and encourage you to reach out
if you have any questions or need help. Feel free to email us at [[email protected]] or join our
[Community Slack channel][slack].
## Reporting Issues
We use GitHub [Issues] to track community reported issues and missing features.
## Contributing
Contributions are always encouraged and welcome! For the process of accepting changes, we use
[Pull Requests]. If you'd like more information, please see our [Contribution Guidelines].
## Makefile Targets
This repository comes with a handy [Makefile].
Run `make help` to see details on each available target.
## License
[![license][badge-license]][apache20]
This module is licensed under the Apache License Version 2.0, January 2004.
Please see [LICENSE] for full details.
Copyright © 2020-2022 [Mineiros GmbH][homepage]
[homepage]: https://mineiros.io/?ref=terraform-google-compute-address
[[email protected]]: mailto:[email protected]
[badge-build]: https://github.com/mineiros-io/terraform-google-compute-address/workflows/Tests/badge.svg
[badge-semver]: https://img.shields.io/github/v/tag/mineiros-io/terraform-google-compute-address.svg?label=latest&sort=semver
[badge-license]: https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg
[badge-terraform]: https://img.shields.io/badge/Terraform-1.x-623CE4.svg?logo=terraform
[badge-slack]: https://img.shields.io/badge/[email protected]?logo=slack
[build-status]: https://github.com/mineiros-io/terraform-google-compute-address/actions
[releases-github]: https://github.com/mineiros-io/terraform-google-compute-address/releases
[releases-terraform]: https://github.com/hashicorp/terraform/releases
[badge-tf-gcp]: https://img.shields.io/badge/google-3.x-1A73E8.svg?logo=terraform
[releases-google-provider]: https://github.com/terraform-providers/terraform-provider-google/releases
[apache20]: https://opensource.org/licenses/Apache-2.0
[slack]: https://mineiros.io/slack
[terraform]: https://www.terraform.io
[gcp]: https://cloud.google.com/
[semantic versioning (semver)]: https://semver.org/
[variables.tf]: https://github.com/mineiros-io/terraform-google-compute-address/blob/main/variables.tf
[examples/]: https://github.com/mineiros-io/terraform-google-compute-address/blob/main/examples
[issues]: https://github.com/mineiros-io/terraform-google-compute-address/issues
[license]: https://github.com/mineiros-io/terraform-google-compute-address/blob/main/LICENSE
[makefile]: https://github.com/mineiros-io/terraform-google-compute-address/blob/main/Makefile
[pull requests]: https://github.com/mineiros-io/terraform-google-compute-address/pulls
[contribution guidelines]: https://github.com/mineiros-io/terraform-google-compute-address/blob/main/CONTRIBUTING.md