History

Aurélien Legrand e8e26f6866 Update metrics.yaml (#641 ) Good news: Limits for L4 Internal Forwarding Rules was raised to 300 per network and per network peering group in GCP (source: https://cloud.google.com/vpc/docs/quota#vpc-peering).		2022-05-03 11:18:36 +02:00
..
cloud-function	Update metrics.yaml (#641 )	2022-05-03 11:18:36 +02:00
dashboards	Adding Dynamic Routes per Network as a new metric.	2022-03-30 17:03:31 +02:00
tests	Refactoring to use Cloud Asset Inventory, reducing latency for metrics data, reduced execution time by 50%.	2022-03-24 10:07:58 +01:00
LICENSE	Networking dashboard to display per VPC and per VPC peering group limits that are not shown in the console	2022-03-08 18:36:02 +01:00
README.md	Network dashboard: Adding dynamic routes per VPC peering group. (#617 )	2022-04-12 09:58:12 +02:00
main.tf	Findings from code review	2022-04-12 17:55:40 +02:00
metric.png	Improving README.md and adding a picture	2022-03-18 10:43:16 +01:00
variables.tf	Findings from code review	2022-04-12 17:55:40 +02:00

README.md

Networking Dashboard

This repository provides an end-to-end solution to gather some GCP Networking quotas and limits (that cannot be seen in the GCP console today) and display them in a dashboard. The goal is to allow for better visibility of these limits, facilitating capacity planning and avoiding hitting these limits.

Here is an example of dashboard you can get with this solution:

Here you see utilization (usage compared to the limit) for a specific metric (number of instances per VPC) for multiple VPCs and projects.

3 metrics are created: Usage, limit and utilization. You can follow each of these and create alerting policies if a threshold is reached.

Usage

Clone this repository, then go through the following steps to create resources:

Create a terraform.tfvars file with the following content:
- organization_id = "[YOUR-ORG-ID]"
- billing_account = "[YOUR-BILLING-ACCOUNT]"
- monitoring_project_id = "project-0" # Monitoring project where the dashboard will be created and the solution deployed
- monitored_projects_list = ["project-1", "project2"] # Projects to be monitored by the solution
terraform init
terraform apply

Once the resources are deployed, go to the following page to see the dashboard: https://console.cloud.google.com/monitoring/dashboards?project=. A dashboard called "quotas-utilization" should be created.

The Cloud Function runs every 5 minutes by default so you should start getting some data points after a few minutes. You can change this frequency by modifying the "schedule_cron" variable in variables.tf.

Once done testing, you can clean up resources by running terraform destroy.

Supported limits and quotas

The Cloud Function currently tracks usage, limit and utilization of:

active VPC peerings per VPC
VPC peerings per VPC
instances per VPC
instances per VPC peering group
Subnet IP ranges per VPC peering group
internal forwarding rules for internal L4 load balancers per VPC
internal forwarding rules for internal L7 load balancers per VPC
internal forwarding rules for internal L4 load balancers per VPC peering group
internal forwarding rules for internal L7 load balancers per VPC peering group
Dynamic routes per VPC
Dynamic routes per VPC peering group

It writes this values to custom metrics in Cloud Monitoring and creates a dashboard to visualize the current utilization of these metrics in Cloud Monitoring.

Note that metrics are created in the cloud-function/metrics.yaml file.

You can also edit default limits for a specific network in that file. See the example for vpc_peering_per_network.

Next steps and ideas

In a future release, we could support:

Static routes per VPC / per VPC peering group
Dynamic routes per VPC peering group
Google managed VPCs that are peered with PSA (such as Cloud SQL or Memorystore)
Subnet IP ranges utilization

If you are interested in this and/or would like to contribute, please contact legranda@google.com.