https://github.com/mineiros-io/terraform-google-network-vpc
A Terraform module to create and manage a Virtual Private Network (VPC) in Google Cloud https://cloud.google.com/vpc
https://github.com/mineiros-io/terraform-google-network-vpc
iac mineiros terraform terraform-modules
Last synced: about 1 month ago
JSON representation
A Terraform module to create and manage a Virtual Private Network (VPC) in Google Cloud https://cloud.google.com/vpc
- Host: GitHub
- URL: https://github.com/mineiros-io/terraform-google-network-vpc
- Owner: mineiros-io
- License: apache-2.0
- Created: 2021-09-29T11:56:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T16:15:38.000Z (about 1 year ago)
- Last Synced: 2025-01-26T09:43:04.800Z (3 months ago)
- Topics: iac, mineiros, terraform, terraform-modules
- Language: HCL
- Homepage:
- Size: 191 KB
- Stars: 0
- Watchers: 7
- Forks: 2
- Open Issues: 1
-
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-network-vpc)
[](https://github.com/mineiros-io/terraform-google-network-vpc/actions)
[](https://github.com/mineiros-io/terraform-google-network-vpc/releases)
[](https://github.com/hashicorp/terraform/releases)
[](https://github.com/terraform-providers/terraform-provider-google/releases)
[](https://mineiros.io/slack)
# terraform-google-network-vpc
A [Terraform](https://www.terraform.io) module to create a [Google Network Vpc](https://cloud.google.com/compute/docs/reference/rest/v1/networks) on [Google Cloud Services (GCP)](https://cloud.google.com/).
**_This module supports Terraform version 1
and is compatible with the Terraform Google Provider version 5._**
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)
- [Main Resource Configuration](#main-resource-configuration)
- [Module Configuration](#module-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
A [Terraform] base module for creating a `google_compute_network` resources required for building a VPC.
## Getting Started
Most basic usage just setting required arguments:
```hcl
module "terraform-google-network-vpc" {
source = "github.com/mineiros-io/terraform-google-network-vpc.git?ref=v0.2.0"
project = "example-project-id"
}
```
## Module Argument Reference
See [variables.tf] and [examples/] for details and use-cases.
### Top-level Arguments
#### Main Resource Configuration
- [**`project`**](#var-project): *(Optional `string`)*
The ID of the project in which the resource belongs. If it is not set, the provider project is used.
- [**`name`**](#var-name): *(Optional `string`)*
The name of the VPC. The name will be used to prefix all associacted resources also.
- [**`description`**](#var-description): *(Optional `string`)*
An optional description of the VPC. The resource must be recreated to modify this field.
- [**`routing_mode`**](#var-routing_mode): *(Optional `string`)*
The network-wide routing mode to use. If set to `REGIONAL`, this network's cloud routers will only advertise routes with subnetworks of this network in the same region as the router. If set to `GLOBAL`, this network's cloud routers will advertise routes with all subnetworks of this network, across regions. Possible values are `REGIONAL` and `GLOBAL`.
Default is `"REGIONAL"`.
- [**`delete_default_routes_on_create`**](#var-delete_default_routes_on_create): *(Optional `bool`)*
If set to `true`, ensure that all routes within the network specified whose names begin with `default-route` and with a next hop of `default-internet-gateway` are deleted.
Default is `false`.
- [**`auto_create_subnetworks`**](#var-auto_create_subnetworks): *(Optional `bool`)*
When set to true, the network is created in auto subnet mode and it will create a subnet for each region automatically across the `10.128.0.0/9` address range. When set to `false`, the network is created in `custom subnet mode` so the user can explicitly connect subnetwork resources.
Default is `false`.
- [**`mtu`**](#var-mtu): *(Optional `string`)*
Maximum Transmission Unit in bytes. The minimum value for this field is `1460` and the maximum value is `1500` bytes.
Default is `"1460"`.
- [**`network_firewall_policy_enforcement_order`**](#var-network_firewall_policy_enforcement_order): *(Optional `string`)*
Set the order that Firewall Rules and Firewall Policies are evaluated. Default value is AFTER_CLASSIC_FIREWALL. Possible values are: BEFORE_CLASSIC_FIREWALL, AFTER_CLASSIC_FIREWALL.
Default is `null`.
- [**`enable_ula_internal_ipv6`**](#var-enable_ula_internal_ipv6): *(Optional `bool`)*
Enable ULA internal ipv6 on this network. Enabling this feature will assign a `/48` from Google defined ULA prefix `fd20::/20`.
Default is `false`.
- [**`internal_ipv6_range`**](#var-internal_ipv6_range): *(Optional `string`)*
When enabling ula internal ipv6, caller optionally can specify the `/48` range they want from the Google defined ULA prefix `fd20::/20`. The input must be a valid `/48` ULA IPv6 address and within the `fd20::/20`. The operation will fail if the specified `/48` is already in use by another resource. If the field is not specified, then a `/48` range will be randomly allocated from `fd20::/20` and returned via this field."
Default is `null`.
### 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_project.project_id
]
```
## Module Outputs
The following attributes are exported in the outputs of the module:
- [**`vpc`**](#output-vpc): *(`object(vpc)`)*
The outputs of the created VPC.
## External Documentation
### Google Documentation
- https://cloud.google.com/compute/docs/reference/rest/v1/networks
### Terraform Google Provider Documentation
- https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_network
## 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-network-vpc
[[email protected]]: mailto:[email protected]
[badge-build]: https://github.com/mineiros-io/terraform-google-network-vpc/workflows/Tests/badge.svg
[badge-semver]: https://img.shields.io/github/v/tag/mineiros-io/terraform-google-network-vpc.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-network-vpc/actions
[releases-github]: https://github.com/mineiros-io/terraform-google-network-vpc/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-network-vpc/blob/main/variables.tf
[examples/]: https://github.com/mineiros-io/terraform-google-network-vpc/blob/main/examples
[issues]: https://github.com/mineiros-io/terraform-google-network-vpc/issues
[license]: https://github.com/mineiros-io/terraform-google-network-vpc/blob/main/LICENSE
[makefile]: https://github.com/mineiros-io/terraform-google-network-vpc/blob/main/Makefile
[pull requests]: https://github.com/mineiros-io/terraform-google-network-vpc/pulls
[contribution guidelines]: https://github.com/mineiros-io/terraform-google-network-vpc/blob/main/CONTRIBUTING.md