Skip to content

betsy-lichtenberg/terraform-google-cloud-router

 
 

Repository files navigation

This module handles opinionated Google Cloud Platform routing.

Usage

Basic usage of this module is as follows:

module "cloud_router" {
  source  = "terraform-google-modules/cloud-router/google"
  version = "~> 0.4"

  name    = "example-router"
  project = "<PROJECT ID>"
  region  = "us-central1"
  network = "default"
}

Functional examples are included in the examples directory.

Inputs

Name Description Type Default Required
bgp BGP information specific to this router. any null no
name Name of the router string n/a yes
nats NATs to deploy on this router. any [] no
network A reference to the network to which this router belongs string n/a yes
project The project ID to deploy to string n/a yes
region Region where the router resides string n/a yes

Outputs

Name Description
router The created router

Requirements

These sections describe requirements for using this module.

Software

The following dependencies must be available:

Service Account

A service account with the following roles must be used to provision the resources of this module:

  • Network Admin: roles/compute.networkAdmin

The Project Factory module and the [IAM module][iam-module] may be used in combination to provision a service account with the necessary roles applied.

APIs

A project with the following APIs enabled must be used to host the resources of this module:

  • Google Cloud Compute Engine API: compute.googleapis.com

The Project Factory module can be used to provision a project with the necessary APIs enabled.

Contributing

Refer to the contribution guidelines for information on contributing to this module.

Packages

No packages published

Languages

  • HCL 80.4%
  • Makefile 11.1%
  • Ruby 8.5%