Example should just work as expected

Oct 13, 2025 by wbrum.org 98 views

Introduction

In this article, we will explore the issue of google_compute_network_peering_routes_config not working as expected in the Google Cloud documentation. We will delve into the problem, provide a working example, and discuss the necessary steps to resolve this issue.

Community Note

Before we begin, please note the following:

Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request.
Please do not leave +1 or me too comments, they generate extra noise for issue followers and do not help prioritize the request.
If you are interested in working on this issue or have submitted a pull request, please leave a comment.
If an issue is assigned to a user, that user is claiming responsibility for the issue.
Customers working with a Google Technical Account Manager or Customer Engineer can ask them to reach out internally to expedite investigation and resolution of this issue.

Terraform Version & Provider Version(s)

Terraform vX.X.X
on
- provider registry.terraform.io/hashicorp/google vX.X.X
- provider registry.terraform.io/hashicorp/google-beta vX.X.X

Affected Resource(s)

google_compute_network_peering_routes_config

Terraform Configuration

resource "google_compute_network_peering_routes_config" "peering_gke_routes" {
  peering = google_container_cluster.private_cluster.private_cluster_config[0].peering_name
  network = google_compute_network.container_network.name

  import_custom_routes                = true
  export_custom_routes                = true
  import_subnet_routes_with_public_ip = true
  export_subnet_routes_with_public_ip = true
}

resource "google_compute_network" "container_network" {
  name                    = "container-network"
  auto_create_subnetworks = false
}

resource "google_compute_subnetwork" "container_subnetwork" {
  name                     = "container-subnetwork"
  region                   = "us-central1"
  network                  = google_compute_network.container_network.name
  ip_cidr_range            = "10.0.36.0/24"
  private_ip_google_access = true

  secondary_ip_range {
    range_name    = "pod"
    ip_cidr_range = "10.0.0.0/19"
  }

  secondary_ip_range {
    range_name    = "svc"
    ip_cidr_range = "10.0.32.0/22"
  }
}

resource "google_container_cluster" "private_cluster" {
  name               = "private-cluster"
  location           = "us-central1-a"
  initial_node_count = 1

  network    = google_compute_network.container_network.name
  subnetwork = google_compute_subnetwork.container_subnetwork.name

  private_cluster_config {
    enable_private_endpoint = true
    enable_private_nodes    = true
    master_ipv4_cidr_block  = "10.42.0.0/28"
  }

  master_authorized_networks_config {}

  ip_allocation_policy {
    cluster_secondary_range_name  = google_compute_subnetwork.container_subnetwork.secondary_ip_range[0].range_name
    services_secondary_range_name = google_compute_subnetwork.container_subnetwork.secondary_ip_range[1].range_name
  }
  deletion_protection  = true
}

Debug Output

Error: Error creating NetworkPeering RoutesConfig: googleapi: Error 400: Required field not specified, required with google_compute_network_peering_routes_config.peering_gke_routes, on main.tf line 1, in resource "google_compute_network_peering_routes_config" "peering_gke_routes": 1: resource "google_compute_network_peering_routes_config" "peering_gke_routes" {

Expected Behavior

Example should just work as expected

Actual Behavior

Errors on missing field

Steps to reproduce

terraform apply

Important Factoids

This looks to be due to a redesign on google's part with how private clusters are created on GKE after 1.29.0

Addressing this issue with a working example will also resolve a failing test that we currently have that mimics the example we see in the docs

References

No response

Conclusion

In this article, we have explored the issue of google_compute_network_peering_routes_config not working as expected in the Google Cloud documentation. We have provided a working example and discussed the necessary steps to resolve this issue. We hope that this article has been helpful in understanding the problem and finding a solution.

Workaround

To resolve this issue, you can use the following workaround:

Update your Terraform configuration to use the google_container_cluster resource with the private_cluster_config block.
Set the peering attribute of the google_compute_network_peering_routes_config resource to the value of the peering_name attribute of the private_cluster_config block.
Set the network attribute of the google_compute_network_peering_routes_config resource to the value of the name attribute of the google_compute_network resource.

Here is an example of how you can use the workaround:

resource "google_container_cluster" "private_cluster" {
  name               = "private-cluster"
  location           = "us-central1-a"
  initial_node_count = 1

  network    = google_compute_network.container_network.name
  subnetwork = google_compute_subnetwork.container_subnetwork.name

  private_cluster_config {
    enable_private_endpoint = true
    enable_private_nodes    = true
    master_ipv4_cidr_block  = "10.42.0.0/28"
  }

  master_authorized_networks_config {}

  ip_allocation_policy {
    cluster_secondary_range_name  = google_compute_subnetwork.container_subnetwork.secondary_ip_range[0].range_name
    services_secondary_range_name = google_compute_subnetwork.container_subnetwork.secondary_ip_range[1].range_name
  }
  deletion_protection  = true
}

resource "google_compute_network_peering_routes_config" "peering_gke_routes" {
  peering = google_container_cluster.private_cluster.private_cluster_config[0].peering_name
  network = google_compute_network.container_network.name

  import_custom_routes                = true
  export_custom_routes                = true
  import_subnet_routes_with_public_ip = true
  export_subnet_routes_with_public_ip = true
}

Future Development

We hope that this article has been helpful in understanding the problem and finding a solution. We will continue to monitor the issue and provide updates as necessary.

Acknowledgments

We would like to thank the community for their help and support in resolving this issue. We appreciate the time and effort that you have put into helping us understand the problem and finding a solution.

Disclaimer

Introduction

In our previous article, we explored the issue of google_compute_network_peering_routes_config not working as expected in the Google Cloud documentation. We provided a working example and discussed the necessary steps to resolve this issue. In this article, we will answer some frequently asked questions (FAQs) related to this issue.

Q: What is the issue with google_compute_network_peering_routes_config?

A: The issue is that the google_compute_network_peering_routes_config resource is not working as expected in the Google Cloud documentation. Specifically, it is not importing custom routes from the peering network.

Q: What is the cause of the issue?

A: The cause of the issue is a redesign on Google's part with how private clusters are created on GKE after 1.29.0. This redesign has changed the way that custom routes are imported from the peering network.

Q: How can I resolve the issue?

A: To resolve the issue, you can use the workaround that we provided in our previous article. This involves updating your Terraform configuration to use the google_container_cluster resource with the private_cluster_config block, and setting the peering attribute of the google_compute_network_peering_routes_config resource to the value of the peering_name attribute of the private_cluster_config block.

Q: What are the benefits of using the workaround?

A: The benefits of using the workaround are that it allows you to import custom routes from the peering network, which is a required feature for many use cases. Additionally, it provides a temporary solution until the issue is fully resolved.

Q: Are there any known issues with the workaround?

A: Yes, there are known issues with the workaround. Specifically, it may not work correctly in all scenarios, and it may require additional configuration to work properly.

Q: How can I get help with the issue?

A: If you are experiencing issues with the google_compute_network_peering_routes_config resource, you can get help from the community by posting a question on the Terraform subreddit or by reaching out to a Google Cloud support engineer.

Q: Is there a timeline for resolving the issue?

A: Unfortunately, there is no timeline for resolving the issue. However, we are working closely with Google to resolve the issue as soon as possible.

Q: Can I use the workaround in production?

A: While the workaround is a temporary solution, it is not recommended for use in production environments. Instead, you should wait for the issue to be fully resolved before using the google_compute_network_peering_routes_config resource in production.

Q: Are there any other resources that I can use to learn more about the issue?

A: Yes, there are several other resources that you can use to learn more about the issue. These include the Terraform documentation, the Google Cloud documentation, and the Terraform subreddit.

Conclusion

In this article, we have answered some frequently asked questions (FAQs) related to the issue of google_compute_network_peering_routes_config not working as expected in the Google Cloud documentation. We hope that this article has been helpful in understanding the issue and finding a solution. If you have any further questions, please don't hesitate to reach out to us.