.TH "GCLOUD_ALPHA_BUILDS_WORKER\-POOLS_CREATE" 1



.SH "NAME"
.HP
gcloud alpha builds worker\-pools create \- create a private pool for use by Cloud Build



.SH "SYNOPSIS"
.HP
\f5gcloud alpha builds worker\-pools create\fR \fIWORKER_POOL\fR [\fB\-\-generation\fR=\fIGENERATION\fR;\ default=1] [\fB\-\-region\fR=\fIREGION\fR] [\fB\-\-config\-from\-file\fR=\fICONFIG_FROM_FILE\fR\ |\ \fB\-\-disable\-public\-ip\-address\fR\ \fB\-\-network\-attachment\fR=\fINETWORK_ATTACHMENT\fR\ \fB\-\-route\-all\-traffic\fR\ |\ \fB\-\-peered\-network\fR=\fIPEERED_NETWORK\fR\ \fB\-\-peered\-network\-ip\-range\fR=\fIPEERED_NETWORK_IP_RANGE\fR\ \fB\-\-no\-public\-egress\fR\ \fB\-\-worker\-disk\-size\fR=\fIWORKER_DISK_SIZE\fR\ \fB\-\-worker\-machine\-type\fR=\fIWORKER_MACHINE_TYPE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Create a private pool for use by Cloud Build.



.SH "EXAMPLES"

.RS 2m
.IP "\(bu" 2m
Private pools
.RE
.sp

To create a private pool named \f5pwp1\fR in region \f5us\-central1\fR, run:

.RS 2m
$ gcloud alpha builds worker\-pools create pwp1 \-\-region=us\-central1
.RE

To create a private pool in project \f5p1\fR in region \f5us\-central1\fR where
workers are of machine type \f5e2\-standard\-2\fR and are peered to the VPC
network \f5projects/123/global/networks/default\fR within the IP range
\f5192.168.0.0/28\fR and have a disk size of 64GB, run:

.RS 2m
$ gcloud alpha builds worker\-pools create pwp1 \-\-project=p1 \e
    \-\-region=us\-central1 \e
    \-\-peered\-network=projects/123/global/networks/default \e
    \-\-peered\-network\-ip\-range=192.168.0.0/28 \e
    \-\-worker\-machine\-type=e2\-standard\-2 \-\-worker\-disk\-size=64GB
.RE

To create a private pool in project \f5p1\fR in region \f5us\-central1\fR where
workers are of machine type \f5e2\-standard\-2\fR and are peered to the network
attachment \f5projects/p1/regions/us\-central1/networkAttachments/na\fR. The
workers don't have public IP address and all the traffic is routed to the
network attachment.

.RS 2m
$ gcloud alpha builds worker\-pools create pwp1 \-\-project=p1 \e
    \-\-region=us\-central1 \e
    \-\-network\-attachment=projects/p1/regions/us\-central1/\e
networkAttachments/na \-\-route\-all\-traffic \e
    \-\-disable\-public\-ip\-address \-\-worker\-machine\-type=e2\-standard\-2
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIWORKER_POOL\fR

Unique identifier for the worker pool to create. This value should be 1\-63
characters, and valid characters are [a\-z][0\-9]\-


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-generation\fR=\fIGENERATION\fR; default=1

Generation of the worker pool.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

Cloud region where the worker pool is created. See
https://cloud.google.com/build/docs/locations for available locations.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-config\-from\-file\fR=\fICONFIG_FROM_FILE\fR

File that contains the configuration for the worker pool to be created.

Private pool options:

.RS 2m
https://cloud.google.com/build/docs/private\-pools/worker\-pool\-config\-file\-schema
.RE

.TP 2m

Command\-line flags to configure the private pool:


.RS 2m
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m

Network configuration for Private Service Connect interface:


.RS 2m
.TP 2m
\fB\-\-disable\-public\-ip\-address\fR

If set, workers in the worker pool are created without an external IP address.

If the worker pool is within a VPC Service Control perimeter, use this flag.

.TP 2m
\fB\-\-network\-attachment\fR=\fINETWORK_ATTACHMENT\fR

The network attachment that the worker network interface is peered to. The
network attachment is specified in resource URL format
projects/{project}/regions/{region}/networkAttachments/{name}. The region of
network attachment must be the same as the worker pool. See
https://cloud.google.com/vpc/docs/about\-network\-attachments for details.

.TP 2m
\fB\-\-route\-all\-traffic\fR

Route all traffic through PSC interface. Enable this if you want full control of
traffic in the private pool. Configure Cloud NAT for the subnet of network
attachment if you need to access public Internet.

If unset, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and
192.168.0.0/16 through PSC interface.

.RE
.sp
.TP 2m

Network configuration for Service Networking:


.RS 2m
.TP 2m
\fB\-\-peered\-network\fR=\fIPEERED_NETWORK\fR

Existing network to which workers are peered. The network is specified in
resource URL format projects/{network_project}/global/networks/{network_name}.

If not specified, the workers are not peered to any network.

.TP 2m
\fB\-\-peered\-network\-ip\-range\fR=\fIPEERED_NETWORK_IP_RANGE\fR

An IP range for your peered network. Specify the IP range using Classless
Inter\-Domain Routing (CIDR) notation with a slash and the subnet prefix size,
such as \f5/29\fR.

Your subnet prefix size must be between 1 and 29. Optional: you can specify an
IP address before the subnet prefix value \- for example \f5192.168.0.0/24\fR.

If no IP address is specified, your VPC automatically determines the starting IP
for the range. If no IP range is specified, Cloud Build uses \f5/24\fR as the
default network IP range.

.TP 2m
\fB\-\-no\-public\-egress\fR

If set, workers in the worker pool are created without an external IP address.

If the worker pool is within a VPC Service Control perimeter, use this flag.

.RE
.RE
.sp
.TP 2m

Configuration to be used for creating workers in the worker pool:


.RS 2m
.TP 2m
\fB\-\-worker\-disk\-size\fR=\fIWORKER_DISK_SIZE\fR

Size of the disk attached to the worker.

If unspecified, Cloud Build uses a standard disk size.

.TP 2m
\fB\-\-worker\-machine\-type\fR=\fIWORKER_MACHINE_TYPE\fR

Compute Engine machine type for a worker pool.

If unspecified, Cloud Build uses a standard machine type.


.RE
.RE
.RE
.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud builds worker\-pools create
.RE

.RS 2m
$ gcloud beta builds worker\-pools create
.RE