84 lines
4.4 KiB
Markdown
84 lines
4.4 KiB
Markdown
# Containerized on-premises infrastructure
|
|
|
|
This module manages a `cloud-config` configuration that starts an emulated on-premises infrastructure running in Docker Compose on a single instance, and connects it via static or dynamic VPN to a Google Cloud VPN gateway.
|
|
|
|
The emulated on-premises infrastructure is composed of:
|
|
|
|
- a [Strongswan container](./docker-images/strongswan) managing the VPN tunnel to GCP
|
|
- an optional Bird container managing the BGP session
|
|
- a CoreDNS container servng local DNS and forwarding to GCP
|
|
- an Nginx container serving a simple static web page
|
|
- a [generic Linux container](./docker-images/toolbox) used as a jump host inside the on-premises network
|
|
|
|
A [complete scenario using this module](../../../examples/networking/onprem-google-access-dns) is available in the networking examples.
|
|
|
|
The module renders the generated cloud config in the `cloud_config` output, to be used in instances or instance templates via the `user-data` metadata.
|
|
|
|
For convenience during development or for simple use cases, the module can optionally manage a single instance via the `test_instance` variable. If the instance is not needed the `instance*tf` files can be safely removed. Refer to the [top-level README](../README.md) for more details on the included instance.
|
|
|
|
## Examples
|
|
|
|
### Static VPN
|
|
|
|
The test instance is optional, as described above.
|
|
|
|
```hcl
|
|
module "cloud-vpn" {
|
|
source = "./modules/net-vpn-static"
|
|
project_id = "my-project"
|
|
region = "europe-west1"
|
|
network = "my-vpc"
|
|
name = "to-on-prem"
|
|
remote_ranges = ["192.168.192.0/24"]
|
|
tunnels = {
|
|
remote-0 = {
|
|
ike_version = 2
|
|
peer_ip = module.on-prem.external_address
|
|
shared_secret = ""
|
|
traffic_selectors = { local = ["0.0.0.0/0"], remote = null }
|
|
}
|
|
}
|
|
}
|
|
|
|
module "on-prem" {
|
|
source = "./modules/cos-container/on-prem"
|
|
name = "onprem"
|
|
vpn_config = {
|
|
type = "static"
|
|
peer_ip = module.cloud-vpn.address
|
|
shared_secret = module.cloud-vpn.random_secret
|
|
}
|
|
test_instance = {
|
|
project_id = "my-project"
|
|
zone = "europe-west1-b"
|
|
name = "cos-coredns"
|
|
type = "f1-micro"
|
|
network = "default"
|
|
subnetwork = "https://www.googleapis.com/compute/v1/projects/my-project/regions/europe-west1/subnetworks/my-subnet"
|
|
}
|
|
}
|
|
```
|
|
|
|
|
|
<!-- BEGIN TFDOC -->
|
|
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| vpn_config | VPN configuration, type must be one of 'dynamic' or 'static'. | <code title="object({ peer_ip = string shared_secret = string type = string peer_ip2 = string shared_secret2 = string })">object({…})</code> | ✓ | |
|
|
| config_variables | Additional variables used to render the cloud-config and CoreDNS templates. | <code>map(any)</code> | | <code>{}</code> |
|
|
| coredns_config | CoreDNS configuration path, if null default will be used. | <code>string</code> | | <code>null</code> |
|
|
| local_ip_cidr_range | IP CIDR range used for the Docker onprem network. | <code>string</code> | | <code>"192.168.192.0/24"</code> |
|
|
| vpn_dynamic_config | BGP configuration for dynamic VPN, ignored if VPN type is 'static'. | <code title="object({ local_bgp_asn = number local_bgp_address = string peer_bgp_asn = number peer_bgp_address = string local_bgp_asn2 = number local_bgp_address2 = string peer_bgp_asn2 = number peer_bgp_address2 = string })">object({…})</code> | | <code title="{ local_bgp_asn = 64514 local_bgp_address = "169.254.1.2" peer_bgp_asn = 64513 peer_bgp_address = "169.254.1.1" local_bgp_asn2 = 64514 local_bgp_address2 = "169.254.2.2" peer_bgp_asn2 = 64520 peer_bgp_address2 = "169.254.2.1" }">{…}</code> |
|
|
| vpn_static_ranges | Remote CIDR ranges for static VPN, ignored if VPN type is 'dynamic'. | <code>list(string)</code> | | <code>["10.0.0.0/8"]</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| cloud_config | Rendered cloud-config file to be passed as user-data instance metadata. | |
|
|
|
|
<!-- END TFDOC -->
|
|
|