2022-10-09 06:41:56 -07:00
# Google Simple NVA Module
2022-09-30 09:43:24 -07:00
This module allows for the creation of a NVA (Network Virtual Appliance) to be used for experiments and as a stub for future appliances deployment.
This NVA can be used to interconnect up to 8 VPCs.
## Examples
### Simple example
```hcl
locals {
network_interfaces = [
{
addresses = null
name = "dev"
nat = false
network = "dev_vpc_self_link"
routes = ["10.128.0.0/9"]
subnetwork = "dev_vpc_nva_subnet_self_link"
},
{
addresses = null
name = "prod"
nat = false
network = "prod_vpc_self_link"
routes = ["10.0.0.0/9"]
subnetwork = "prod_vpc_nva_subnet_self_link"
}
2022-12-10 06:40:15 -08:00
]
2022-09-30 09:43:24 -07:00
}
2022-12-10 06:40:15 -08:00
module "cos-nva" {
source = "./fabric/modules/cloud-config-container/simple-nva"
2022-09-30 09:43:24 -07:00
enable_health_checks = true
network_interfaces = local.network_interfaces
2022-12-10 06:40:15 -08:00
# files = {
# "/var/lib/cloud/scripts/per-boot/firewall-rules.sh" = {
# content = file("./your_path/to/firewall-rules.sh")
# owner = "root"
# permissions = 0700
# }
# }
2022-09-30 09:43:24 -07:00
}
2022-12-10 06:40:15 -08:00
module "vm" {
source = "./fabric/modules/compute-vm"
project_id = "my-project"
zone = "europe-west8-b"
name = "cos-nva"
2022-09-30 09:43:24 -07:00
network_interfaces = local.network_interfaces
2022-12-10 06:40:15 -08:00
metadata = {
user-data = module.cos-nva.cloud_config
google-logging-enabled = true
}
2022-09-30 09:43:24 -07:00
boot_disk = {
2023-03-16 06:30:05 -07:00
initialize_params = {
image = "projects/cos-cloud/global/images/family/cos-stable"
type = "pd-ssd"
size = 10
}
2022-09-30 09:43:24 -07:00
}
2022-12-10 06:40:15 -08:00
tags = ["nva", "ssh"]
2022-09-30 09:43:24 -07:00
}
2022-12-10 06:40:15 -08:00
# tftest modules=1 resources=1
2022-09-30 09:43:24 -07:00
```
2023-03-08 00:43:13 -08:00
### Example with advanced routing capabilities
Find below a sample terraform example for bootstrapping a simple NVA powered by [COS ](https://cloud.google.com/container-optimized-os/docs ) and running [FRRouting ](https://frrouting.org/ ) container.
Please find below a sample frr.conf file based on the documentation available [here ](https://docs.frrouting.org/en/latest/basic.html ) for hosting a BGP service with ASN 65001 on FRR container establishing a BGP session with a remote neighbor with IP address 10.128.0.2 and ASN 65002.
```
# tftest-file id=frr_conf path=./frr.conf
# Example frr.conmf file
log syslog informational
no ipv6 forwarding
router bgp 65001
neighbor 10.128.0.2 remote-as 65002
line vty
```
Following code assumes a file in the same folder named frr.conf exists.
```hcl
locals {
network_interfaces = [
{
addresses = null
name = "dev"
nat = false
network = "dev_vpc_self_link"
routes = ["10.128.0.0/9"]
subnetwork = "dev_vpc_nva_subnet_self_link"
enable_masquerading = true
non_masq_cidrs = ["10.0.0.0/8"]
},
{
addresses = null
name = "prod"
nat = false
network = "prod_vpc_self_link"
routes = ["10.0.0.0/9"]
subnetwork = "prod_vpc_nva_subnet_self_link"
}
]
}
module "cos-nva" {
source = "./fabric/modules/cloud-config-container/simple-nva"
enable_health_checks = true
network_interfaces = local.network_interfaces
frr_config = { config_file = "./frr.conf", daemons_enabled = ["bgpd"] }
optional_run_cmds = ["ls -l"]
}
module "vm" {
source = "./fabric/modules/compute-vm"
project_id = "my-project"
zone = "europe-west8-b"
name = "cos-nva"
network_interfaces = local.network_interfaces
metadata = {
user-data = module.cos-nva.cloud_config
google-logging-enabled = true
}
boot_disk = {
image = "projects/cos-cloud/global/images/family/cos-stable"
type = "pd-ssd"
size = 10
}
tags = ["nva", "ssh"]
}
# tftest modules=1 resources=1 files=frr_conf
```
2022-09-30 09:43:24 -07:00
<!-- BEGIN TFDOC -->
## Variables
| name | description | type | required | default |
|---|---|:---:|:---:|:---:|
2023-03-08 00:43:13 -08:00
| [network_interfaces ](variables.tf#L75 ) | Network interfaces configuration. | < code title = "list(object({ routes = optional(list(string)) enable_masquerading = optional(bool, false) non_masq_cidrs = optional(list(string)) }))" > list( object({…})) </ code > | ✓ | |
2022-09-30 09:43:24 -07:00
| [cloud_config ](variables.tf#L17 ) | Cloud config template path. If null default will be used. | < code > string</ code > | | < code > null</ code > |
2022-11-19 03:38:37 -08:00
| [enable_health_checks ](variables.tf#L23 ) | Configures routing to enable responses to health check probes. | < code > bool</ code > | | < code > false</ code > |
| [files ](variables.tf#L29 ) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | < code title = "map(object({ content = string owner = string permissions = string }))" > map( object({…})) </ code > | | < code > {} </ code > |
2023-03-20 23:41:12 -07:00
| [frr_config ](variables.tf#L39 ) | FRR configuration for container running on the NVA. | < code title = "object({ config_file = string daemons_enabled = optional(list(string)) })" > object({…}) </ code > | | < code > null</ code > |
2023-03-08 00:43:13 -08:00
| [optional_run_cmds ](variables.tf#L84 ) | Optional Cloud Init run commands to execute. | < code > list( string) </ code > | | < code > [] </ code > |
2022-09-30 09:43:24 -07:00
## Outputs
| name | description | sensitive |
|---|---|:---:|
| [cloud_config ](outputs.tf#L17 ) | Rendered cloud-config file to be passed as user-data instance metadata. | |
<!-- END TFDOC -->