Google Cloud Build Worker Pool

google_cloudbuild_worker_pool (Terraform)

The Worker Pool in Cloud Build can be configured in Terraform with the resource name google_cloudbuild_worker_pool. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

The following arguments are supported:

• location - (Required) The location for the resource
• name - (Required) User-defined name of the WorkerPool.

• network_config - (Optional) Network configuration for the WorkerPool. Structure is documented below.
• project - (Optional) The project for the resource
• worker_config - (Optional) Configuration to be used for a creating workers in the WorkerPool. Structure is documented below.

The network_config block supports:

• peered_network - (Required) Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the service producer network. Must be in the format projects/[project]/global/networks/[network], where [project] is a project number, such as 12345, and [network] is the name of a VPC network in the project. See (https://cloud.google.com/cloud-build/docs/custom-workers/set-up-custom-worker-pool-environment#understanding_the_network_configuration_options)

The worker_config block supports:

• disk_size_gb - (Optional) Size of the disk attached to the worker, in GB. See (https://cloud.google.com/cloud-build/docs/custom-workers/worker-pool-config-file). Specify a value of up to 1000. If 0 is specified, Cloud Build will use a standard disk size.
• machine_type - (Optional) Machine type of a worker, such as n1-standard-1. See (https://cloud.google.com/cloud-build/docs/custom-workers/worker-pool-config-file). If left blank, Cloud Build will use n1-standard-1.
• no_external_ip - (Optional) If true, workers are created without any public address, which prevents network egress to public IPs.

In addition to the arguments listed above, the following computed attributes are exported:

• id - an identifier for the resource with format projects/[[project]]/locations/[[location]]/workerPools/[[name]]

• create_time - Output only. Time at which the request to create the WorkerPool was received.

• delete_time - Output only. Time at which the request to delete the WorkerPool was received.

• state - Output only. WorkerPool state. Possible values: STATE_UNSPECIFIED, PENDING, APPROVED, REJECTED, CANCELLED

• update_time - Output only. Time at which the request to update the WorkerPool was received.

Explanation in Terraform Registry

Definition of custom Cloud Build WorkerPools for running jobs with custom configuration and custom networking. -> This resource is not currently public, and requires allow-listing of projects prior to use.

Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.