Cloud

Redpanda BYOVPC Module Options for GCP

This reference lists the inputs of the Redpanda BYOVPC Terraform module for GCP, version 1.0.5, grouped by purpose.

Use this reference to:

  • Look up the inputs of the Redpanda BYOVPC Terraform module for GCP

  • Find the default value of each input

  • Identify the inputs for deploying into existing VPCs and subnets

For the inputs of later releases, see the Inputs tab of the module on the Terraform Registry.

General

Input Type Default Description

service_project_id

string

None (required)

The ID of the project where Redpanda deploys the cluster.

network_project_id

string

None (required)

The ID of the project that owns the VPC. Use the service project ID, or the ID of the host project of a shared VPC.

region

string

None (required)

The region where Redpanda deploys the cluster.

unique_identifier

string

""

A suffix added to the names of the resources that the module creates, so that several copies of the module don’t conflict. Bucket names are global, so choose a value that no other deployment uses.

VPC and subnet

By default, the module creates the VPC and a subnet with secondary ranges for Pods and Services. To deploy into a VPC that you manage, set vpc_name and subnet_name. The module still creates a Cloud Router, Cloud NAT, and firewall rules in that VPC.

Input Type Default Description

vpc_name

string

""

The name of an existing VPC. When set, the module does not create a VPC or a subnet, and subnet_name is required.

subnet_name

string

""

The name of an existing subnet. Required when you set vpc_name.

subnetwork_ip_cidr_range

string

"10.0.0.0/24"

The primary IP range of the subnet that the module creates.

subnetwork_pods_secondary_ip_range

string

"10.0.8.0/21"

The secondary IP range for Pods in the subnet that the module creates.

subnetwork_services_secondary_ip_range

string

"10.0.1.0/24"

The secondary IP range for Services in the subnet that the module creates.

secondary_ipv4_range_pods_name

string

"redpanda-pods"

The name of the secondary IP range for Pods. For an existing subnet, set this to the name of its Pods range.

secondary_ipv4_range_services_name

string

"redpanda-services"

The name of the secondary IP range for Services. For an existing subnet, set this to the name of its Services range.

gke_master_ipv4_cidr_block

string

"10.0.7.240/28"

The /28 range for the GKE control plane. The module allows webhook traffic from this range in its firewall rules, and reports it in the k8s_master_ipv4_range output for the redpanda_cluster resource.

attach_shared_vpc

bool

true

When true and the network project differs from the service project, the module attaches the service project to the host project, and grants the roles/container.hostServiceAgentUser and roles/compute.securityAdmin roles on the host project with authoritative bindings, which remove any other members of those roles. Set to false if your shared VPC is already set up. Regardless of this setting, when the module creates the VPC in a host project, it sets an authoritative IAM policy on the subnet, which replaces every other IAM binding on that subnet.

Private Service Connect

These inputs apply when you use GCP Private Service Connect.

Input Type Default Description

enable_private_link

bool

false

When true, the module creates the Private Service Connect resources: the agent permissions, a firewall rule for the Private Service Connect ports, and, if the module creates the VPC, a NAT subnet.

psc_subnet_name

string

""

The name of an existing Private Service Connect NAT subnet. Required when you set vpc_name and enable_private_link. Must be empty otherwise.

psc_nat_subnet_ipv4_range

string

"10.0.2.0/29"

The IP range of the Private Service Connect NAT subnet that the module creates.

psc_config

object

console_seed_node_port = 31004, kafka_api_base_node_port = 32092, kafka_api_seed_node_port = 30292, port_offset = 100, redpanda_proxy_base_node_port = 31082, redpanda_proxy_seed_node_port = 30282, schema_registry_seed_node_port = 30181

The seed and base node ports that the Private Service Connect firewall rule allows.

max_redpanda_node_count

number

20

The number of brokers that the Private Service Connect firewall rule opens ports for.

Features

Input Type Default Description

enable_redpanda_sql

bool

false

When true, creates the service accounts, the storage bucket, and the IAM bindings that Redpanda SQL requires. See Enable Redpanda SQL on a BYOVPC Cluster on GCP.

Storage

Input Type Default Description

force_destroy_mgmt_bucket

bool

false

When true, terraform destroy deletes the management bucket and the objects in it. Without this setting, terraform destroy fails if the bucket contains objects.

force_destroy_cloud_storage_bucket

bool

false

When true, terraform destroy deletes the Tiered Storage bucket and the objects in it. Without this setting, terraform destroy fails if the bucket contains objects. Not recommended for production.

force_destroy_sql_storage_bucket

bool

false

When true, terraform destroy deletes the Redpanda SQL storage bucket and the objects in it. Applies when enable_redpanda_sql is true.

Testing

Input Type Default Description

create_test_user

bool

false

When true, creates a service account with the minimum permissions for creating the cluster, for testing those permissions. Not for production use.