129 lines
4.9 KiB
Markdown
129 lines
4.9 KiB
Markdown
# NCC Spoke RA Module
|
|
|
|
This module allows management of NCC Spokes backed by Router Appliances. Network virtual appliances used as router appliances allow to connect an external network to Google Cloud by using a SD-WAN router or another appliance with BGP capabilities (_site-to-cloud_ connectivity). It is also possible to enable site-to-site data transfer, although this feature is not available in all regions, particularly not in EMEA.
|
|
|
|
The module manages a hub (optionally), a spoke, and the corresponding Cloud Router and BGP sessions to the router appliance(s).
|
|
|
|
## Examples
|
|
|
|
### Simple hub & spoke
|
|
|
|
```hcl
|
|
module "spoke-ra" {
|
|
source = "./fabric/modules/ncc-spoke-ra"
|
|
hub = { create = true, name = "ncc-hub" }
|
|
name = "spoke-ra"
|
|
project_id = "my-project"
|
|
asn = 65000
|
|
peer_asn = 65001
|
|
ras = [
|
|
{
|
|
vm = "projects/my-project/zones/europe-west1-b/instances/router-app"
|
|
ip = "10.0.0.3"
|
|
}
|
|
]
|
|
region = "europe-west1"
|
|
subnetwork = var.subnet.self_link
|
|
vpc = "my-vpc"
|
|
}
|
|
# tftest modules=1 resources=7
|
|
```
|
|
|
|
### Two spokes
|
|
|
|
```hcl
|
|
module "spoke-ra-a" {
|
|
source = "./fabric/modules/ncc-spoke-ra"
|
|
hub = { name = "ncc-hub" }
|
|
name = "spoke-ra-a"
|
|
project_id = "my-project"
|
|
asn = 65000
|
|
peer_asn = 65001
|
|
ras = [
|
|
{
|
|
vm = "projects/my-project/zones/europe-west1-b/instances/router-app-a"
|
|
ip = "10.0.0.3"
|
|
}
|
|
]
|
|
region = "europe-west1"
|
|
subnetwork = "projects/my-project/regions/europe-west1/subnetworks/subnet"
|
|
vpc = "my-vpc1"
|
|
}
|
|
|
|
module "spoke-ra-b" {
|
|
source = "./fabric/modules/ncc-spoke-ra"
|
|
hub = { name = "ncc-hub" }
|
|
name = "spoke-ra-b"
|
|
project_id = "my-project"
|
|
asn = 65000
|
|
peer_asn = 65002
|
|
ras = [
|
|
{
|
|
vm = "projects/my-project/zones/europe-west3-b/instances/router-app-b"
|
|
ip = "10.1.0.5"
|
|
}
|
|
]
|
|
region = "europe-west3"
|
|
subnetwork = "projects/my-project/regions/europe-west3/subnetworks/subnet"
|
|
vpc = "my-vpc2"
|
|
}
|
|
# tftest modules=2 resources=12
|
|
```
|
|
|
|
### Spoke with load-balanced router appliances
|
|
|
|
```hcl
|
|
module "spoke-ra" {
|
|
source = "./fabric/modules/ncc-spoke-ra"
|
|
hub = { name = "ncc-hub" }
|
|
name = "spoke-ra"
|
|
project_id = "my-project"
|
|
asn = 65000
|
|
custom_advertise = {
|
|
all_subnets = true
|
|
ip_ranges = {
|
|
"peered-vpc" = "10.10.0.0/24"
|
|
}
|
|
}
|
|
ip_intf1 = "10.0.0.14"
|
|
ip_intf2 = "10.0.0.15"
|
|
peer_asn = 65001
|
|
ras = [
|
|
{
|
|
vm = "projects/my-project/zones/europe-west1-b/instances/router-app-a"
|
|
ip = "10.0.0.3"
|
|
},
|
|
{
|
|
vm = "projects/my-project/zones/europe-west1-c/instances/router-app-b"
|
|
ip = "10.0.0.4"
|
|
}
|
|
]
|
|
region = "europe-west1"
|
|
subnetwork = var.subnet.self_link
|
|
vpc = "my-vpc"
|
|
}
|
|
# tftest modules=1 resources=8
|
|
```
|
|
<!-- BEGIN TFDOC -->
|
|
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [hub](variables.tf#L23) | The name of the NCC hub to create or use. | <code title="object({ create = optional(bool, false) description = optional(string) name = string })">object({…})</code> | ✓ | |
|
|
| [name](variables.tf#L32) | The name of the NCC spoke. | <code>string</code> | ✓ | |
|
|
| [project_id](variables.tf#L37) | The ID of the project where the NCC hub & spokes will be created. | <code>string</code> | ✓ | |
|
|
| [region](variables.tf#L42) | Region where the spoke is located. | <code>string</code> | ✓ | |
|
|
| [router_appliances](variables.tf#L47) | List of router appliances this spoke is associated with. | <code title="list(object({ internal_ip = string vm_self_link = string }))">list(object({…}))</code> | ✓ | |
|
|
| [router_config](variables.tf#L55) | Configuration of the Cloud Router. | <code title="object({ asn = number custom_advertise = optional(object({ all_subnets = bool ip_ranges = map(string) # map of descriptions and address ranges })) ip_interface1 = string ip_interface2 = string keepalive = optional(number) peer_asn = number })">object({…})</code> | ✓ | |
|
|
| [vpc_config](variables.tf#L70) | Network and subnetwork for the CR interfaces. | <code title="object({ network_name = string subnet_self_link = string })">object({…})</code> | ✓ | |
|
|
| [data_transfer](variables.tf#L17) | Site-to-site data transfer feature, available only in some regions. | <code>bool</code> | | <code>false</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [hub_name](outputs.tf#L17) | NCC hub name (only if auto-created). | |
|
|
|
|
<!-- END TFDOC -->
|