WorkerPool class

Definition of custom Cloud Build WorkerPools for running jobs with custom configuration and custom networking.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const pool = new gcp.cloudbuild.WorkerPool("pool", {
    name: "my-pool",
    location: "europe-west1",
    workerConfig: {
        diskSizeGb: 100,
        machineType: "e2-standard-4",
        noExternalIp: false,
    },
});

import pulumi
import pulumi_gcp as gcp

pool = gcp.cloudbuild.WorkerPool("pool",
    name="my-pool",
    location="europe-west1",
    worker_config={
        "disk_size_gb": 100,
        "machine_type": "e2-standard-4",
        "no_external_ip": False,
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var pool = new Gcp.CloudBuild.WorkerPool("pool", new()
    {
        Name = "my-pool",
        Location = "europe-west1",
        WorkerConfig = new Gcp.CloudBuild.Inputs.WorkerPoolWorkerConfigArgs
        {
            DiskSizeGb = 100,
            MachineType = "e2-standard-4",
            NoExternalIp = false,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/cloudbuild"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudbuild.NewWorkerPool(ctx, "pool", &cloudbuild.WorkerPoolArgs{
			Name:     pulumi.String("my-pool"),
			Location: pulumi.String("europe-west1"),
			WorkerConfig: &cloudbuild.WorkerPoolWorkerConfigArgs{
				DiskSizeGb:   pulumi.Int(100),
				MachineType:  pulumi.String("e2-standard-4"),
				NoExternalIp: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_cloudbuild_workerpool" "pool" {
  name     = "my-pool"
  location = "europe-west1"
  worker_config = {
    disk_size_gb   = 100
    machine_type   = "e2-standard-4"
    no_external_ip = false
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudbuild.WorkerPool;
import com.pulumi.gcp.cloudbuild.WorkerPoolArgs;
import com.pulumi.gcp.cloudbuild.inputs.WorkerPoolWorkerConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var pool = new WorkerPool("pool", WorkerPoolArgs.builder()
            .name("my-pool")
            .location("europe-west1")
            .workerConfig(WorkerPoolWorkerConfigArgs.builder()
                .diskSizeGb(100)
                .machineType("e2-standard-4")
                .noExternalIp(false)
                .build())
            .build());

    }
}

resources:
  pool:
    type: gcp:cloudbuild:WorkerPool
    properties:
      name: my-pool
      location: europe-west1
      workerConfig:
        diskSizeGb: 100
        machineType: e2-standard-4
        noExternalIp: false

Network Config

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const servicenetworking = new gcp.projects.Service("servicenetworking", {service: "servicenetworking.googleapis.com"});
const network = new gcp.compute.Network("network", {
    name: "my-network",
    autoCreateSubnetworks: false,
}, {
    dependsOn: [servicenetworking],
});
const workerRange = new gcp.compute.GlobalAddress("worker_range", {
    name: "worker-pool-range",
    purpose: "VPC_PEERING",
    addressType: "INTERNAL",
    prefixLength: 16,
    network: network.id,
});
const workerPoolConn = new gcp.servicenetworking.Connection("worker_pool_conn", {
    network: network.id,
    service: "servicenetworking.googleapis.com",
    reservedPeeringRanges: [workerRange.name],
}, {
    dependsOn: [servicenetworking],
});
const pool = new gcp.cloudbuild.WorkerPool("pool", {
    name: "my-pool",
    location: "europe-west1",
    workerConfig: {
        diskSizeGb: 100,
        machineType: "e2-standard-4",
        noExternalIp: false,
    },
    networkConfig: {
        peeredNetwork: network.id,
        peeredNetworkIpRange: "/29",
    },
}, {
    dependsOn: [workerPoolConn],
});

import pulumi
import pulumi_gcp as gcp

servicenetworking = gcp.projects.Service("servicenetworking", service="servicenetworking.googleapis.com")
network = gcp.compute.Network("network",
    name="my-network",
    auto_create_subnetworks=False,
    opts = pulumi.ResourceOptions(depends_on=[servicenetworking]))
worker_range = gcp.compute.GlobalAddress("worker_range",
    name="worker-pool-range",
    purpose="VPC_PEERING",
    address_type="INTERNAL",
    prefix_length=16,
    network=network.id)
worker_pool_conn = gcp.servicenetworking.Connection("worker_pool_conn",
    network=network.id,
    service="servicenetworking.googleapis.com",
    reserved_peering_ranges=[worker_range.name],
    opts = pulumi.ResourceOptions(depends_on=[servicenetworking]))
pool = gcp.cloudbuild.WorkerPool("pool",
    name="my-pool",
    location="europe-west1",
    worker_config={
        "disk_size_gb": 100,
        "machine_type": "e2-standard-4",
        "no_external_ip": False,
    },
    network_config={
        "peered_network": network.id,
        "peered_network_ip_range": "/29",
    },
    opts = pulumi.ResourceOptions(depends_on=[worker_pool_conn]))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var servicenetworking = new Gcp.Projects.Service("servicenetworking", new()
    {
        ServiceName = "servicenetworking.googleapis.com",
    });

    var network = new Gcp.Compute.Network("network", new()
    {
        Name = "my-network",
        AutoCreateSubnetworks = false,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            servicenetworking,
        },
    });

    var workerRange = new Gcp.Compute.GlobalAddress("worker_range", new()
    {
        Name = "worker-pool-range",
        Purpose = "VPC_PEERING",
        AddressType = "INTERNAL",
        PrefixLength = 16,
        Network = network.Id,
    });

    var workerPoolConn = new Gcp.ServiceNetworking.Connection("worker_pool_conn", new()
    {
        Network = network.Id,
        Service = "servicenetworking.googleapis.com",
        ReservedPeeringRanges = new[]
        {
            workerRange.Name,
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            servicenetworking,
        },
    });

    var pool = new Gcp.CloudBuild.WorkerPool("pool", new()
    {
        Name = "my-pool",
        Location = "europe-west1",
        WorkerConfig = new Gcp.CloudBuild.Inputs.WorkerPoolWorkerConfigArgs
        {
            DiskSizeGb = 100,
            MachineType = "e2-standard-4",
            NoExternalIp = false,
        },
        NetworkConfig = new Gcp.CloudBuild.Inputs.WorkerPoolNetworkConfigArgs
        {
            PeeredNetwork = network.Id,
            PeeredNetworkIpRange = "/29",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            workerPoolConn,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/cloudbuild"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/servicenetworking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		servicenetworking2, err := projects.NewService(ctx, "servicenetworking", &projects.ServiceArgs{
			Service: pulumi.String("servicenetworking.googleapis.com"),
		})
		if err != nil {
			return err
		}
		network, err := compute.NewNetwork(ctx, "network", &compute.NetworkArgs{
			Name:                  pulumi.String("my-network"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		}, pulumi.DependsOn([]pulumi.Resource{
			servicenetworking2,
		}))
		if err != nil {
			return err
		}
		workerRange, err := compute.NewGlobalAddress(ctx, "worker_range", &compute.GlobalAddressArgs{
			Name:         pulumi.String("worker-pool-range"),
			Purpose:      pulumi.String("VPC_PEERING"),
			AddressType:  pulumi.String("INTERNAL"),
			PrefixLength: pulumi.Int(16),
			Network:      network.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		workerPoolConn, err := servicenetworking.NewConnection(ctx, "worker_pool_conn", &servicenetworking.ConnectionArgs{
			Network: network.ID().ToIDOutput().ToStringOutput(),
			Service: pulumi.String("servicenetworking.googleapis.com"),
			ReservedPeeringRanges: pulumi.StringArray{
				workerRange.Name,
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			servicenetworking2,
		}))
		if err != nil {
			return err
		}
		_, err = cloudbuild.NewWorkerPool(ctx, "pool", &cloudbuild.WorkerPoolArgs{
			Name:     pulumi.String("my-pool"),
			Location: pulumi.String("europe-west1"),
			WorkerConfig: &cloudbuild.WorkerPoolWorkerConfigArgs{
				DiskSizeGb:   pulumi.Int(100),
				MachineType:  pulumi.String("e2-standard-4"),
				NoExternalIp: pulumi.Bool(false),
			},
			NetworkConfig: &cloudbuild.WorkerPoolNetworkConfigArgs{
				PeeredNetwork:        network.ID().ToIDOutput().ToStringOutput(),
				PeeredNetworkIpRange: pulumi.String("/29"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			workerPoolConn,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_projects_service" "servicenetworking" {
  service = "servicenetworking.googleapis.com"
}
resource "gcp_compute_network" "network" {
  depends_on              = [gcp_projects_service.servicenetworking]
  name                    = "my-network"
  auto_create_subnetworks = false
}
resource "gcp_compute_globaladdress" "worker_range" {
  name          = "worker-pool-range"
  purpose       = "VPC_PEERING"
  address_type  = "INTERNAL"
  prefix_length = 16
  network       = gcp_compute_network.network.id
}
resource "gcp_servicenetworking_connection" "worker_pool_conn" {
  depends_on              = [gcp_projects_service.servicenetworking]
  network                 = gcp_compute_network.network.id
  service                 = "servicenetworking.googleapis.com"
  reserved_peering_ranges = [gcp_compute_globaladdress.worker_range.name]
}
resource "gcp_cloudbuild_workerpool" "pool" {
  depends_on = [gcp_servicenetworking_connection.worker_pool_conn]
  name       = "my-pool"
  location   = "europe-west1"
  worker_config = {
    disk_size_gb   = 100
    machine_type   = "e2-standard-4"
    no_external_ip = false
  }
  network_config = {
    peered_network          = gcp_compute_network.network.id
    peered_network_ip_range = "/29"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.cloudbuild.WorkerPool;
import com.pulumi.gcp.cloudbuild.WorkerPoolArgs;
import com.pulumi.gcp.cloudbuild.inputs.WorkerPoolWorkerConfigArgs;
import com.pulumi.gcp.cloudbuild.inputs.WorkerPoolNetworkConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var servicenetworking = new Service("servicenetworking", ServiceArgs.builder()
            .service("servicenetworking.googleapis.com")
            .build());

        var network = new Network("network", NetworkArgs.builder()
            .name("my-network")
            .autoCreateSubnetworks(false)
            .build(), CustomResourceOptions.builder()
                .dependsOn(servicenetworking)
                .build());

        var workerRange = new GlobalAddress("workerRange", GlobalAddressArgs.builder()
            .name("worker-pool-range")
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(16)
            .network(network.id())
            .build());

        var workerPoolConn = new Connection("workerPoolConn", ConnectionArgs.builder()
            .network(network.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(workerRange.name())
            .build(), CustomResourceOptions.builder()
                .dependsOn(servicenetworking)
                .build());

        var pool = new WorkerPool("pool", WorkerPoolArgs.builder()
            .name("my-pool")
            .location("europe-west1")
            .workerConfig(WorkerPoolWorkerConfigArgs.builder()
                .diskSizeGb(100)
                .machineType("e2-standard-4")
                .noExternalIp(false)
                .build())
            .networkConfig(WorkerPoolNetworkConfigArgs.builder()
                .peeredNetwork(network.id())
                .peeredNetworkIpRange("/29")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(workerPoolConn)
                .build());

    }
}

resources:
  servicenetworking:
    type: gcp:projects:Service
    properties:
      service: servicenetworking.googleapis.com
  network:
    type: gcp:compute:Network
    properties:
      name: my-network
      autoCreateSubnetworks: false
    options:
      dependsOn:
        - ${servicenetworking}
  workerRange:
    type: gcp:compute:GlobalAddress
    name: worker_range
    properties:
      name: worker-pool-range
      purpose: VPC_PEERING
      addressType: INTERNAL
      prefixLength: 16
      network: ${network.id}
  workerPoolConn:
    type: gcp:servicenetworking:Connection
    name: worker_pool_conn
    properties:
      network: ${network.id}
      service: servicenetworking.googleapis.com
      reservedPeeringRanges:
        - ${workerRange.name}
    options:
      dependsOn:
        - ${servicenetworking}
  pool:
    type: gcp:cloudbuild:WorkerPool
    properties:
      name: my-pool
      location: europe-west1
      workerConfig:
        diskSizeGb: 100
        machineType: e2-standard-4
        noExternalIp: false
      networkConfig:
        peeredNetwork: ${network.id}
        peeredNetworkIpRange: /29
    options:
      dependsOn:
        - ${workerPoolConn}

Import

WorkerPool can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/workerPools/{{name}}
• {{project}}/{{location}}/{{name}}
• {{location}}/{{name}}

When using the pulumi import command, WorkerPool can be imported using one of the formats above. For example:

$ pulumi import gcp:cloudbuild/workerPool:WorkerPool default projects/{{project}}/locations/{{location}}/workerPools/{{name}}
$ pulumi import gcp:cloudbuild/workerPool:WorkerPool default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:cloudbuild/workerPool:WorkerPool default {{location}}/{{name}}

Constructors

WorkerPool(String name, {WorkerPoolArgs? args, CustomResourceOptions? options})

Creates a new WorkerPool. name The Pulumi resource name. args Arguments used to configure this WorkerPool. The set of arguments for WorkerPool. options Resource options controlling this resource's behavior.

WorkerPool.reference(String urn)

Creates a typed reference to an existing WorkerPool resource.

Properties

annotations ↔ Output<Map<String, String>?>

User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

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

late, final

deleteTime ↔ Output<String>

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

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

displayName ↔ Output<String?>

A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.

late, final

effectiveAnnotations ↔ Output<Map<String, String>>

All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

The location for the resource

late, final

name ↔ Output<String>

User-defined name of the WorkerPool.

late, final

networkConfig ↔ Output<WorkerPoolNetworkConfig?>

Network configuration for the WorkerPool. Structure is documented below.

late, final

privateServiceConnect ↔ Output<WorkerPoolPrivateServiceConnect?>

Private Service Connect configuration for the pool.

late, final

project ↔ Output<String>

The project for the resource

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

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

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

Output only. A unique identifier for the WorkerPool.

late, final

updateTime ↔ Output<String>

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

late, final

urn ↔ Output<String>

late, final, inherited

workerConfig ↔ Output<WorkerPoolWorkerConfig>

Configuration to be used for a creating workers in the WorkerPool. Structure is documented below.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {WorkerPoolState? state, CustomResourceOptions? options}) → WorkerPool

Gets an existing WorkerPool resource's state with the given name and id.