63 lines
2.7 KiB
Markdown
63 lines
2.7 KiB
Markdown
# Cloud VPN Route-based Module
|
|
|
|
## Example
|
|
|
|
```hcl
|
|
module "addresses" {
|
|
source = "./modules/net-address"
|
|
project_id = var.project_id
|
|
external_addresses = {
|
|
vpn = "europe-west1"
|
|
}
|
|
}
|
|
|
|
module "vpn" {
|
|
source = "./modules/net-vpn-static"
|
|
project_id = var.project_id
|
|
region = var.region
|
|
network = var.vpc.self_link
|
|
name = "remote"
|
|
gateway_address_create = false
|
|
gateway_address = module.addresses.external_addresses["vpn"].address
|
|
remote_ranges = ["10.10.0.0/24"]
|
|
tunnels = {
|
|
remote-0 = {
|
|
ike_version = 2
|
|
peer_ip = "1.1.1.1"
|
|
shared_secret = "mysecret"
|
|
traffic_selectors = { local = ["0.0.0.0/0"], remote = ["0.0.0.0/0"] }
|
|
}
|
|
}
|
|
}
|
|
# tftest:modules=2:resources=8
|
|
```
|
|
|
|
<!-- BEGIN TFDOC -->
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---: |:---:|:---:|
|
|
| name | VPN gateway name, and prefix used for dependent resources. | <code title="">string</code> | ✓ | |
|
|
| network | VPC used for the gateway and routes. | <code title="">string</code> | ✓ | |
|
|
| project_id | Project where resources will be created. | <code title="">string</code> | ✓ | |
|
|
| region | Region used for resources. | <code title="">string</code> | ✓ | |
|
|
| *gateway_address* | Optional address assigned to the VPN gateway. Ignored unless gateway_address_create is set to false. | <code title="">string</code> | | <code title=""></code> |
|
|
| *gateway_address_create* | Create external address assigned to the VPN gateway. Needs to be explicitly set to false to use address in gateway_address variable. | <code title="">bool</code> | | <code title="">true</code> |
|
|
| *remote_ranges* | Remote IP CIDR ranges. | <code title="list(string)">list(string)</code> | | <code title="">[]</code> |
|
|
| *route_priority* | Route priority, defaults to 1000. | <code title="">number</code> | | <code title="">1000</code> |
|
|
| *tunnels* | VPN tunnel configurations. | <code title="map(object({ ike_version = number peer_ip = string shared_secret = string traffic_selectors = object({ local = list(string) remote = list(string) }) }))">map(object({...}))</code> | | <code title="">{}</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| address | VPN gateway address. | |
|
|
| gateway | VPN gateway resource. | |
|
|
| name | VPN gateway name. | |
|
|
| random_secret | Generated secret. | |
|
|
| self_link | VPN gateway self link. | |
|
|
| tunnel_names | VPN tunnel names. | |
|
|
| tunnel_self_links | VPN tunnel self links. | |
|
|
| tunnels | VPN tunnel resources. | |
|
|
<!-- END TFDOC -->
|